{comp}
comp
An interface to be used in composition.
The Port class was introduced by the SBML Level 3 Hierarchical Model Composition (“comp”) package to allow a Model to define a standard interface between it and other models that might use it as a submodel. It derives from the SBaseRef class, and the elements defined there refer to elements in the same parent Model as the Port object. A Port object instance therefore uses those attributes to define a port for a component in a model. When other SBaseRef or SBaseRef-derived classes refer to a Port object using a "portRef" attribute, the element being referenced is the element the Port object itself points to.
In the present formulation of the Hierarchical Model Composition package, the use of ports is not enforced, nor is there any mechanism to restrict which ports may be used in what ways—they are only an advisory construct. Future versions of this SBML package may provide additional functionality to support explicit restrictions on port use. For the present definition of Hierarchical Model Composition, users of models containing ports are encouraged to respect the modeler's intention in defining ports, and use the port definitions to interact with components through their ports (when they have ports defined) rather than interact directly with the components.
The required attribute "id" is used to give an identifier to a Port object so that other objects can refer to it. The attribute has type PortSId and is essentially identical to the SBML primitive type SId, except that its namespace is limited to the identifiers of Port objects defined within a Model object. In parallel, the PortSId type has a companion type, PortSIdRef, that corresponds to the SBML primitive type SIdRef; the value space of PortSIdRef is limited to PortSId values.
- Examples:
- spec_example3.cpp, and spec_example4.cpp.
|
virtual void | clearReferencedElement () |
| Removes the saved referenced element, if it had been saved earlier. More...
|
|
virtual Port * | clone () const |
| Creates and returns a deep copy of this Port object. More...
|
|
SBaseRef * | createSBaseRef () |
| Creates a new, empty SBaseRef, adds it to this SBaseRef and returns the created SBaseRef. More...
|
|
virtual List * | getAllElements (ElementFilter *filter=NULL) |
| Returns a List of all child SBase* objects, including those nested to an arbitrary depth. More...
|
|
virtual SBase * | getElementByMetaId (const std::string &metaid) |
| Returns the first child element it can find with the given metaid , or itself if it has the given metaid , or NULL if no such object is found. More...
|
|
virtual SBase * | getElementBySId (const std::string &id) |
| Returns the first child element found that has the given id in the model-wide SId namespace, or NULL if no such object is found. More...
|
|
virtual const std::string & | getElementName () const |
| Returns the XML element name of this SBML object. More...
|
|
virtual const std::string & | getId () const |
| Returns the value of the "id" attribute of this Port. More...
|
|
virtual const std::string & | getIdRef () const |
| Returns the value of the "idRef" attribute of this SBaseRef. More...
|
|
virtual const std::string & | getMetaIdRef () const |
| Returns the value of the "metaIdRef" attribute of this SBaseRef. More...
|
|
virtual const std::string & | getName () const |
| Returns the value of the "name" attribute of this Port. More...
|
|
virtual int | getNumReferents () const |
| Returns how many elements are being referred to by this SBaseRef. More...
|
|
virtual const std::string & | getPortRef () const |
| Returns the value of the "portRef" attribute of this SBaseRef. More...
|
|
virtual SBase * | getReferencedElement () |
| Returns the object pointed to by this element. More...
|
|
virtual SBase * | getReferencedElementFrom (Model *model) |
| Examines the referenced Model for the referenced object, and returns it, if found. More...
|
|
const SBaseRef * | getSBaseRef () const |
| Get the child sBaseRef of this sBaseRef. More...
|
|
SBaseRef * | getSBaseRef () |
| Get the child sBaseRef of this SBaseRef. More...
|
|
virtual int | getTypeCode () const |
| Returns the libSBML type code of this object instance. More...
|
|
virtual const std::string & | getUnitRef () const |
| Returns the value of the "unitRef" attribute of this SBaseRef. More...
|
|
virtual bool | hasRequiredAttributes () const |
| Returns true if the 'id' attribute is set, and if exactly one of the optional attributes of SBaseRef (portRef, idRef, metaIdRef, and unitRef)are set. More...
|
|
virtual bool | isSetId () const |
| Predicate returning true or false depending on whether this Port's "id" attribute has been set. More...
|
|
virtual bool | isSetIdRef () const |
| Predicate returning true or false depending on whether this SBaseRef's "idRef" attribute has been set. More...
|
|
virtual bool | isSetMetaIdRef () const |
| Predicate returning true or false depending on whether this SBaseRef's "metaIdRef" attribute has been set. More...
|
|
virtual bool | isSetName () const |
| Predicate returning true or false depending on whether this Port's "name" attribute has been set. More...
|
|
virtual bool | isSetPortRef () const |
| Predicate returning true or false depending on whether this SBaseRef's "portRef" attribute has been set. More...
|
|
bool | isSetSBaseRef () const |
| Predicate for testing whether the sBaseRef for this SBaseRef is set. More...
|
|
virtual bool | isSetUnitRef () const |
| Predicate returning true or false depending on whether this SBaseRef's "unitRef" attribute has been set. More...
|
|
Port & | operator= (const Port &source) |
| Assignment operator. More...
|
|
virtual int | performDeletion () |
| DEPRECATED FUNCTION: DO NOT USE. More...
|
|
| Port (unsigned int level=CompExtension::getDefaultLevel(), unsigned int version=CompExtension::getDefaultVersion(), unsigned int pkgVersion=CompExtension::getDefaultPackageVersion()) |
| Creates a new Port with the given level, version, and package version. More...
|
|
| Port (CompPkgNamespaces *compns) |
| Creates a new Port with the given CompPkgNamespaces object. More...
|
|
| Port (const Port &source) |
| Copy constructor. More...
|
|
virtual int | removeFromParentAndDelete () |
| Finds this SBaseRef's parent, which can either be a List or can be another SBaseRef, and tells it to remove this. More...
|
|
virtual void | renameMetaIdRefs (const std::string &oldid, const std::string &newid) |
|
virtual void | renameSIdRefs (const std::string &oldid, const std::string &newid) |
|
virtual void | renameUnitSIdRefs (const std::string &oldid, const std::string &newid) |
|
virtual int | saveReferencedElement () |
| Finds and stores the referenced object by finding its Model parent, calling 'getReferencedElementFrom()' on that model, and storing the result. More...
|
|
virtual int | setId (const std::string &id) |
| Sets the value of the "id" attribute of this Port. More...
|
|
virtual int | setIdRef (const std::string &id) |
| Sets the value of the "idRef" attribute of this SBaseRef. More...
|
|
virtual int | setMetaIdRef (const std::string &id) |
| Sets the value of the "metaIdRef" attribute of this SBaseRef. More...
|
|
virtual int | setName (const std::string &name) |
| Sets the value of the "name" attribute of this Port. More...
|
|
virtual int | setPortRef (const std::string &id) |
| Overrides SBaseRef::setPortRef to always fail, because Port objects themselves cannot refer to model elements by PortSId. More...
|
|
int | setSBaseRef (const SBaseRef *sBaseRef) |
| Sets the sBaseRef definition of this SBaseRef to a copy of the given SBaseRef object instance. More...
|
|
virtual int | setUnitRef (const std::string &id) |
| Sets the value of the "unitRef" attribute of this SBaseRef. More...
|
|
virtual int | unsetId () |
| Unsets the value of the "id" attribute of this Port. More...
|
|
virtual int | unsetIdRef () |
| Unsets the value of the "idRef" attribute of this SBaseRef. More...
|
|
virtual int | unsetMetaIdRef () |
| Unsets the value of the "metaIdRef" attribute of this SBaseRef. More...
|
|
virtual int | unsetName () |
| Unsets the value of the "name" attribute of this Port. More...
|
|
virtual int | unsetPortRef () |
| Unsets the value of the "portRef" attribute of this SBaseRef. More...
|
|
virtual int | unsetSBaseRef () |
| Unsets the child SBaseRef of this SBaseRef. More...
|
|
virtual int | unsetUnitRef () |
| Unsets the value of the "unitRef" attribute of this SBaseRef. More...
|
|
virtual | ~Port () |
| Destructor. More...
|
|