ModelHandler Class Reference

#include <ModelHandler.h>

Inheritance diagram for ModelHandler:

Public Member Functions
	ModelHandler (CXMLParser &parser, CXMLParserData &data)
virtual	~ModelHandler ()
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
	ModelHandler ()

Private Attributes
std::string	mActiveSet
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

ModelHandler() [1/2]

ModelHandler::ModelHandler ( )

private

ModelHandler() [2/2]

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

Constructor

Parameters

CXMLParser	& parser
CXMLParserData	& data

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

References CXMLHandler::init().

~ModelHandler()

ModelHandler::~ModelHandler ( )

virtual

Destructor

Member Function Documentation

getProcessLogic()

CXMLHandler::sProcessLogic * ModelHandler::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::HANDLER_COUNT, CXMLHandler::InitialExpression, CXMLHandler::InitialState, CXMLHandler::ListOfCompartments, CXMLHandler::ListOfEvents, CXMLHandler::ListOfMetabolites, CXMLHandler::ListOfModelParameterSets, CXMLHandler::ListOfModelValues, CXMLHandler::ListOfReactions, CXMLHandler::ListOfUnsupportedAnnotations, CXMLHandler::MiriamAnnotation, CXMLHandler::Model, and CXMLHandler::StateTemplate.

processEnd()

bool ModelHandler::processEnd ( const XML_Char *  pszName )

protectedvirtual

Process the end of an element

Parameters

const

XML_Char *pszName

Returns

bool finished

Implements CXMLHandler.

References CModelParameterSet::assignSetContent(), CXMLParserData::CharacterData, CXMLHandler::Comment, CCopasiMessage::EXCEPTION, CKeyFactory::get(), CModel::getActiveModelParameterSet(), CExpatTemplate< CType >::getCurrentColumnNumber(), CExpatTemplate< CType >::getCurrentLineNumber(), CModel::getKey(), CCopasiMessage::getLastMessage(), CAnnotation::getUnsupportedAnnotations(), CXMLHandler::InitialExpression, CXMLHandler::InitialState, CXMLHandler::ListOfCompartments, CXMLHandler::ListOfEvents, CXMLHandler::ListOfMetabolites, CXMLHandler::ListOfModelParameterSets, CXMLHandler::ListOfModelValues, CXMLHandler::ListOfReactions, CXMLHandler::ListOfUnsupportedAnnotations, mActiveSet, CXMLHandler::mCurrentElement, MCXML, CXMLHandler::MiriamAnnotation, mKey, CXMLParserData::mKeyMap, CXMLHandler::Model, CXMLHandler::mpData, CXMLHandler::mpParser, CXMLParserData::mUnsupportedAnnotations, CXMLParserData::pModel, CModel::setCompileFlag(), CModelEntity::setInitialExpression(), CAnnotation::setMiriamAnnotation(), CAnnotation::setNotes(), CCopasiMessage::size(), and CXMLHandler::StateTemplate.

processStart()

CXMLHandler * ModelHandler::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 CXMLHandler::addFix(), CUnit::Avogadro, C_FLOAT64, CDataVector< CType >::clear(), CXMLHandler::Comment, CModel::deterministic, CCopasiMessage::EXCEPTION, CExpatTemplate< CType >::getAttributeValue(), CExpatTemplate< CType >::getCurrentColumnNumber(), CExpatTemplate< CType >::getCurrentLineNumber(), CXMLHandler::getHandler(), CCopasiMessage::getLastMessage(), CModel::getModelParameterSets(), CXMLHandler::InitialExpression, CXMLHandler::InitialState, CXMLHandler::ListOfCompartments, CXMLHandler::ListOfEvents, CXMLHandler::ListOfMetabolites, CXMLHandler::ListOfModelParameterSets, CXMLHandler::ListOfModelValues, CXMLHandler::ListOfReactions, CXMLHandler::ListOfUnsupportedAnnotations, mActiveSet, CXMLHandler::mCurrentElement, MCXML, CXMLHandler::MiriamAnnotation, mKey, CXMLHandler::Model, CModel::ModelTypeNames, CXMLHandler::mpData, CXMLHandler::mpParser, CXMLParserData::mUnsupportedAnnotations, CCore::ParticleNumbers, CXMLParserData::pDataModel, CXMLParserData::pModel, CModel::setAreaUnit(), CModel::setAvogadro(), CModel::setLengthUnit(), CModel::setModelType(), CDataObject::setObjectName(), CModel::setQuantityUnit(), CModel::setTimeUnit(), CModel::setVolumeUnit(), CCopasiMessage::size(), CXMLHandler::StateTemplate, and CEnumAnnotation< Type, Enum >::toEnum().

Member Data Documentation

mActiveSet

std::string ModelHandler::mActiveSet

private

The key of the active parameter set

Referenced by processEnd(), and processStart().

mKey

std::string ModelHandler::mKey

private

The original key of the model.

Referenced by processEnd(), and processStart().

---

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

• ModelHandler.h
• ModelHandler.cpp