@sbmlbrief{combine} TODO:Definition of the CaOmexManifest class. More...

#include <CaOmexManifest.h>

Inheritance diagram for CaOmexManifest:

Public Member Functions
	CaOmexManifest ()
	Creates a new CaOmexManifest instance. More...

	CaOmexManifest (CaNamespaces *omexns)
	Creates a new CaOmexManifest using the given CaNamespaces object `omexns`. More...

	CaOmexManifest (const CaOmexManifest &orig)
	Copy constructor for CaOmexManifest. More...

CaOmexManifest &	operator= (const CaOmexManifest &rhs)
	Assignment operator for CaOmexManifest. More...

virtual CaOmexManifest *	clone () const
	Creates and returns a deep copy of this CaOmexManifest object. More...

virtual	~CaOmexManifest ()
	Destructor for CaOmexManifest. More...

const CaListOfContents *	getListOfContents () const
	Returns the CaListOfContents from this CaOmexManifest. More...

CaListOfContents *	getListOfContents ()
	Returns the CaListOfContents from this CaOmexManifest. More...

CaContent *	getContent (unsigned int n)
	Get a CaContent from the CaOmexManifest. More...

const CaContent *	getContent (unsigned int n) const
	Get a CaContent from the CaOmexManifest. More...

int	addContent (const CaContent *cc)
	Adds a copy of the given CaContent to this CaOmexManifest. More...

unsigned int	getNumContents () const
	Get the number of CaContent objects in this CaOmexManifest. More...

CaContent *	createContent ()
	Creates a new CaContent object, adds it to this CaOmexManifest object and returns the CaContent object created. More...

CaContent *	removeContent (unsigned int n)
	Removes the nth CaContent from this CaOmexManifest and returns a pointer to it. More...

virtual const std::string &	getElementName () const
	Returns the XML element name of this CaOmexManifest object. More...

virtual int	getTypeCode () const
	Returns the libCombine type code for this CaOmexManifest object. More...

virtual bool	hasRequiredElements () const
	Predicate returning `true` if all the required elements for this CaOmexManifest object have been set. More...

virtual CaBase *	getElementBySId (const std::string &id)
	Returns the first child element that has the given `id` in the model-wide SId namespace, or `NULL` if no such object is found. More...

virtual const LIBSBML_CPP_NAMESPACE_QUALIFIER XMLNamespaces *	getNamespaces () const
	Returns the value of the "Namespaces" element of this CaOmexManifest. More...

virtual LIBSBML_CPP_NAMESPACE_QUALIFIER XMLNamespaces *	getNamespaces ()
	Returns the value of the "Namespaces" element of this CaOmexManifest. More...

const CaErrorLog *	getErrorLog () const
	Returns the value of the "CaErrorLog" element of this CaOmexManifest. More...

CaErrorLog *	getErrorLog ()
	Returns the value of the "CaErrorLog" element of this CaOmexManifest. More...

CaError *	getError (unsigned int n)
	Get a CaError from the CaDocument. More...

const CaError *	getError (unsigned int n) const
	Get a CaError from the CaDocument. More...

unsigned int	getNumErrors () const
	Get the number of CaError objects in this CaDocument. More...

unsigned int	getNumErrors (unsigned int severity) const
	Get the number of CaError objects in this CaDocument with the given severity. More...

virtual unsigned int	getLevel () const
	return the level of this document More...

virtual unsigned int	getVersion () const
	return the version of this document More...

Public Member Functions inherited from CaBase
virtual	~CaBase ()
	Destroys this object. More...

CaBase &	operator= (const CaBase &rhs)
	Assignment operator for CaBase. More...

virtual CaBase *	clone () const =0
	Creates and returns a deep copy of this CaBase object. More...

virtual CaBase *	getElementBySId (const std::string &id)
	Returns the first child element it can find with a specific "id" attribute value, or `NULL` if no such object is found. More...

virtual const CaBase *	getElementBySId (const std::string &metaid) const
	Returns the first child element it can find with a specific "id" attribute value, or `NULL` if no such object is found. More...

virtual CaBase *	getElementByMetaId (const std::string &metaid)
	Returns the first child element it can find with a specific "metaid" attribute value, or `NULL` if no such object is found. More...

virtual const CaBase *	getElementByMetaId (const std::string &metaid) const
	Returns the first child element it can find with a specific "metaid" attribute value, or `NULL` if no such object is found. More...

virtual List *	getAllElements ()
	Returns a List of all child CaBase objects, including those nested to an arbitrary depth. More...

const std::string &	getMetaId () const
	Returns the value of the "metaid" attribute of this object. More...

std::string &	getMetaId ()
	Returns the value of the "metaid" attribute of this object. More...

virtual const std::string &	getId () const

LIBSBML_CPP_NAMESPACE_QUALIFIER XMLNode *	getNotes ()
	Returns the content of the "notes" subelement of this object as a tree of XMLNode objects. More...

const LIBSBML_CPP_NAMESPACE_QUALIFIER XMLNode *	getNotes () const
	Returns the content of the "notes" subelement of this object as a tree of XMLNode objects. More...

std::string	getNotesString ()
	Returns the content of the "notes" subelement of this object as a string. More...

std::string	getNotesString () const
	Returns the content of the "notes" subelement of this object as a string. More...

LIBSBML_CPP_NAMESPACE_QUALIFIER XMLNode *	getAnnotation ()
	Returns the content of the "annotation" subelement of this object as a tree of XMLNode objects. More...

const LIBSBML_CPP_NAMESPACE_QUALIFIER XMLNode *	getAnnotation () const
	Returns the content of the "annotation" subelement of this object as a tree of XMLNode objects. More...

std::string	getAnnotationString ()
	Returns the content of the "annotation" subelement of this object as a character string. More...

std::string	getAnnotationString () const
	Returns the content of the "annotation" subelement of this object as a character string. More...

virtual const LIBSBML_CPP_NAMESPACE_QUALIFIER XMLNamespaces *	getNamespaces () const
	Returns a list of the XML Namespaces declared on the OMEX document owning this object. More...

virtual LIBSBML_CPP_NAMESPACE_QUALIFIER XMLNamespaces *	getNamespaces ()
	Returns a list of the XML Namespaces declared on the OMEX document owning this object. More...

const CaOmexManifest *	getCaOmexManifest () const
	Returns the CaOmexManifest object containing this object instance. More...

CaOmexManifest *	getCaOmexManifest ()
	Returns the CaOmexManifest object containing this object instance. More...

CaBase *	getParentCaObject ()
	Returns the parent OMEX object containing this object. More...

const CaBase *	getParentCaObject () const
	Returns the parent OMEX object containing this object. More...

CaBase *	getAncestorOfType (int type)
	Returns the first ancestor object that has the given OMEX type code. More...

const CaBase *	getAncestorOfType (int type) const
	Returns the first ancestor object that has the given OMEX type code. More...

unsigned int	getLine () const
	Returns the line number on which this object first appears in the XML representation of the OMEX document, or '0' if the object was created, not read from a file. More...

unsigned int	getColumn () const
	Returns the column number on which this object first appears in the XML representation of the OMEX document, or '0' if the object was created, not read from a file. More...

bool	isSetMetaId () const
	Predicate returning `true` if this object's "metaid" attribute is set. More...

virtual bool	isSetId () const
	Predicate returning `true` if this object's "id" attribute is set. More...

bool	isSetNotes () const
	Predicate returning `true` if this object's "notes" subelement exists and has content. More...

bool	isSetAnnotation () const
	Predicate returning `true` if this object's "annotation" subelement exists and has content. More...

int	setMetaId (const std::string &metaid)
	Sets the value of the meta-identifier attribute of this object. More...

virtual int	setId (const std::string &sid)
	Sets the value of the "id" attribute of this OMEX object. More...

virtual int	setAnnotation (LIBSBML_CPP_NAMESPACE_QUALIFIER XMLNode *annotation)
	Sets the value of the "annotation" subelement of this OMEX object. More...

virtual int	setAnnotation (const std::string &annotation)
	Sets the value of the "annotation" subelement of this OMEX object. More...

virtual int	appendAnnotation (const LIBSBML_CPP_NAMESPACE_QUALIFIER XMLNode *annotation)
	Appends the given `annotation` to the "annotation" subelement of this object. More...

virtual int	appendAnnotation (const std::string &annotation)
	Appends the given `annotation` to the "annotation" subelement of this object. More...

int	removeTopLevelAnnotationElement (const std::string elementName, const std::string elementURI="")
	Removes the top-level element within the "annotation" subelement of this OMEX object with the given name and optional URI. More...

int	replaceTopLevelAnnotationElement (const LIBSBML_CPP_NAMESPACE_QUALIFIER XMLNode *annotation)
	Replaces the given top-level element within the "annotation" subelement of this OMEX object and with the annotation element supplied. More...

int	replaceTopLevelAnnotationElement (const std::string &annotation)
	Replaces the given top-level element within the "annotation" subelement of this OMEX object and with the annotation element supplied. More...

int	setNotes (const LIBSBML_CPP_NAMESPACE_QUALIFIER XMLNode *notes)
	Sets the value of the "notes" subelement of this OMEX object. More...

int	setNotes (const std::string &notes, bool addXHTMLMarkup=false)
	Sets the value of the "notes" subelement of this OMEX object to a copy of the string `notes`. More...

int	appendNotes (const LIBSBML_CPP_NAMESPACE_QUALIFIER XMLNode *notes)
	Appends the given `notes` to the "notes" subelement of this object. More...

int	appendNotes (const std::string &notes)
	Appends the given `notes` to the "notes" subelement of this object. More...

int	setNamespaces (LIBSBML_CPP_NAMESPACE_QUALIFIER XMLNamespaces *xmlns)
	Sets the namespaces relevant of this OMEX object. More...

int	unsetMetaId ()
	Unsets the value of the "metaid" attribute of this OMEX object. More...

virtual int	unsetId ()
	Unsets the value of the "id" attribute of this OMEX object. More...

int	unsetNotes ()
	Unsets the value of the "notes" subelement of this OMEX object. More...

int	unsetAnnotation ()
	Unsets the value of the "annotation" subelement of this OMEX object. More...

unsigned int	getLevel () const
	Returns the OMEX Level of the CaOmexManifest object containing this object. More...

unsigned int	getVersion () const
	Returns the Version within the OMEX Level of the CaOmexManifest object containing this object. More...

virtual int	getTypeCode () const
	Returns the libCombine type code for this object. More...

bool	hasValidLevelVersionNamespaceCombination ()
	Predicate returning `true` if this object's level/version and namespace values correspond to a valid OMEX specification. More...

virtual const std::string &	getElementName () const =0
	Returns the XML element name of this object. More...

char *	toCa ()
	Returns a string consisting of a partial OMEX corresponding to just this object. More...

virtual bool	isSetAttribute (const std::string &attributeName) const

virtual int	removeFromParentAndDelete ()
	Removes this object from its parent. More...

bool	matchesCaNamespaces (const CaBase *sb)
	Returns `true` if this object's set of XML namespaces are the same as the given object's XML namespaces. More...

bool	matchesCaNamespaces (const CaBase *sb) const
	Returns `true` if this object's set of XML namespaces are the same as the given object's XML namespaces. More...

bool	matchesRequiredCaNamespacesForAddition (const CaBase *sb)
	Returns `true` if this object's set of XML namespaces are a subset of the given object's XML namespaces. More...

bool	matchesRequiredCaNamespacesForAddition (const CaBase *sb) const
	Returns `true` if this object's set of XML namespaces are a subset of the given object's XML namespaces. More...

int	setUserData (void *userData)
	Sets the user data of this element. More...

void *	getUserData () const
	Returns the user data that has been previously set via setUserData(). More...

bool	isSetUserData () const
	Predicate returning true or false depending on whether the user data of this element has been set. More...

int	unsetUserData ()
	Unsets the user data of this element. More...

CaErrorLog *	getErrorLog ()
	Returns the CaErrorLog used to log errors while reading and validating OMEX. More...

Additional Inherited Members
Protected Member Functions inherited from CaBase
bool	getHasBeenDeleted () const

virtual void	setElementText (const std::string &text)
	When overridden allows CaBase elements to use the text included in between the elements tags. More...

Detailed Description

@sbmlbrief{combine} TODO:Definition of the CaOmexManifest class.

Constructor & Destructor Documentation

◆ CaOmexManifest() [1/3]

CaOmexManifest::CaOmexManifest ( )

Creates a new CaOmexManifest instance.

◆ CaOmexManifest() [2/3]

CaOmexManifest::CaOmexManifest ( CaNamespaces * omexns )

Creates a new CaOmexManifest using the given CaNamespaces object omexns.

Parameters

omexns the CaNamespaces object.

Exceptions

OMEXConstructorException Thrown if the given level and version combination, or this kind of OMEX object, are either invalid or mismatched with respect to the parent CaOmexManifest object.

◆ CaOmexManifest() [3/3]

CaOmexManifest::CaOmexManifest ( const CaOmexManifest & orig )

Copy constructor for CaOmexManifest.

Parameters

orig	the CaOmexManifest instance to copy.

◆ ~CaOmexManifest()

virtual CaOmexManifest::~CaOmexManifest ( )

virtual

Destructor for CaOmexManifest.

Member Function Documentation

◆ addContent()

int CaOmexManifest::addContent ( const CaContent * cc )

Adds a copy of the given CaContent to this CaOmexManifest.

Parameters

cc	the CaContent object to add.

@omexconstant{LIBCOMBINE_OPERATION_SUCCESS, OperationReturnValues_t}
@omexconstant{LIBCOMBINE_OPERATION_FAILED, OperationReturnValues_t}

See also: createContent()

◆ clone()

virtual CaOmexManifest * CaOmexManifest::clone ( ) const

virtual

Creates and returns a deep copy of this CaOmexManifest object.

Returns: a (deep) copy of this CaOmexManifest object.

Implements CaBase.

◆ createContent()

CaContent * CaOmexManifest::createContent ( )

Creates a new CaContent object, adds it to this CaOmexManifest object and returns the CaContent object created.

Returns: a new CaContent object instance.

See also: addContent(const CaContent* cc)

◆ getContent() [1/2]

CaContent * CaOmexManifest::getContent ( unsigned int n )

Get a CaContent from the CaOmexManifest.

Parameters

n	an unsigned int representing the index of the CaContent to retrieve.

Returns: the nth CaContent in the CaListOfContents within this CaOmexManifest.

See also: getNumContents()

◆ getContent() [2/2]

const CaContent * CaOmexManifest::getContent ( unsigned int n ) const

Get a CaContent from the CaOmexManifest.

Parameters

n	an unsigned int representing the index of the CaContent to retrieve.

Returns: the nth CaContent in the CaListOfContents within this CaOmexManifest.

See also: getNumContents()

◆ getElementBySId()

virtual CaBase * CaOmexManifest::getElementBySId ( const std::string & id )

virtual

Returns the first child element that has the given id in the model-wide SId namespace, or NULL if no such object is found.

Parameters

id	a string representing the id attribute of the object to retrieve.

Returns: a pointer to the CaBase element with the given id.

Reimplemented from CaBase.

◆ getElementName()

virtual const std::string & CaOmexManifest::getElementName ( ) const

virtual

Returns the XML element name of this CaOmexManifest object.

For CaOmexManifest, the XML element name is always "omexManifest".

Returns: the name of this element, i.e. "omexManifest".

Implements CaBase.

◆ getError() [1/2]

CaError * CaOmexManifest::getError ( unsigned int n )

Get a CaError from the CaDocument.

Parameters

n	an unsigned int representing the index of the CaError to retrieve.

Returns: the nth CaError in the CaListOfErrors within this CaDocument.

See also: getNumErrors()

◆ getError() [2/2]

const CaError * CaOmexManifest::getError ( unsigned int n ) const

Get a CaError from the CaDocument.

Parameters

n	an unsigned int representing the index of the CaError to retrieve.

Returns: the nth CaError in the CaListOfErrors within this CaDocument.

See also: getNumErrors()

◆ getErrorLog() [1/2]

CaErrorLog * CaOmexManifest::getErrorLog ( )

Returns the value of the "CaErrorLog" element of this CaOmexManifest.

Returns: the value of the "CaErrorLog" element of this CaOmexManifest as a CaErrorLog*.

◆ getErrorLog() [2/2]

const CaErrorLog * CaOmexManifest::getErrorLog ( ) const

Returns the value of the "CaErrorLog" element of this CaOmexManifest.

Returns: the value of the "CaErrorLog" element of this CaOmexManifest as a CaErrorLog*.

◆ getLevel()

virtual unsigned int CaOmexManifest::getLevel ( ) const

virtual

return the level of this document

◆ getListOfContents() [1/2]

CaListOfContents * CaOmexManifest::getListOfContents ( )

Returns the CaListOfContents from this CaOmexManifest.

Returns: the CaListOfContents from this CaOmexManifest.

◆ getListOfContents() [2/2]

const CaListOfContents * CaOmexManifest::getListOfContents ( ) const

Returns the CaListOfContents from this CaOmexManifest.

Returns: the CaListOfContents from this CaOmexManifest.

◆ getNamespaces() [1/2]

virtual LIBSBML_CPP_NAMESPACE_QUALIFIER XMLNamespaces * CaOmexManifest::getNamespaces ( )

virtual

Returns the value of the "Namespaces" element of this CaOmexManifest.

Returns: the value of the "Namespaces" element of this CaOmexManifest as a LIBSBML_CPP_NAMESPACE_QUALIFIER XMLNamespaces*.

Reimplemented from CaBase.

◆ getNamespaces() [2/2]

virtual const LIBSBML_CPP_NAMESPACE_QUALIFIER XMLNamespaces * CaOmexManifest::getNamespaces ( ) const

virtual

Returns the value of the "Namespaces" element of this CaOmexManifest.

Returns: the value of the "Namespaces" element of this CaOmexManifest as a LIBSBML_CPP_NAMESPACE_QUALIFIER XMLNamespaces*.

Reimplemented from CaBase.

◆ getNumContents()

unsigned int CaOmexManifest::getNumContents ( ) const

Get the number of CaContent objects in this CaOmexManifest.

Returns: the number of CaContent objects in this CaOmexManifest.

◆ getNumErrors() [1/2]

unsigned int CaOmexManifest::getNumErrors ( ) const

Get the number of CaError objects in this CaDocument.

Returns: the number of CaError objects in this CaDocument.

◆ getNumErrors() [2/2]

unsigned int CaOmexManifest::getNumErrors ( unsigned int severity ) const

Get the number of CaError objects in this CaDocument with the given severity.

Parameters

severity the severity of the CaError to return.

Returns: the number of CaError objects in this CaDocument.

◆ getTypeCode()

virtual int CaOmexManifest::getTypeCode ( ) const

virtual

Returns the libCombine type code for this CaOmexManifest object.

Returns: the OMEX type code for this object:

@omexconstant{LIB_COMBINE_OMEXMANIFEST, OMEXCombineTypeCode_t}

See also: getElementName()

Reimplemented from CaBase.

◆ getVersion()

virtual unsigned int CaOmexManifest::getVersion ( ) const

virtual

return the version of this document

◆ hasRequiredElements()

virtual bool CaOmexManifest::hasRequiredElements ( ) const

virtual

Predicate returning true if all the required elements for this CaOmexManifest object have been set.

Returns: true to indicate that all the required elements of this CaOmexManifest have been set, otherwise false is returned.

Note: The required elements for the CaOmexManifest object are:

◆ operator=()

CaOmexManifest & CaOmexManifest::operator= ( const CaOmexManifest & rhs )

Assignment operator for CaOmexManifest.

Parameters

rhs	the CaOmexManifest object whose values are to be used as the basis of the assignment.

◆ removeContent()

CaContent * CaOmexManifest::removeContent ( unsigned int n )

Removes the nth CaContent from this CaOmexManifest and returns a pointer to it.

Parameters

n	an unsigned int representing the index of the CaContent to remove.

Returns: a pointer to the nth CaContent in this CaOmexManifest.

See also: getNumContents

Note: the caller owns the returned object and is responsible for deleting it.

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CaOmexManifest() [1/3]

◆ CaOmexManifest() [2/3]

◆ CaOmexManifest() [3/3]

◆ ~CaOmexManifest()

Member Function Documentation

◆ addContent()

◆ clone()

◆ createContent()

◆ getContent() [1/2]

◆ getContent() [2/2]

◆ getElementBySId()

◆ getElementName()

◆ getError() [1/2]

◆ getError() [2/2]

◆ getErrorLog() [1/2]

◆ getErrorLog() [2/2]

◆ getLevel()

◆ getListOfContents() [1/2]

◆ getListOfContents() [2/2]

◆ getNamespaces() [1/2]

◆ getNamespaces() [2/2]

◆ getNumContents()

◆ getNumErrors() [1/2]

◆ getNumErrors() [2/2]

◆ getTypeCode()

◆ getVersion()

◆ hasRequiredElements()

◆ operator=()

◆ removeContent()