ICape Reaction ChemistryGet Stoichiometric Coefficients Method
Get the stoichiometry of the specified reaction.
Definition
Namespace: CapeOpen
Assembly: CapeOpen (in CapeOpen.dll) Version: 1.0.0.0 (1.0.0.0)
The stoichiometry of the specified reaction.
Assembly: CapeOpen (in CapeOpen.dll) Version: 1.0.0.0 (1.0.0.0)
C#
[DispIdAttribute(6)]
Object GetStoichiometricCoefficients(
string reacId
)VB
<DispIdAttribute(6)>
Function GetStoichiometricCoefficients (
reacId As String
) As ObjectParameters
- reacId String
- The name of the reaction obtained from the GetReactionsIds method.
Return Value
ObjectThe stoichiometry of the specified reaction.
Remarks
Returns the stoichiometric coefficients of the specified reaction (positive
numbers indicate products, negative numbers indicate reactants). Stoichiometric
coefficients are ordered consistently with the list of compounds returned by
the GetReactionCompoundIds(String, Object, Object, Object) method for the same reaction.
Exceptions
| ECapeUnknown | The error to be raised when other error(s), specified for this operation, are not suitable. |
| ECapeInvalidArgument | The error to be raised when other error(s), specified for this operation, are not suitable. |
| ECapeFailedInitialisation | The error to be raised when other error(s), specified for this operation, are not suitable. |
| ECapeNoImpl | The error to be raised when other error(s), specified for this operation, are not suitable. |