CellML API
cellml_services::CellMLValidityError Interface Reference
cellml_services::CellMLValidityError Interface Reference
Represents a specific problem which causes a given document not to be a valid CellML model. More...
Inheritance diagram for cellml_services::CellMLValidityError:
Collaboration diagram for cellml_services::CellMLValidityError:
Public Member Functions | |
| CellMLValidityError | getSupplement (in unsigned long index) |
| Fetches the supplement. | |
 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 | description |
| A human readable description of the problem. | |
| readonly attribute unsigned long | nSupplements |
| The number of supplements we refer to. | |
| readonly attribute boolean | isWarningOnly |
| Determines if the 'error' is strictly speaking not a deviation from the CellML specification, but merely an indication that best practices have not been observed. | |
| Public Attributes inherited from XPCOM::IObject | |
| readonly attribute string | objid |
| Fetches the ID of the object. | |
Detailed Description
Represents a specific problem which causes a given document not to be a valid CellML model.
This interface is also used for supplements, which are extra parts of the validity error which can be used to provide reference to other parts of the model with which the current part is incompatible.
Member Function Documentation
| CellMLValidityError cellml_services::CellMLValidityError::getSupplement | ( | in unsigned long | index | ) |
Fetches the supplement.
- Parameters
-
index The index of the supplement. Indices start at 0 and go up to nSupplements - 1.
Member Data Documentation
| readonly attribute wstring cellml_services::CellMLValidityError::description |
| readonly attribute boolean cellml_services::CellMLValidityError::isWarningOnly |