CellML API
cellml_services::CellMLValidityErrorSet Interface Reference
cellml_services::CellMLValidityErrorSet Interface Reference
A list of CellML validity errors. More...
Inheritance diagram for cellml_services::CellMLValidityErrorSet:
Collaboration diagram for cellml_services::CellMLValidityErrorSet:
Public Member Functions | |
| CellMLValidityError | getValidityError (in unsigned long index) raises (cellml_api::CellMLException) |
| Fetches a particular validity error. | |
 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 unsigned long | nValidityErrors |
| The number of validity errors in this set. | |
| Public Attributes inherited from XPCOM::IObject | |
| readonly attribute string | objid |
| Fetches the ID of the object. | |
Detailed Description
A list of CellML validity errors.
The list is ordered. The exact order is not defined by the API specification, but it should be a sensible order for a human user who visits and attempts to correct errors starting at index 0 and moving through each index sequentially.
Member Function Documentation
| CellMLValidityError cellml_services::CellMLValidityErrorSet::getValidityError | ( | in unsigned long | index | ) | raises (cellml_api::CellMLException) |
Fetches a particular validity error.
- Parameters
-
index The index of the validity error. Indices start at 0 and go up to nValidityErrors-1. CellMLException if the index is invalid.