libNuML 1.1.1
Library for reading / writing NuML documents
CompositeValue Class Reference

This class stores the composite values. More...

#include <CompositeValue.h>

Inheritance diagram for CompositeValue:
Dimension NUMLList NMBase

Public Member Functions

 CompositeValue ()
 
 ~CompositeValue ()
 
 CompositeValue (unsigned int level, unsigned int version)
 Creates a new CompositeValue using the given NUML level and version values. More...
 
 CompositeValue (NUMLNamespaces *numlns)
 Creates a new CompositeValue using the given NUMLNamespaces object numlns. More...
 
virtual CompositeValueclone () const
 Creates and returns a deep copy of this CompositeValue instance. More...
 
virtual bool accept (NUMLVisitor &v) const
 Accepts the given NUMLVisitor for this instance of Dimension. More...
 
virtual NUMLTypeCode_t getTypeCode () const
 Returns the libNUML type code for this NUML object. More...
 
const std::string & getIndexValue () const
 Returns the value of the "indexValue" attribute of this CompositeValue. More...
 
const std::string & getDescription () const
 Returns the value of the "description" attribute of this CompositeValue. More...
 
int setIndexValue (const std::string &indexValue)
 Sets the value of the "indexValue" attribute of this NUML object. More...
 
int setDescription (const std::string &description)
 Sets the value of the "description" attribute of this NUML object. More...
 
virtual const std::string & getElementName () const
 Returns the XML element name of this object, which for CompositeValue, is always "compositeValue". More...
 
virtual NUMLTypeCode_t getItemTypeCode () const
 Returns the libNUML type code for the objects contained in this NUMLList (i.e., CompositeValue objects, if the list is non-empty). More...
 
bool isContentCompositeValue () const
 Predicate returning true or false depending on whether this CompositeValue object's content is another CompositeValue object. More...
 
bool isContentTuple () const
 Predicate returning true or false depending on whether this CompositeValue object's content is Tuple object. More...
 
bool isContentAtomicValue () const
 Predicate returning true or false depending on whether this CompositeValue object's content is AtomicValue object. More...
 
CompositeValuegetCompositeValue (unsigned int n)
 Get a CompositeValue from the CompositeValue. More...
 
TuplegetTuple ()
 Get a Tuple from the CompositeValue. More...
 
AtomicValuegetAtomicValue ()
 Get AtomicValue from the CompositeValue. More...
 
virtual const CompositeValueget (unsigned int n) const
 Get a CompositeValue from the CompositeValue. More...
 
virtual CompositeValueget (unsigned int n)
 Get a CompositeValue from the CompositeValue. More...
 
virtual CompositeValueremove (unsigned int n)
 Removes the nth item from this CompositeValue items and returns a pointer to it. More...
 
virtual void readAttributes (const LIBSBML_CPP_NAMESPACE_QUALIFIER XMLAttributes &attributes)
 Subclasses should override this method to read values from the given XMLAttributes set into their specific fields. More...
 
virtual void writeAttributes (LIBSBML_CPP_NAMESPACE_QUALIFIER XMLOutputStream &stream) const
 Subclasses should override this method to write their XML attributes to the XMLOutputStream. More...
 
int addCompositeValue (const CompositeValue *compValue)
 Adds a given CompositeValue object as a child in this CompositeVlaue. More...
 
CompositeValuecreateCompositeValue ()
 Creates a new CompositeValue object inside this CompositeValue add to it's List and return it. More...
 
TuplecreateTuple ()
 Creates a new Tuple inside this CompositeValue and return it. More...
 
AtomicValuecreateAtomicValue ()
 Creates a new AtomicValue to this CompositeValue and returns it. More...
 
- Public Member Functions inherited from Dimension
 Dimension ()
 
 Dimension (unsigned int level, unsigned int version)
 Creates an new Dimension using the given NUML level and version values. More...
 
 Dimension (NUMLNamespaces *numlns)
 Creates a new Dimension using the given NUMLNamespaces object numlns. More...
 
virtual bool accept (NUMLVisitor &v) const
 Accepts the given NUMLVisitor for this instance of Dimension. More...
 
virtual Dimensionclone () const
 Creates and returns a deep copy of this Dimension instance. More...
 
CompositeValuecreateCompositeValue ()
 Creates a new CompositeValue and add it to Dimension's list inside this ResultComponent and return it. More...
 
TuplecreateTuple ()
 creates a new tuple and adds it to the dimension More...
 
AtomicValuecreateAtomicValue ()
 creates a new atomic value and adds it to the dimension More...
 
virtual NUMLTypeCode_t getTypeCode () const
 Returns the libNUML type code for this NUML object. More...
 
virtual NUMLTypeCode_t getItemTypeCode () const
 Returns the libNUML type code for the objects contained in this NUMLList (i.e., CompositeValue objects, if the list is non-empty). More...
 
virtual const std::string & getElementName () const
 Returns the XML element name of this object. More...
 
virtual Dimensionget (unsigned int n)
 Get a CompositeValue from the Dimension. More...
 
virtual const Dimensionget (unsigned int n) const
 Get a CompositeValue from the Dimension. More...
 
virtual CompositeValueget (const std::string &sid)
 Get a CompositeValue from the Dimension based on its identifier. More...
 
virtual const CompositeValueget (const std::string &sid) const
 Get a CompositeValue from the Dimension based on its identifier. More...
 
virtual Dimensionremove (unsigned int n)
 Removes the nth item from this Dimension items and returns a pointer to it. More...
 
virtual Dimensionremove (const std::string &sid)
 Removes item in this Dimension items with the given identifier. More...
 
virtual int getElementPosition () const
 Get the ordinal position of this element in the containing object (which in this case is the Model object). More...
 
virtual ~Dimension ()
 Subclasses should override this method to write out their contained NUML objects as XML elements. More...
 
- Public Member Functions inherited from NUMLList
 NUMLList (unsigned int level, unsigned int version)
 Creates a new NUMLList using the given NUML level and version values. More...
 
 NUMLList (NUMLNamespaces *numlns)
 Creates a new DimensionDescription using the given NUMLNamespaces object numlns. More...
 
 NUMLList ()
 
virtual ~NUMLList ()
 
 NUMLList (const NUMLList &orig)
 Copy constructor. More...
 
NUMLListoperator= (const NUMLList &rhs)
 Assignment operator for NUMLList. More...
 
virtual bool accept (NUMLVisitor &v) const
 Accepts the given NUMLVisitor. More...
 
virtual NMBaseclone () const
 Creates and returns a deep copy of this NUMLList. More...
 
void append (const NMBase *item)
 Adds item to the end of this NUMLList. More...
 
void appendAndOwn (NMBase *item)
 Adds item to the end of this NUMLList. More...
 
virtual const NMBaseget (unsigned int n) const
 Get an item from the list. More...
 
virtual NMBaseget (unsigned int n)
 Get an item from the list. More...
 
void clear (bool doDelete=true)
 Removes all items in this NUMLList object. More...
 
virtual NMBaseremove (unsigned int n)
 Removes the nth item from this NUMLList items and returns a pointer to it. More...
 
unsigned int size () const
 Get the size of this NUMLList. More...
 
virtual void setNUMLDocument (NUMLDocument *d)
 Sets the parent NUMLDocument of this NUML object. More...
 
virtual void setParentNUMLObject (NMBase *sb)
 Sets the parent NUML object of this NUML object. More...
 
virtual NUMLTypeCode_t getTypeCode () const
 Get the type code of the objects contained in this SedListOf. More...
 
virtual NUMLTypeCode_t getItemTypeCode () const
 Get the type code of the objects contained in this NUMLList. More...
 
virtual const std::string & getElementName () const
 Returns the XML element name of this object, which for NUMLList, is always "listOf". More...
 
virtual void writeElements (LIBSBML_CPP_NAMESPACE_QUALIFIER XMLOutputStream &stream) const
 Subclasses should override this method to write out their contained NUML objects as XML elements. More...
 
- Public Member Functions inherited from NMBase
virtual ~NMBase ()
 Destroy this object. More...
 
NMBaseoperator= (const NMBase &orig)
 Assignment operator for NMBase. More...
 
virtual bool accept (NUMLVisitor &v) const =0
 Accepts the given NUMLVisitor for this instance of NMBase. More...
 
virtual NMBaseclone () const =0
 Creates and returns a deep copy of this NMBase object. 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
 
virtual const std::string & getName () const
 
virtual LIBSBML_CPP_NAMESPACE_QUALIFIER XMLNamespaces * getNamespaces () const
 Returns the content of the "annotation" subelement of this object as a character string. More...
 
const NUMLDocumentgetNUMLDocument () const
 Returns the parent NUMLDocument object. More...
 
NUMLDocumentgetNUMLDocument ()
 Returns the parent NUMLDocument object. More...
 
NMBasegetParentNUMLObject ()
 Returns the parent NUML object. More...
 
NMBasegetAncestorOfType (NUMLTypeCode_t type)
 Returns the ancestor NUML object that corresponds to the given NUMLTypeCode_t. More...
 
unsigned int getLine () const
 Returns the line number on which this object first appears in the XML representation of the NUML document. More...
 
unsigned int getColumn () const
 Returns the column number on which this object first appears in the XML representation of the NUML document. More...
 
bool isSetMetaId () const
 Predicate returning true or false depending on whether this object's "metaid" attribute has been set. More...
 
bool isSetName () const
 
int setMetaId (const std::string &metaid)
 Sets the value of the "metaid" attribute of this object. More...
 
virtual int setId (const std::string &sid)
 
virtual void setNUMLDocument (NUMLDocument *d)
 Sets the parent NUMLDocument of this NUML object. More...
 
virtual void setParentNUMLObject (NMBase *sb)
 Sets the parent NUML object of this NUML object. More...
 
int setNamespaces (LIBSBML_CPP_NAMESPACE_QUALIFIER XMLNamespaces *xmlns)
 Sets the namespaces relevant of this NUML object. More...
 
int unsetMetaId ()
 Unsets the value of the "metaid" attribute of this NUML object. More...
 
unsigned int getLevel () const
 Returns the NUML Level of the overall NUML document. More...
 
unsigned int getVersion () const
 Returns the Version within the NUML Level of the overall NUML document. More...
 
virtual NUMLTypeCode_t getTypeCode () const
 Returns the libnuml type code for this object. More...
 
bool hasValidLevelVersionNamespaceCombination ()
 Predicate returning true or false depending on whether this object's level/version and namespace values correspond to a valid NUML specification. More...
 
virtual const std::string & getElementName () const =0
 Returns the XML element name of this object. More...
 
char * toNUML ()
 Returns a string that consists of the partial NUML describing this object. More...
 
void read (LIBSBML_CPP_NAMESPACE_QUALIFIER XMLInputStream &stream)
 Reads (initializes) this NUML object by reading from XMLInputStream. More...
 
void write (LIBSBML_CPP_NAMESPACE_QUALIFIER XMLOutputStream &stream) const
 Writes (serializes) this NUML object by writing it to XMLOutputStream. More...
 
virtual void writeElements (LIBSBML_CPP_NAMESPACE_QUALIFIER XMLOutputStream &stream) const
 Subclasses should override this method to write out their contained NUML objects as XML elements. More...
 
virtual bool hasRequiredAttributes () const
 
virtual bool hasRequiredElements () const
 
void setNUMLNamespaces (NUMLNamespaces *numlns)
 
NUMLNamespacesgetNUMLNamespaces () const
 
void syncAnnotation ()
 
bool isSetNotes () const
 
bool isSetAnnotation () const
 
virtual int setAnnotation (const LIBSBML_CPP_NAMESPACE_QUALIFIER XMLNode *annotation)
 
virtual int setAnnotation (const std::string &annotation)
 
virtual int appendAnnotation (const LIBSBML_CPP_NAMESPACE_QUALIFIER XMLNode *annotation)
 
virtual int appendAnnotation (const std::string &annotation)
 
int removeTopLevelAnnotationElement (const std::string elementName, const std::string elementURI="")
 
int replaceTopLevelAnnotationElement (const LIBSBML_CPP_NAMESPACE_QUALIFIER XMLNode *annotation)
 
int replaceTopLevelAnnotationElement (const std::string &annotation)
 
int setNotes (const LIBSBML_CPP_NAMESPACE_QUALIFIER XMLNode *notes)
 
int setNotes (const std::string &notes, bool addXHTMLMarkup=false)
 
int appendNotes (const LIBSBML_CPP_NAMESPACE_QUALIFIER XMLNode *notes)
 
int appendNotes (const std::string &notes)
 
int unsetNotes ()
 
int unsetAnnotation ()
 
LIBSBML_CPP_NAMESPACE_QUALIFIER XMLNode * getNotes () const
 
std::string getNotesString () const
 
LIBSBML_CPP_NAMESPACE_QUALIFIER XMLNode * getAnnotation () const
 
std::string getAnnotationString () const
 

Protected Member Functions

virtual NMBasecreateObject (LIBSBML_CPP_NAMESPACE_QUALIFIER XMLInputStream &stream)
 Subclasses should override this method to write out their contained NUML objects as XML elements. More...
 
- Protected Member Functions inherited from Dimension
virtual NMBasecreateObject (LIBSBML_CPP_NAMESPACE_QUALIFIER XMLInputStream &stream)
 
void setType (DimensionType type)
 Sets type of this Dimension. More...
 
virtual void readAttributes (const LIBSBML_CPP_NAMESPACE_QUALIFIER XMLAttributes &attributes)
 Subclasses should override this method to read values from the given XMLAttributes set into their specific fields. More...
 
virtual void writeAttributes (LIBSBML_CPP_NAMESPACE_QUALIFIER XMLOutputStream &stream) const
 Subclasses should override this method to write their XML attributes to the XMLOutputStream. More...
 
- Protected Member Functions inherited from NMBase
virtual void writeXMLNS (LIBSBML_CPP_NAMESPACE_QUALIFIER XMLOutputStream &stream) const
 Subclasses should override this method to write their xmlns attriubutes (if any) to the XMLOutputStream. More...
 
 NMBase (const std::string &id="", const std::string &name="")
 Only subclasses may create NMBase objects. More...
 
 NMBase (unsigned int level, unsigned int version)
 Creates a new NMBase object with the given sboTerm. More...
 
 NMBase (NUMLNamespaces *numlns)
 Creates a new NMBase object with the given NUMLNamespaces. More...
 
 NMBase (const NMBase &orig)
 Copy constructor. More...
 
virtual NMBasecreateObject (LIBSBML_CPP_NAMESPACE_QUALIFIER XMLInputStream &stream)
 Subclasses should override this method to create, store, and then return an NUML object corresponding to the next XMLToken in the XMLInputStream. More...
 
virtual bool readOtherXML (LIBSBML_CPP_NAMESPACE_QUALIFIER XMLInputStream &stream)
 Subclasses should override this method to read (and store) XHTML, MathML, etc. More...
 
virtual int getElementPosition () const
 The NUML XML Schema is written such that the order of child elements is significant. More...
 
NUMLErrorLoggetErrorLog ()
 
void logError (unsigned int id, const unsigned int level=2, const unsigned int version=3, const std::string &details="")
 Convenience method for easily logging problems from within method implementations. More...
 
void logUnknownAttribute (std::string attribute, const unsigned int level, const unsigned int version, const std::string element)
 Helper to log a common type of error. More...
 
void logUnknownElement (const std::string element, const unsigned int level, const unsigned int version)
 Helper to log a common type of error. More...
 
void logEmptyString (std::string attribute, const unsigned int level, const unsigned int version, std::string element)
 Helper to log a common type of error. More...
 
virtual void readAttributes (const LIBSBML_CPP_NAMESPACE_QUALIFIER XMLAttributes &attributes)
 Subclasses should override this method to read values from the given XMLAttributes set into their specific fields. More...
 
virtual void writeAttributes (LIBSBML_CPP_NAMESPACE_QUALIFIER XMLOutputStream &stream) const
 Subclasses should override this method to write their XML attributes to the XMLOutputStream. More...
 
void checkOrderAndLogError (NMBase *object, int expected)
 Checks that NUML element has been read in the proper order. More...
 
void checkNUMLListPopulated (NMBase *object)
 Checks that an NUML NUMLList element has been populated. More...
 
void checkDefaultNamespace (const LIBSBML_CPP_NAMESPACE_QUALIFIER XMLNamespaces *xmlns, const std::string &elementName)
 Checks that the given default namespace in the given element is valid. More...
 
void checkXHTML (const LIBSBML_CPP_NAMESPACE_QUALIFIER XMLNode *)
 Checks that the XHTML is valid. More...
 
void checkAnnotation ()
 Checks the annotation does not declare an numl namespace. More...
 

Protected Attributes

std::string mIndexValue
 
std::string mDescription
 
NUMLTypeCode_t mContentType
 
- Protected Attributes inherited from Dimension
DimensionType mType
 
- Protected Attributes inherited from NUMLList
std::vector< NMBase * > mItems
 
- Protected Attributes inherited from NMBase
std::string mMetaId
 
std::string mId
 
std::string mName
 
NUMLDocumentmNUML
 
LIBSBML_CPP_NAMESPACE_QUALIFIER XMLNode * mNotes
 
LIBSBML_CPP_NAMESPACE_QUALIFIER XMLNode * mAnnotation
 
NUMLNamespacesmNUMLNamespaces
 
unsigned int mLine
 
unsigned int mColumn
 
int mDept
 
NMBasemParentNUMLObject
 
bool mHasBeenDeleted
 
std::string mEmptyString
 

Additional Inherited Members

- Protected Types inherited from Dimension
enum  DimensionType { Unknown , CompositeValueType , TupleType , AtomicValueType }
 

Detailed Description

This class stores the composite values.

Constructor & Destructor Documentation

◆ CompositeValue() [1/3]

CompositeValue::CompositeValue ( )

◆ ~CompositeValue()

CompositeValue::~CompositeValue ( )

◆ CompositeValue() [2/3]

LIBNUML_CPP_NAMESPACE_BEGIN CompositeValue::CompositeValue ( unsigned int  level,
unsigned int  version 
)

Creates a new CompositeValue using the given NUML level and version values.

Parameters
levelan unsigned int, the NUML Level to assign to this CompositeValue
versionan unsigned int, the NUML Version to assign to this CompositeValue
Note
Once a CompositeValue has been added to an NUMLDocument, the level, version for the document override those used to create the CompositeValue. Despite this, the ability to supply the values at creation time is an important aid to creating valid NUML. Knowledge of the intented NUML Level and Version determine whether it is valid to assign a particular value to an attribute, or whether it is valid to add an object to an existing NUMLDocument.

◆ CompositeValue() [3/3]

CompositeValue::CompositeValue ( NUMLNamespaces numlns)

Creates a new CompositeValue using the given NUMLNamespaces object numlns.

The NUMLNamespaces object encapsulates NUML Level/Version/namespaces information. It is used to communicate the NUML Level, Version, and (in Level 3) packages used in addition to NUML Level  Core. A common approach to using this class constructor is to create an NUMLNamespaces object somewhere in a program, once, then pass it to object constructors such as this one when needed.

Parameters
numlnsan NUMLNamespaces object.
Note
Once a CompositeValue has been added to an NUMLDocument, the level, version and xmlns namespaces for the document override those used to create the CompositeValue. Despite this, the ability to supply the values at creation time is an important aid to creating valid NUML. Knowledge of the intented NUML Level and Version determine whether it is valid to assign a particular value to an attribute, or whether it is valid to add an object to an existing NUMLDocument.

Member Function Documentation

◆ accept()

bool CompositeValue::accept ( NUMLVisitor v) const
virtual

Accepts the given NUMLVisitor for this instance of Dimension.

Parameters
vthe NUMLVisitor instance to be used.
Returns
the result of calling v.visit().

Reimplemented from Dimension.

◆ addCompositeValue()

int CompositeValue::addCompositeValue ( const CompositeValue compValue)

Adds a given CompositeValue object as a child in this CompositeVlaue.

The CompositeValue instance in compValue is copied.

Parameters
compValuea CompositeValue object referring to a Child in the CompositeValue
Returns
integer value indicating success/failure of the function. The possible values returned by this function are:
  • LIBNUML_OPERATION_SUCCESS
  • LIBNUML_LEVEL_MISMATCH
  • LIBNUML_VERSION_MISMATCH
  • LIBNUML_OPERATION_FAILED
Note
This method should be used with some caution. The fact that this method copies the object passed to it means that the caller will be left holding a physically different object instance than the one contained in this CompositeVlaue. Changes made to the original object instance (such as resetting attribute values) will not affect the instance in the CompositeVlaue. In addition, the caller should make sure to free the original object if it is no longer being used, or else a memory leak will result. Please see CompositeVlaue::createReactant() for a method that does not lead to these issues.
See also
createCompositeValue()

◆ clone()

CompositeValue * CompositeValue::clone ( ) const
virtual

Creates and returns a deep copy of this CompositeValue instance.

Returns
a (deep) copy of this CompositeValue.

Reimplemented from Dimension.

◆ createAtomicValue()

AtomicValue * CompositeValue::createAtomicValue ( )

Creates a new AtomicValue to this CompositeValue and returns it.

Returns
the AtomicValue object created
See also
addAtomicValue(const AtomicValue *aValue)

◆ createCompositeValue()

CompositeValue * CompositeValue::createCompositeValue ( )

Creates a new CompositeValue object inside this CompositeValue add to it's List and return it.

Returns
the CompositeValue object created
See also
addCompositeValue(const CompositeValue *compValue)

◆ createObject()

NMBase * CompositeValue::createObject ( LIBSBML_CPP_NAMESPACE_QUALIFIER XMLInputStream &  stream)
protectedvirtual

Subclasses should override this method to write out their contained NUML objects as XML elements.

Be sure to call your parents implementation of this method as well.

Returns
the NUML object corresponding to next XMLToken in the XMLInputStream or NULL if the token was not recognized.

Reimplemented from Dimension.

◆ createTuple()

Tuple * CompositeValue::createTuple ( )

Creates a new Tuple inside this CompositeValue and return it.

Returns
the Tuple object created
See also
addTuple(const Tuple *tuple)

◆ get() [1/2]

CompositeValue * CompositeValue::get ( unsigned int  n)
virtual

Get a CompositeValue from the CompositeValue.

Parameters
nthe index number of the CompositeValue to get.
Returns
the nth CompositeValue in this CompositeValue.
See also
size()

Reimplemented from Dimension.

◆ get() [2/2]

const CompositeValue * CompositeValue::get ( unsigned int  n) const
virtual

Get a CompositeValue from the CompositeValue.

Parameters
nthe index number of the CompositeValue to get.
Returns
the nth CompositeValue in this CompositeValue.
See also
size()

Reimplemented from Dimension.

◆ getAtomicValue()

AtomicValue * CompositeValue::getAtomicValue ( )

Get AtomicValue from the CompositeValue.

Parameters
nthe index number of the AtomicValue to get is alway zero for AtomicValue.
Returns
the 0th AtomicValue in this CompositeValue.
See also
size()

◆ getCompositeValue()

CompositeValue * CompositeValue::getCompositeValue ( unsigned int  n)

Get a CompositeValue from the CompositeValue.

Parameters
nthe index number of the CompositeValue to get.
Returns
the nth CompositeValue in this CompositeValue.
See also
size()

◆ getDescription()

const string & CompositeValue::getDescription ( ) const

Returns the value of the "description" attribute of this CompositeValue.

Returns
the description of this CompositeValue.

◆ getElementName()

const string & CompositeValue::getElementName ( ) const
virtual

Returns the XML element name of this object, which for CompositeValue, is always "compositeValue".

Returns
the name of this element, i.e., "compositeValue".

Reimplemented from Dimension.

◆ getIndexValue()

const string & CompositeValue::getIndexValue ( ) const

Returns the value of the "indexValue" attribute of this CompositeValue.

Returns
the indexValue of this CompositeValue.

◆ getItemTypeCode()

NUMLTypeCode_t CompositeValue::getItemTypeCode ( ) const
virtual

Returns the libNUML type code for the objects contained in this NUMLList (i.e., CompositeValue objects, if the list is non-empty).

Returns
the NUML type code for the objects contained in this NUMLList instance, or NUML_UNKNOWN (default).
See also
getElementName()

Reimplemented from Dimension.

◆ getTuple()

Tuple * CompositeValue::getTuple ( )

Get a Tuple from the CompositeValue.

Parameters
nthe index number of the Tuple to get is alway zero for Tuple.
Returns
the 0th Tuple in this CompositeValue.
See also
size()

◆ getTypeCode()

virtual NUMLTypeCode_t CompositeValue::getTypeCode ( ) const
inlinevirtual

Returns the libNUML type code for this NUML object.

Returns
the NUML type code for this object, or NUML_UNKNOWN (default).
See also
getElementName()

Reimplemented from Dimension.

◆ isContentAtomicValue()

bool CompositeValue::isContentAtomicValue ( ) const

Predicate returning true or false depending on whether this CompositeValue object's content is AtomicValue object.

Returns
true if the content of this CompositeValue object is AtomicValue object, false otherwise.
See also
getAtomicValue()

◆ isContentCompositeValue()

bool CompositeValue::isContentCompositeValue ( ) const

Predicate returning true or false depending on whether this CompositeValue object's content is another CompositeValue object.

Returns
true if the content of this CompositeValue object is another CompositeValue object, false otherwise.
See also
getCompositeValue(unsigned int n)

◆ isContentTuple()

bool CompositeValue::isContentTuple ( ) const

Predicate returning true or false depending on whether this CompositeValue object's content is Tuple object.

Returns
true if the content of this CompositeValue object is Tuple object, false otherwise.
See also
getTuple()

◆ readAttributes()

void CompositeValue::readAttributes ( const LIBSBML_CPP_NAMESPACE_QUALIFIER XMLAttributes &  attributes)
virtual

Subclasses should override this method to read values from the given XMLAttributes set into their specific fields.

Be sure to call your parents implementation of this method as well.

Reimplemented from NUMLList.

◆ remove()

CompositeValue * CompositeValue::remove ( unsigned int  n)
virtual

Removes the nth item from this CompositeValue items and returns a pointer to it.

The caller owns the returned item and is responsible for deleting it.

Parameters
nthe index of the item to remove
See also
size()

Reimplemented from Dimension.

◆ setDescription()

int CompositeValue::setDescription ( const std::string &  description)

Sets the value of the "description" attribute of this NUML object.

The string in description is copied.

Parameters
descriptionthe new description for the object
Returns
integer value indicating success/failure of the function. The possible values returned by this function are:
  • LIBNUML_OPERATION_SUCCESS
  • LIBNUML_INVALID_ATTRIBUTE_VALUE

◆ setIndexValue()

int CompositeValue::setIndexValue ( const std::string &  indexValue)

Sets the value of the "indexValue" attribute of this NUML object.

The string in indexValue is copied.

Parameters
indexValuethe new indexValue for the object
Returns
integer value indicating success/failure of the function. The possible values returned by this function are:
  • LIBNUML_OPERATION_SUCCESS
  • LIBNUML_INVALID_ATTRIBUTE_VALUE

◆ writeAttributes()

void CompositeValue::writeAttributes ( LIBSBML_CPP_NAMESPACE_QUALIFIER XMLOutputStream &  stream) const
virtual

Subclasses should override this method to write their XML attributes to the XMLOutputStream.

Be sure to call your parents implementation of this method as well.

Reimplemented from NUMLList.

Member Data Documentation

◆ mContentType

NUMLTypeCode_t CompositeValue::mContentType
protected

◆ mDescription

std::string CompositeValue::mDescription
protected

◆ mIndexValue

std::string CompositeValue::mIndexValue
protected

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