libNuML
1.1.1
Library for reading / writing NuML documents
|
This class stores the dimension description. More...
#include <DimensionDescription.h>
Public Member Functions | |
DimensionDescription () | |
DimensionDescription (unsigned int level, unsigned int version) | |
Creates a new DimensionDescription using the given NUML level and version values. More... | |
DimensionDescription (NUMLNamespaces *numlns) | |
Creates a new DimensionDescription using the given NUMLNamespaces object numlns . More... | |
virtual bool | accept (NUMLVisitor &v) const |
Accepts the given NUMLVisitor for this instance of NMBase. More... | |
virtual DimensionDescription * | clone () const |
Creates and returns a deep copy of this NMBase object. More... | |
CompositeDescription * | createCompositeDescription () |
Returns a list of the XML Namespaces declared on this NUML document. More... | |
TupleDescription * | createTupleDescription () |
creates a new tupledescription and adds it to the dimensiondescription More... | |
AtomicDescription * | createAtomicDescription () |
creates a new atomic description and adds it to the dimensiondescription More... | |
virtual const std::string & | getElementName () const |
Returns the XML element name of this object, which for DimensionDescription, is always "model" . 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., CompositeDescription objects, if the list is non-empty). More... | |
virtual DimensionDescription * | get (unsigned int n) |
Returns the XML element name of this object. More... | |
virtual const DimensionDescription * | get (unsigned int n) const |
Get a CompositeDescription from the DimensionDescription. More... | |
virtual DimensionDescription * | get (const std::string &sid) |
Get a CompositeDescription from the DimensionDescription based on its identifier. More... | |
virtual const DimensionDescription * | get (const std::string &sid) const |
Get a CompositeDescription from the DimensionDescription based on its identifier. More... | |
virtual const std::string & | getId () const |
virtual int | setId (const std::string &id) |
virtual const std::string & | getName () const |
virtual int | setName (const std::string &name) |
virtual DimensionDescription * | remove (unsigned int n) |
Removes the nth item from this DimensionDescription items and returns a pointer to it. More... | |
virtual DimensionDescription * | remove (const std::string &sid) |
Removes item in this DimensionDescription 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 | ~DimensionDescription () |
![]() | |
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... | |
NUMLList & | operator= (const NUMLList &rhs) |
Assignment operator for 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... | |
void | clear (bool doDelete=true) |
Removes all items in this NUMLList object. 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 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 | ~NMBase () |
Destroy this object. More... | |
NMBase & | operator= (const NMBase &orig) |
Assignment operator for NMBase. 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 LIBSBML_CPP_NAMESPACE_QUALIFIER XMLNamespaces * | getNamespaces () const |
Returns the content of the "annotation" subelement of this object as a character string. More... | |
const NUMLDocument * | getNUMLDocument () const |
Returns the parent NUMLDocument object. More... | |
NUMLDocument * | getNUMLDocument () |
Returns the parent NUMLDocument object. More... | |
NMBase * | getParentNUMLObject () |
Returns the parent NUML object. More... | |
NMBase * | getAncestorOfType (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... | |
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... | |
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... | |
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 bool | hasRequiredAttributes () const |
virtual bool | hasRequiredElements () const |
void | setNUMLNamespaces (NUMLNamespaces *numlns) |
NUMLNamespaces * | getNUMLNamespaces () const |
void | syncAnnotation () |
bool | isSetNotes () const |
bool | isSetAnnotation () const |
virtual int | setAnnotation (const XMLNode *annotation) |
virtual int | setAnnotation (const std::string &annotation) |
virtual int | appendAnnotation (const XMLNode *annotation) |
virtual int | appendAnnotation (const std::string &annotation) |
int | removeTopLevelAnnotationElement (const std::string elementName, const std::string elementURI="") |
int | replaceTopLevelAnnotationElement (const XMLNode *annotation) |
int | replaceTopLevelAnnotationElement (const std::string &annotation) |
int | setNotes (const XMLNode *notes) |
int | setNotes (const std::string ¬es, bool addXHTMLMarkup=false) |
int | appendNotes (const XMLNode *notes) |
int | appendNotes (const std::string ¬es) |
int | unsetNotes () |
int | unsetAnnotation () |
XMLNode * | getNotes () const |
std::string | getNotesString () const |
XMLNode * | getAnnotation () const |
std::string | getAnnotationString () const |
Protected Member Functions | |
virtual NMBase * | createObject (LIBSBML_CPP_NAMESPACE_QUALIFIER XMLInputStream &stream) |
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... | |
![]() | |
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... | |
![]() | |
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 bool | readOtherXML (LIBSBML_CPP_NAMESPACE_QUALIFIER XMLInputStream &stream) |
Subclasses should override this method to read (and store) XHTML, MathML, etc. More... | |
NUMLErrorLog * | getErrorLog () |
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... | |
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 | mId |
std::string | mName |
![]() | |
std::vector< NMBase * > | mItems |
![]() | |
std::string | mMetaId |
std::string | mId |
std::string | mName |
NUMLDocument * | mNUML |
LIBSBML_CPP_NAMESPACE_QUALIFIER XMLNode * | mNotes |
LIBSBML_CPP_NAMESPACE_QUALIFIER XMLNode * | mAnnotation |
NUMLNamespaces * | mNUMLNamespaces |
unsigned int | mLine |
unsigned int | mColumn |
int | mDept |
NMBase * | mParentNUMLObject |
bool | mHasBeenDeleted |
std::string | mEmptyString |
This class stores the dimension description.
DimensionDescription::DimensionDescription | ( | ) |
LIBNUML_CPP_NAMESPACE_BEGIN DimensionDescription::DimensionDescription | ( | unsigned int | level, |
unsigned int | version | ||
) |
Creates a new DimensionDescription using the given NUML level
and version
values.
level | an unsigned int, the NUML Level to assign to this DimensionDescription |
version | an unsigned int, the NUML Version to assign to this DimensionDescription |
level
, version
for the document override those used to create the DimensionDescription. 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. DimensionDescription::DimensionDescription | ( | NUMLNamespaces * | numlns | ) |
Creates a new DimensionDescription 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.
numlns | an NUMLNamespaces object. |
level
, version
and xmlns
namespaces for the document override those used to create the DimensionDescription. 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.
|
virtual |
|
virtual |
Accepts the given NUMLVisitor for this instance of NMBase.
v | the NUMLVisitor instance to be used. |
v.visit()
. Reimplemented from NUMLList.
Reimplemented in CompositeDescription, and AtomicDescription.
|
virtual |
Creates and returns a deep copy of this NMBase object.
Reimplemented from NUMLList.
Reimplemented in AtomicDescription, CompositeDescription, and TupleDescription.
AtomicDescription * DimensionDescription::createAtomicDescription | ( | ) |
creates a new atomic description and adds it to the dimensiondescription
CompositeDescription * DimensionDescription::createCompositeDescription | ( | ) |
Returns a list of the XML Namespaces declared on this NUML document.
Creates a new CompositeDescription and add it to DimensionDescription's list inside this ResultComponent and return it.
d | the NUMLDocument object to use Sets the parent NUML object of this NUML object. |
sb | the NUML object to use Creates a new CompositeDescription and add it to DimensionDescription's list inside this ResultComponent and return it. |
|
protectedvirtual |
Reimplemented from NMBase.
Reimplemented in CompositeDescription, and TupleDescription.
TupleDescription * DimensionDescription::createTupleDescription | ( | ) |
creates a new tupledescription and adds it to the dimensiondescription
|
virtual |
Returns the XML element name of this object.
For DimensionDescription, the XML element name is "DimensionDescription"
.
"DimensionDescription"
. Get a CompositeDescription from the DimensionDescription.n | the index number of the CompositeDescription to get. |
Reimplemented from NUMLList.
Reimplemented in CompositeDescription.
|
virtual |
Get a CompositeDescription from the DimensionDescription.
n | the index number of the CompositeDescription to get. |
Reimplemented from NUMLList.
Reimplemented in CompositeDescription.
|
virtual |
Get a CompositeDescription from the DimensionDescription based on its identifier.
sid | a string representing the identifier of the CompositeDescription to get. |
|
virtual |
Get a CompositeDescription from the DimensionDescription based on its identifier.
sid | a string representing the identifier of the CompositeDescription to get. |
|
virtual |
Returns the XML element name of this object, which for DimensionDescription, is always "model"
.
"model"
. Reimplemented from NUMLList.
Reimplemented in CompositeDescription, TupleDescription, and AtomicDescription.
|
virtual |
Get the ordinal position of this element in the containing object (which in this case is the Model object).
The ordering of elements in the XML form of NUML is generally fixed for most components in NUML. So, for example, the DimensionDescription in a model is (in NUML Level 2 Version 4) the sixth NUMLList. (However, it differs for different Levels and Versions of NUML.)
-1
(default) to indicate the position is not significant. Reimplemented from NMBase.
Reimplemented in TupleDescription.
|
virtual |
Reimplemented from NMBase.
Reimplemented in AtomicDescription, CompositeDescription, and TupleDescription.
|
virtual |
Returns the libNUML type code for the objects contained in this NUMLList (i.e., CompositeDescription objects, if the list is non-empty).
NUML_UNKNOWN
(default).Reimplemented from NUMLList.
Reimplemented in CompositeDescription, and TupleDescription.
|
virtual |
Reimplemented from NMBase.
Reimplemented in AtomicDescription, and CompositeDescription.
|
inlinevirtual |
Returns the libNUML type code for this NUML object.
NUML_UNKNOWN
(default).Reimplemented from NUMLList.
Reimplemented in CompositeDescription, AtomicDescription, and TupleDescription.
|
virtual |
Removes the nth item from this DimensionDescription items and returns a pointer to it.
The caller owns the returned item and is responsible for deleting it.
n | the index of the item to remove |
Reimplemented from NUMLList.
Reimplemented in CompositeDescription.
|
virtual |
Removes item in this DimensionDescription items with the given identifier.
The caller owns the returned item and is responsible for deleting it. If none of the items in this list have the identifier sid
, then NULL
is returned.
sid | the identifier of the item to remove |
|
virtual |
Reimplemented from NMBase.
Reimplemented in AtomicDescription, CompositeDescription, and TupleDescription.
|
virtual |
Reimplemented in CompositeDescription, and AtomicDescription.
|
protectedvirtual |
Subclasses should override this method to write their xmlns attriubutes (if any) to the XMLOutputStream.
Reimplemented from NMBase.
|
protected |
|
protected |