FunctionHandler Class Reference

#include <FunctionHandler.h>

Inheritance diagram for FunctionHandler:

Public Member Functions
	FunctionHandler (CXMLParser &parser, CXMLParserData &data)
virtual	~FunctionHandler ()
Public Member Functions inherited from CXMLHandler
	CXMLHandler (CXMLParser &parser, CXMLParserData &data, const Type &type)
virtual void	end (const XML_Char *pszName)
virtual void	start (const XML_Char *pszName, const XML_Char **papszAttrs)
virtual	~CXMLHandler ()

Protected Member Functions
virtual sProcessLogic *	getProcessLogic () const
virtual bool	processEnd (const XML_Char *pszName)
virtual CXMLHandler *	processStart (const XML_Char *pszName, const XML_Char **papszAttrs)
Protected Member Functions inherited from CXMLHandler
void	addFix (const std::string &key, CDataObject *pObject)
std::string	getElementName (const Type &type) const
std::string	getExpectedElements (const Type &type) const
CXMLHandler *	getHandler (const Type &type)
void	init ()

Private Member Functions
	FunctionHandler ()

Private Attributes
std::set< size_t >	mExistingFunctionIndex
std::string	mInfix
std::string	mKey

Additional Inherited Members
Public Types inherited from CXMLHandler
enum	Type {   BEFORE = 0 , AFTER , UNKNOWN , AdditionalGraphicalObject ,   Assignment , BasePoint1 , BasePoint2 , Body ,   BoundingBox , CallParameter , ChannelSpec , CharacterData ,   ColorDefinition , Comment , Compartment , CompartmentGlyph ,   Constant , COPASI , CubicBezier , Curve ,   CurveSegment , DelayExpression , Dimensions , Ellipse ,   End , Event , Expression , Footer ,   Function , GradientStop , Group , GUI ,   Header , Image , InitialExpression , InitialState ,   KineticLaw , Layout , LinearGradient , LineEnding ,   LineSegment , ListOfAdditionalGraphicalObjects , ListOfAssignments , ListOfCallParameters ,   ListOfChannels , ListOfColorDefinitions , ListOfCompartmentGlyphs , ListOfCompartments ,   ListOfConstants , ListOfCurveSegments , ListOfElements , ListOfEvents ,   ListOfFunctions , ListOfGlobalRenderInformation , ListOfGradientDefinitions , ListOfLayouts ,   ListOfLineEndings , ListOfMetabGlyphs , ListOfMetaboliteReferenceGlyphs , ListOfMetabolites ,   ListOfModelParameterSets , ListOfModelValues , ListOfModifiers , ListOfParameterDescriptions ,   ListOfPlotItems , ListOfPlots , ListOfProducts , ListOfReactionGlyphs ,   ListOfReactions , ListOfRenderInformation , ListOfReports , ListOfSliders ,   ListOfStyles , ListOfSubstrates , ListOfTasks , ListOfTextGlyphs ,   ListOfUnitDefinitions , ListOfUnsupportedAnnotations , MathML , Metabolite ,   MetaboliteGlyph , MetaboliteReferenceGlyph , Method , MiriamAnnotation ,   Model , ModelParameter , ModelParameterGroup , ModelParameterSet ,   ModelValue , Modifier , NoiseExpression , Object ,   Parameter , ParameterDescription , ParameterGroup , ParameterText ,   PlotItem , PlotSpecification , Point , Polygon ,   Position , PriorityExpression , Problem , Product ,   RadialGradient , Reaction , ReactionGlyph , Rectangle ,   RenderCurve , RenderCurveElement , RenderInformation , RenderText ,   ReportDefinition , ReportSection , ReportTarget , SBMLMap ,   SBMLReference , Slider , SourceParameter , Start ,   StateTemplate , StateTemplateVariable , Style , Substrate ,   Table , Task , Text , TextGlyph ,   TriggerExpression , Unit , UnitDefinition , UnsupportedAnnotation ,   HANDLER_COUNT }
Protected Attributes inherited from CXMLHandler
std::pair< Type, Type >	mCurrentElement
std::map< std::string, std::pair< Type, Type > >	mElementName2Type
Type	mElementType
const Type	mHandlerType
std::pair< Type, Type >	mLastKnownElement
size_t	mLevel
CXMLParserData *	mpData
CXMLParser *	mpParser
std::map< Type, std::set< Type > >	mValidElements

Constructor & Destructor Documentation

FunctionHandler() [1/2]

FunctionHandler::FunctionHandler ( )

private

FunctionHandler() [2/2]

FunctionHandler::FunctionHandler	(	CXMLParser &	parser,
		CXMLParserData &	data
	)

Constructor

Parameters

CXMLParser	& parser
CXMLParserData	& data

Replace Function with the name type of the handler and implement the three methods below.

References CXMLHandler::init().

~FunctionHandler()

FunctionHandler::~FunctionHandler ( )

virtual

Destructor

Member Function Documentation

getProcessLogic()

CXMLHandler::sProcessLogic * FunctionHandler::getProcessLogic ( ) const

protectedvirtual

Retrieve the structure containing the process logic for the handler.

Returns

sElementInfo *

Implements CXMLHandler.

References CXMLHandler::AFTER, CXMLHandler::BEFORE, CXMLHandler::CharacterData, CXMLHandler::Comment, CXMLHandler::Expression, CXMLHandler::Function, CXMLHandler::HANDLER_COUNT, CXMLHandler::ListOfParameterDescriptions, CXMLHandler::ListOfUnsupportedAnnotations, CXMLHandler::MathML, CXMLHandler::MiriamAnnotation, and CXMLHandler::Text.

processEnd()

bool FunctionHandler::processEnd ( const XML_Char *  pszName )

protectedvirtual

Process the end of an element

Parameters

const

XML_Char *pszName

Returns

bool finished

Implements CXMLHandler.

References CDataVectorN< CType >::add(), CXMLHandler::addFix(), C_INVALID_INDEX, CXMLParserData::CharacterData, CXMLHandler::Comment, CXMLHandler::end(), CCopasiMessage::EXCEPTION, CXMLHandler::Expression, CXMLHandler::Function, CExpatTemplate< CType >::getCurrentColumnNumber(), CExpatTemplate< CType >::getCurrentLineNumber(), CFunction::getKey(), CCopasiMessage::getLastMessage(), CDataObject::getObjectName(), CAnnotation::getUnsupportedAnnotations(), CFunction::getVariables(), CXMLHandler::ListOfParameterDescriptions, CXMLHandler::ListOfUnsupportedAnnotations, CXMLHandler::MathML, CXMLHandler::mCurrentElement, MCXML, mExistingFunctionIndex, CXMLParserData::mFunctionParameterKeyMap, mInfix, CXMLHandler::MiriamAnnotation, mKey, CXMLHandler::mpData, CXMLParserData::mpExpression, CXMLHandler::mpParser, CXMLParserData::mPredefinedFunction, CXMLParserData::mUnsupportedAnnotations, pdelete, CXMLParserData::pFunction, CXMLParserData::pFunctionList, CFunctionParameters::remove(), CFunction::setInfix(), CExpression::setInfix(), CAnnotation::setMiriamAnnotation(), CAnnotation::setNotes(), CCopasiMessage::size(), CFunctionParameters::size(), CFunctionParameter::TEMPORARY, and CXMLHandler::Text.

processStart()

CXMLHandler * FunctionHandler::processStart ( const XML_Char *  pszName, const XML_Char **  papszAttrs  )

protectedvirtual

Process the start of an element

Parameters

const	XML_Char *pszName
const	XML_Char **papszAttrs

Returns

CXMLHandler * pHandlerToCall

Implements CXMLHandler.

References C_INVALID_INDEX, CXMLHandler::Comment, CEvaluationTree::create(), CCopasiMessage::EXCEPTION, CEvaluationTree::Expression, CXMLHandler::Expression, CEvaluationTree::Function, CXMLHandler::Function, CExpatTemplate< CType >::getAttributeValue(), CExpatTemplate< CType >::getCurrentColumnNumber(), CExpatTemplate< CType >::getCurrentLineNumber(), CXMLHandler::getHandler(), CDataVectorN< CType >::getIndex(), CXMLHandler::ListOfParameterDescriptions, CXMLHandler::ListOfUnsupportedAnnotations, CEvaluationTree::MassAction, CXMLHandler::MathML, CXMLHandler::mCurrentElement, MCXML, mExistingFunctionIndex, CXMLParserData::mFunctionParameterKeyMap, CXMLHandler::MiriamAnnotation, mKey, CXMLParserData::mKey2ObjectiveFunction, CXMLHandler::mpData, CXMLParserData::mpExpression, CXMLHandler::mpParser, CXMLParserData::mPredefinedFunction, CXMLParserData::mUnsupportedAnnotations, pdelete, CXMLParserData::pFunction, CXMLParserData::pFunctionList, CEvaluationTree::PreDefined, CDataObject::setObjectName(), CFunction::setReversible(), CXMLHandler::Text, toEnum(), TriFalse, TriTrue, TriUnspecified, CEvaluationTree::UserDefined, and CEvaluationTree::XMLType.

Member Data Documentation

mExistingFunctionIndex

std::set< size_t > FunctionHandler::mExistingFunctionIndex

private

The index of a function with the same name

Referenced by processEnd(), and processStart().

mInfix

std::string FunctionHandler::mInfix

private

The infix expression of the function

Referenced by processEnd().

mKey

std::string FunctionHandler::mKey

private

The key in the CopasiML file

Referenced by processEnd(), and processStart().

---

The documentation for this class was generated from the following files:

• FunctionHandler.h
• FunctionHandler.cpp