COPASI API  4.40.278
MiriamAnnotationHandler Class Reference

#include <MiriamAnnotationHandler.h>

Inheritance diagram for MiriamAnnotationHandler:
[legend]

Public Member Functions

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

Protected Member Functions

virtual sProcessLogicgetProcessLogic () const
 
virtual bool processEnd (const XML_Char *pszName)
 
virtual CXMLHandlerprocessStart (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
 
CXMLHandlergetHandler (const Type &type)
 
void init ()
 

Private Member Functions

 MiriamAnnotationHandler ()
 

Private Attributes

std::stack< bool > mElementEmpty
 
std::ostringstream mRDF
 

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, TypemCurrentElement
 
std::map< std::string, std::pair< Type, Type > > mElementName2Type
 
Type mElementType
 
const Type mHandlerType
 
std::pair< Type, TypemLastKnownElement
 
size_t mLevel
 
CXMLParserDatampData
 
CXMLParsermpParser
 
std::map< Type, std::set< Type > > mValidElements
 

Constructor & Destructor Documentation

◆ MiriamAnnotationHandler() [1/2]

MiriamAnnotationHandler::MiriamAnnotationHandler ( )
private

◆ MiriamAnnotationHandler() [2/2]

MiriamAnnotationHandler::MiriamAnnotationHandler ( CXMLParser parser,
CXMLParserData data 
)

Constructor

Parameters
CXMLParser& parser
CXMLParserData& data

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

References CXMLHandler::init().

◆ ~MiriamAnnotationHandler()

MiriamAnnotationHandler::~MiriamAnnotationHandler ( )
virtual

Destructor

Member Function Documentation

◆ end()

void MiriamAnnotationHandler::end ( const XML_Char *  pszName)
virtual

End element handler

Parameters
constXML_Char *pszName

Reimplemented from CXMLHandler.

References CXMLHandler::mLevel, CXMLHandler::mpParser, CXMLParser::onEndElement(), CXMLParser::popElementHandler(), and processEnd().

◆ getProcessLogic()

CXMLHandler::sProcessLogic * MiriamAnnotationHandler::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, and CXMLHandler::MiriamAnnotation.

◆ processEnd()

bool MiriamAnnotationHandler::processEnd ( const XML_Char *  pszName)
protectedvirtual

◆ processStart()

CXMLHandler * MiriamAnnotationHandler::processStart ( const XML_Char *  pszName,
const XML_Char **  papszAttrs 
)
protectedvirtual

Process the start of an element

Parameters
constXML_Char *pszName
constXML_Char **papszAttrs
Returns
CXMLHandler * pHandlerToCall

Implements CXMLHandler.

References CCopasiXMLInterface::attribute, CXMLParser::enableCharacterDataHandler(), CCopasiXMLInterface::encode(), CXMLParser::getCharacterData(), mElementEmpty, CXMLHandler::mLevel, CXMLHandler::mpParser, and mRDF.

Referenced by start().

◆ start()

void MiriamAnnotationHandler::start ( const XML_Char *  pszName,
const XML_Char **  papszAttrs 
)
virtual

Start element handler

Parameters
constXML_Char *pszName
constXML_Char **papszAttrs

Reimplemented from CXMLHandler.

References CXMLHandler::mLevel, and processStart().

Member Data Documentation

◆ mElementEmpty

std::stack< bool > MiriamAnnotationHandler::mElementEmpty
private

Information whether an element is empty

Referenced by processEnd(), and processStart().

◆ mRDF

std::ostringstream MiriamAnnotationHandler::mRDF
private

String stream to handle RDF contents

Referenced by processEnd(), and processStart().


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