CellML API
cellml_services::CeVAS Interface Reference
cellml_services::CeVAS Interface Reference
Inheritance diagram for cellml_services::CeVAS:
Collaboration diagram for cellml_services::CeVAS:
Public Member Functions | |
| cellml_api::CellMLComponentIterator | iterateRelevantComponents () |
| Creates a (non-live) iterator of components which are relevant to this model. | |
| ConnectedVariableSet | findVariableSet (in cellml_api::CellMLVariable aVariable) |
| Fetches the ConnectedVariableSet that a given variable belongs to. | |
| ConnectedVariableSet | getVariableSet (in unsigned long index) |
| Fetches a variable set by index (order isn't important). | |
 Public Member Functions inherited from XPCOM::IObject | |
| void | add_ref () |
| Called to indicate that some code is keeping an owning reference to the object. | |
| oneway void | release_ref () |
| Removes a reference to an object which was created by some other means (e.g. | |
| IObject | query_interface (in utf8string id) |
| Returns an IObject of the same implementation, which supports a specific interface. | |
Public Attributes | |
| readonly attribute wstring | modelError |
| A description of any connection or interface errors found in the model. | |
| readonly attribute unsigned long | length |
| Fetches a count of the number of disjoint sets of variables. | |
| Public Attributes inherited from XPCOM::IObject | |
| readonly attribute string | objid |
| Fetches the ID of the object. | |
Detailed Description
Member Function Documentation
| ConnectedVariableSet cellml_services::CeVAS::findVariableSet | ( | in cellml_api::CellMLVariable | aVariable | ) |
Fetches the ConnectedVariableSet that a given variable belongs to.
- Parameters
-
aVariable The variable to look for. This variable must be in the model this CeVAS object was created for.
- Returns
- The corresponding ConnectedVariableSet.
| ConnectedVariableSet cellml_services::CeVAS::getVariableSet | ( | in unsigned long | index | ) |
Fetches a variable set by index (order isn't important).
- Parameters
-
index The zero-based index of the variable set.
| cellml_api::CellMLComponentIterator cellml_services::CeVAS::iterateRelevantComponents | ( | ) |
Creates a (non-live) iterator of components which are relevant to this model.
This includes imported components, but not components which are not directly imported and are not included by encapsulation.
- Note
- ImportComponents are never returned, only the actual components from throughout the model which are used.
Member Data Documentation
| readonly attribute unsigned long cellml_services::CeVAS::length |
| readonly attribute wstring cellml_services::CeVAS::modelError |
A description of any connection or interface errors found in the model.
If no error is found, this will be the empty string.
If there is an error, the result of any other operation on this CeVAS object is undefined, and so other operations should not be performed.