ParameterGroupHandler Class Reference

#include <ParameterGroupHandler.h>

Inheritance diagram for ParameterGroupHandler:

Public Member Functions
	ParameterGroupHandler (CXMLParser &parser, CXMLParserData &data)
void	setDerivedElement (const XML_Char *pszName, CCopasiParameterGroup *pDerivedElement)
virtual	~ParameterGroupHandler ()
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
bool	isUniqueParameter () const
	ParameterGroupHandler ()

Private Attributes
std::string	mDerivedElement
std::map< std::string, std::set< std::string > >	mNonUniqueParameters
std::stack< CCopasiParameterGroup * >	mParameterGroupStack

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

ParameterGroupHandler() [1/2]

ParameterGroupHandler::ParameterGroupHandler ( )

private

ParameterGroupHandler() [2/2]

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

Constructor

Parameters

CXMLParser	& parser
CXMLParserData	& data

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

References CXMLHandler::init(), and mNonUniqueParameters.

~ParameterGroupHandler()

ParameterGroupHandler::~ParameterGroupHandler ( )

virtual

Destructor

Member Function Documentation

getProcessLogic()

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

protectedvirtual

Retrieve the structure containing the process logic for the handler.

Returns

sElementInfo *

Implements CXMLHandler.

References CXMLHandler::AFTER, CXMLHandler::BEFORE, CXMLHandler::HANDLER_COUNT, CXMLHandler::Parameter, CXMLHandler::ParameterGroup, and CXMLHandler::ParameterText.

isUniqueParameter()

bool ParameterGroupHandler::isUniqueParameter ( ) const

private

References CDataObject::getObjectName(), mNonUniqueParameters, mParameterGroupStack, CXMLHandler::mpData, and CXMLParserData::pCurrentParameter.

Referenced by processEnd().

processEnd()

bool ParameterGroupHandler::processEnd ( const XML_Char *  pszName )

protectedvirtual

Process the end of an element

Parameters

const

XML_Char *pszName

Returns

bool finished

Implements CXMLHandler.

References CCopasiMessage::EXCEPTION, CExpatTemplate< CType >::getCurrentColumnNumber(), CExpatTemplate< CType >::getCurrentLineNumber(), CCopasiParameter::getKey(), CDataObject::getObjectName(), CCopasiParameter::getType(), CCopasiTask::getType(), isUniqueParameter(), CCopasiParameter::KEY, CXMLHandler::mCurrentElement, MCXML, mDerivedElement, CXMLHandler::mElementName2Type, CXMLHandler::mLevel, mParameterGroupStack, CXMLHandler::mpData, CXMLHandler::mpParser, CXMLHandler::Parameter, CTaskEnum::parameterFitting, CXMLHandler::ParameterGroup, CXMLHandler::ParameterText, CXMLParserData::pCurrentParameter, CXMLParserData::pCurrentTask, pdelete, and CXMLParserData::UnmappedKeyParameters.

processStart()

CXMLHandler * ParameterGroupHandler::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 CCopasiMessage::EXCEPTION, CExpatTemplate< CType >::getAttributeValue(), CExpatTemplate< CType >::getCurrentColumnNumber(), CExpatTemplate< CType >::getCurrentLineNumber(), CXMLHandler::getHandler(), CXMLHandler::mCurrentElement, MCXML, CXMLHandler::mLevel, mParameterGroupStack, CXMLHandler::mpParser, CXMLHandler::Parameter, CXMLHandler::ParameterGroup, and CXMLHandler::ParameterText.

setDerivedElement()

void ParameterGroupHandler::setDerivedElement	(	const XML_Char *	pszName,
		CCopasiParameterGroup *	pDerivedElement
	)

Set the derived element for which the handler is called such as methods and problems

Parameters

const	XML_Char * pszName,
CCopasiParameterGroup	* pDerivedElement

References mDerivedElement, CXMLHandler::mElementName2Type, CXMLHandler::mLevel, mParameterGroupStack, and CXMLHandler::ParameterGroup.

Member Data Documentation

mDerivedElement

std::string ParameterGroupHandler::mDerivedElement

private

A flag indicating whether the current element is derived from a parameter group.

Referenced by processEnd(), and setDerivedElement().

mNonUniqueParameters

std::map< std::string, std::set< std::string > > ParameterGroupHandler::mNonUniqueParameters

private

A map listing parameters for which the uniqueness is not enforced

Referenced by isUniqueParameter(), and ParameterGroupHandler().

mParameterGroupStack

std::stack< CCopasiParameterGroup * > ParameterGroupHandler::mParameterGroupStack

private

A stack of groups which contains the hierarchy of currently processed groups.

Referenced by isUniqueParameter(), processEnd(), processStart(), and setDerivedElement().

---

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

• ParameterGroupHandler.h
• ParameterGroupHandler.cpp