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

#include <CaCrossRef.h>

Inheritance diagram for CaCrossRef:

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

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

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

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

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

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

const std::string &	getLocation () const
	Returns the value of the "location" attribute of this CaCrossRef. More...

bool	isSetLocation () const
	Predicate returning `true` if this CaCrossRef's "location" attribute is set. More...

int	setLocation (const std::string &location)
	Sets the value of the "location" attribute of this CaCrossRef. More...

int	unsetLocation ()
	Unsets the value of the "location" attribute of this CaCrossRef. More...

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

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

virtual bool	hasRequiredAttributes () const
	Predicate returning `true` if all the required attributes for this CaCrossRef object have been set. 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 CaCrossRef class.

Constructor & Destructor Documentation

◆ CaCrossRef() [1/3]

CaCrossRef::CaCrossRef ( )

Creates a new CaCrossRef instance.

◆ CaCrossRef() [2/3]

CaCrossRef::CaCrossRef ( CaNamespaces * omexns )

Creates a new CaCrossRef using the given CaNamespaces object omexns.

Parameters

omexns the CaNamespaces object.

◆ CaCrossRef() [3/3]

CaCrossRef::CaCrossRef ( const CaCrossRef & orig )

Copy constructor for CaCrossRef.

Parameters

orig	the CaCrossRef instance to copy.

◆ ~CaCrossRef()

virtual CaCrossRef::~CaCrossRef ( )

virtual

Destructor for CaCrossRef.

Member Function Documentation

◆ clone()

virtual CaCrossRef * CaCrossRef::clone ( ) const

virtual

Creates and returns a deep copy of this CaCrossRef object.

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

Implements CaBase.

◆ getElementName()

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

virtual

Returns the XML element name of this CaCrossRef object.

For CaCrossRef, the XML element name is always "crossRef".

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

Implements CaBase.

◆ getLocation()

const std::string & CaCrossRef::getLocation ( ) const

Returns the value of the "location" attribute of this CaCrossRef.

Returns: the value of the "location" attribute of this CaCrossRef as a string.

◆ getTypeCode()

virtual int CaCrossRef::getTypeCode ( ) const

virtual

Returns the libCombine type code for this CaCrossRef object.

Returns: the OMEX type code for this object: @omexconstant{LIB_COMBINE_CROSSREF, CaTypeCode_t}.

See also: getElementName()

Reimplemented from CaBase.

◆ hasRequiredAttributes()

virtual bool CaCrossRef::hasRequiredAttributes ( ) const

virtual

Predicate returning true if all the required attributes for this CaCrossRef object have been set.

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

Note

The required attributes for the CaCrossRef object are:

"location"

◆ isSetLocation()

bool CaCrossRef::isSetLocation ( ) const

Predicate returning true if this CaCrossRef's "location" attribute is set.

Returns: true if this CaCrossRef's "location" attribute has been set, otherwise false is returned.

◆ operator=()

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

Assignment operator for CaCrossRef.

Parameters

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

◆ setLocation()

int CaCrossRef::setLocation ( const std::string & location )

Sets the value of the "location" attribute of this CaCrossRef.

Parameters

location std::string& value of the "location" attribute to be set.

@omexconstant{LIBCOMBINE_OPERATION_SUCCESS, OperationReturnValues_t}

Calling this function with location = NULL or an empty string is equivalent to calling unsetLocation().

◆ unsetLocation()

int CaCrossRef::unsetLocation ( )

Unsets the value of the "location" attribute of this CaCrossRef.

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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CaCrossRef() [1/3]

◆ CaCrossRef() [2/3]

◆ CaCrossRef() [3/3]

◆ ~CaCrossRef()

Member Function Documentation

◆ clone()

◆ getElementName()

◆ getLocation()

◆ getTypeCode()

◆ hasRequiredAttributes()

◆ isSetLocation()

◆ operator=()

◆ setLocation()

◆ unsetLocation()