libNuML 1.1.1
Library for reading / writing NuML documents
|
This class stores the atomic values. More...
#include <AtomicValue.h>
Public Member Functions | |
AtomicValue (unsigned int level, unsigned int version) | |
Creates an new AtomicValue using the given NUML level and version values. | |
AtomicValue (NUMLNamespaces *numlns) | |
Creates a new AtomicValue using the given NUMLNamespaces object numlns . | |
virtual bool | accept (NUMLVisitor &v) const |
Accepts the given NUMLVisitor for this instance of AtomicValue. | |
virtual NUMLTypeCode_t | getTypeCode () const |
Returns the libNUML type code for this NUML object. | |
virtual const std::string & | getElementName () const |
Returns the XML element name of this object, which for AtomicValue, is always "atomicValue" . | |
virtual const std::string & | getValue () const |
Returns the character value in this object. | |
virtual double | getDoubleValue () |
Returns the double value of the character value in this object. | |
int | setValue (const std::string &value) |
Sets the value of the "value" attribute of this NUML object. | |
void | writeChars (LIBSBML_CPP_NAMESPACE_QUALIFIER XMLOutputStream &stream) const |
Creates and returns a deep copy of this AtomicValue. | |
virtual AtomicValue * | clone () const |
Subclasses should override this method to write out their contained NUML objects as XML elements. | |
AtomicValue () | |
virtual | ~AtomicValue () |
![]() | |
Dimension () | |
Dimension (unsigned int level, unsigned int version) | |
Creates an new Dimension using the given NUML level and version values. | |
Dimension (NUMLNamespaces *numlns) | |
Creates a new Dimension using the given NUMLNamespaces object numlns . | |
CompositeValue * | createCompositeValue () |
Creates a new CompositeValue and add it to Dimension's list inside this ResultComponent and return it. | |
Tuple * | createTuple () |
creates a new tuple and adds it to the dimension | |
AtomicValue * | createAtomicValue () |
creates a new atomic value and adds it to the dimension | |
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). | |
virtual Dimension * | get (unsigned int n) |
Get a CompositeValue from the Dimension. | |
virtual const Dimension * | get (unsigned int n) const |
Get a CompositeValue from the Dimension. | |
virtual CompositeValue * | get (const std::string &sid) |
Get a CompositeValue from the Dimension based on its identifier. | |
virtual const CompositeValue * | get (const std::string &sid) const |
Get a CompositeValue from the Dimension based on its identifier. | |
virtual Dimension * | remove (unsigned int n) |
Removes the nth item from this Dimension items and returns a pointer to it. | |
virtual Dimension * | remove (const std::string &sid) |
Removes item in this Dimension items with the given identifier. | |
virtual int | getElementPosition () const |
Get the ordinal position of this element in the containing object (which in this case is the Model object). | |
virtual | ~Dimension () |
Subclasses should override this method to write out their contained NUML objects as XML elements. | |
![]() | |
NUMLList (unsigned int level, unsigned int version) | |
Creates a new NUMLList using the given NUML level and version values. | |
NUMLList (NUMLNamespaces *numlns) | |
Creates a new DimensionDescription using the given NUMLNamespaces object numlns . | |
NUMLList () | |
virtual | ~NUMLList () |
NUMLList (const NUMLList &orig) | |
Copy constructor. | |
NUMLList & | operator= (const NUMLList &rhs) |
Assignment operator for NUMLList. | |
void | append (const NMBase *item) |
Adds item to the end of this NUMLList. | |
void | appendAndOwn (NMBase *item) |
Adds item to the end of this NUMLList. | |
void | clear (bool doDelete=true) |
Removes all items in this NUMLList object. | |
unsigned int | size () const |
Get the size of this NUMLList. | |
virtual void | setNUMLDocument (NUMLDocument *d) |
Sets the parent NUMLDocument of this NUML object. | |
virtual void | setParentNUMLObject (NMBase *sb) |
Sets the parent NUML object of this NUML object. | |
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. | |
![]() | |
virtual | ~NMBase () |
Destroy this object. | |
NMBase & | operator= (const NMBase &orig) |
Assignment operator for NMBase. | |
const std::string & | getMetaId () const |
Returns the value of the "metaid" attribute of this object. | |
std::string & | getMetaId () |
Returns the value of the "metaid" attribute of this object. | |
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. | |
const NUMLDocument * | getNUMLDocument () const |
Returns the parent NUMLDocument object. | |
NUMLDocument * | getNUMLDocument () |
Returns the parent NUMLDocument object. | |
NMBase * | getParentNUMLObject () |
Returns the parent NUML object. | |
NMBase * | getAncestorOfType (NUMLTypeCode_t type) |
Returns the ancestor NUML object that corresponds to the given NUMLTypeCode_t. | |
unsigned int | getLine () const |
Returns the line number on which this object first appears in the XML representation of the NUML document. | |
unsigned int | getColumn () const |
Returns the column number on which this object first appears in the XML representation of the NUML document. | |
bool | isSetMetaId () const |
Predicate returning true or false depending on whether this object's "metaid" attribute has been set. | |
bool | isSetName () const |
int | setMetaId (const std::string &metaid) |
Sets the value of the "metaid" attribute of this object. | |
virtual int | setId (const std::string &sid) |
int | setNamespaces (LIBSBML_CPP_NAMESPACE_QUALIFIER XMLNamespaces *xmlns) |
Sets the namespaces relevant of this NUML object. | |
int | unsetMetaId () |
Unsets the value of the "metaid" attribute of this NUML object. | |
unsigned int | getLevel () const |
Returns the NUML Level of the overall NUML document. | |
unsigned int | getVersion () const |
Returns the Version within the NUML Level of the overall NUML document. | |
bool | hasValidLevelVersionNamespaceCombination () |
Predicate returning true or false depending on whether this object's level/version and namespace values correspond to a valid NUML specification. | |
char * | toNUML () |
Returns a string that consists of the partial NUML describing this object. | |
void | read (LIBSBML_CPP_NAMESPACE_QUALIFIER XMLInputStream &stream) |
Reads (initializes) this NUML object by reading from XMLInputStream. | |
void | write (LIBSBML_CPP_NAMESPACE_QUALIFIER XMLOutputStream &stream) const |
Writes (serializes) this NUML object by writing it to XMLOutputStream. | |
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 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 ¬es, bool addXHTMLMarkup=false) |
int | appendNotes (const LIBSBML_CPP_NAMESPACE_QUALIFIER XMLNode *notes) |
int | appendNotes (const std::string ¬es) |
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 void | readAttributes (const LIBSBML_CPP_NAMESPACE_QUALIFIER XMLAttributes &attributes) |
Subclasses should override this method to create, store, and then return an NUML object corresponding to the next XMLToken in the XMLInputStream. | |
virtual void | writeAttributes (LIBSBML_CPP_NAMESPACE_QUALIFIER XMLOutputStream &stream) const |
Subclasses should override this method to write their XML attributes to the XMLOutputStream. | |
![]() | |
virtual NMBase * | createObject (LIBSBML_CPP_NAMESPACE_QUALIFIER XMLInputStream &stream) |
void | setType (DimensionType type) |
Sets type of this Dimension. | |
![]() | |
![]() | |
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. | |
NMBase (const std::string &id="", const std::string &name="") | |
Only subclasses may create NMBase objects. | |
NMBase (unsigned int level, unsigned int version) | |
Creates a new NMBase object with the given sboTerm. | |
NMBase (NUMLNamespaces *numlns) | |
Creates a new NMBase object with the given NUMLNamespaces. | |
NMBase (const NMBase &orig) | |
Copy constructor. | |
virtual bool | readOtherXML (LIBSBML_CPP_NAMESPACE_QUALIFIER XMLInputStream &stream) |
Subclasses should override this method to read (and store) XHTML, MathML, etc. | |
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. | |
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. | |
void | logUnknownElement (const std::string element, const unsigned int level, const unsigned int version) |
Helper to log a common type of error. | |
void | logEmptyString (std::string attribute, const unsigned int level, const unsigned int version, std::string element) |
Helper to log a common type of error. | |
void | checkOrderAndLogError (NMBase *object, int expected) |
Checks that NUML element has been read in the proper order. | |
void | checkNUMLListPopulated (NMBase *object) |
Checks that an NUML NUMLList element has been populated. | |
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. | |
void | checkXHTML (const LIBSBML_CPP_NAMESPACE_QUALIFIER XMLNode *) |
Checks that the XHTML is valid. | |
void | checkAnnotation () |
Checks the annotation does not declare an numl namespace. | |
Protected Attributes | |
std::string | mValue |
![]() | |
DimensionType | mType |
![]() | |
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 |
Additional Inherited Members | |
![]() | |
enum | DimensionType { Unknown , CompositeValueType , TupleType , AtomicValueType } |
This class stores the atomic values.
LIBNUML_CPP_NAMESPACE_BEGIN AtomicValue::AtomicValue | ( | unsigned int | level, |
unsigned int | version ) |
Creates an new AtomicValue using the given NUML level
and version
values.
level | an unsigned int, the NUML Level to assign to this AtomicValue |
version | an unsigned int, the NUML Version to assign to this AtomicValue |
level
, version
for the document override those used to create the AtomicValue. 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. AtomicValue::AtomicValue | ( | NUMLNamespaces * | numlns | ) |
Creates a new AtomicValue 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.
It is worth emphasizing that although this constructor does not take an identifier argument, in NUML Level 2 and beyond, the "id" (identifier) attribute of an AtomicValue is required to have a value. Thus, callers are cautioned to assign a value after calling this constructor. Setting the identifier can be accomplished using the method
numlns | an NUMLNamespaces object. |
level
, version
and xmlns
namespaces for the document override those used to create the AtomicValue. 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. AtomicValue::AtomicValue | ( | ) |
|
virtual |
|
virtual |
Accepts the given NUMLVisitor for this instance of AtomicValue.
v | the NUMLVisitor instance to be used. |
v.visit()
. Reimplemented from Dimension.
|
virtual |
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. For example:
Reimplemented from Dimension.
|
virtual |
Returns the double value of the character value in this object.
|
virtual |
Returns the XML element name of this object, which for AtomicValue, is always "atomicValue"
.
"atomicValue"
. Reimplemented from Dimension.
|
virtual |
Returns the libNUML type code for this NUML object.
NUML_UNKNOWN
(default).Reimplemented from Dimension.
|
virtual |
Returns the character value in this object.
|
protectedvirtual |
Subclasses should override this method to create, store, and then return an NUML object corresponding to the next XMLToken in the XMLInputStream.
Reimplemented from NUMLList.
int AtomicValue::setValue | ( | const std::string & | value | ) |
Sets the value of the "value" attribute of this NUML object.
The string in value
is copied.
value | the new value for the object |
|
protectedvirtual |
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. For example:
NMBase::writeAttributes(stream); stream.writeAttribute( "id" , mId ); stream.writeAttribute( "name", mName ); ...
Reimplemented from NUMLList.
void AtomicValue::writeChars | ( | LIBSBML_CPP_NAMESPACE_QUALIFIER XMLOutputStream & | stream | ) | const |
Creates and returns a deep copy of this AtomicValue.
|
protected |