OpenCMISS-Iron FORTRAN API Documentation
opencmiss_iron::cmfe_cellml_fieldcomponentget Interface Reference

Returns the component for a given CellML field that corresponds to the specified CellML variable ID. More...

Private Member Functions

subroutine cmfe_cellml_fieldcomponentgetnumberc (regionUserNumber, CellMLUserNumber, CellMLModelUserNumber, CellMLFieldType, variableID, fieldComponent, err)
 Returns the field component number that corresponds to a character string VariableID for a CellML environment identified by a user number. More...
 
subroutine cmfe_cellml_fieldcomponentgetobjc (CellML, CellMLModelUserNumber, CellMLFieldType, variableID, fieldComponent, err)
 Returns the field component number that corresponds to a character string variable ID for a CellML environment identified by an object. More...
 
subroutine cmfe_cellml_fieldcomponentgetnumbervs (regionUserNumber, CellMLUserNumber, CellMLModelUserNumber, CellMLFieldType, variableID, fieldComponent, err)
 Returns the field component number that corresponds to a varying string variable ID for a CellML environment identified by a user number. More...
 
subroutine cmfe_cellml_fieldcomponentgetobjvs (CellML, CellMLModelUserNumber, CellMLFieldType, variableID, fieldComponent, err)
 Returns the field component number that corresponds to a varying string variable ID for a CellML environment identified by an object. More...
 

Detailed Description

Returns the component for a given CellML field that corresponds to the specified CellML variable ID.

Definition at line 1159 of file opencmiss_iron.f90.

Member Function/Subroutine Documentation

subroutine opencmiss_iron::cmfe_cellml_fieldcomponentget::cmfe_cellml_fieldcomponentgetnumberc ( integer(intg), intent(in)  regionUserNumber,
integer(intg), intent(in)  CellMLUserNumber,
integer(intg), intent(in)  CellMLModelUserNumber,
integer(intg), intent(in)  CellMLFieldType,
character(len=*), intent(in)  variableID,
integer(intg), intent(out)  fieldComponent,
integer(intg), intent(out)  err 
)
private

Returns the field component number that corresponds to a character string VariableID for a CellML environment identified by a user number.

Parameters
[in]regionusernumberThe user number of the region containing the CellML environment.
[in]cellmlusernumberThe user number of the CellML enviroment to get the field component for.
[in]cellmlmodelusernumberThe user number of the CellML model to map fom.
[in]cellmlfieldtypeThe type of CellML field to get the component for.
See also
OPENCMISS::CellML::FieldTypes,OPENCMISS
Parameters
[in]variableidThe variable ID to get the corresponding field component for.
[out]fieldcomponentOn return, the field component corresponding to the ID.
[out]errThe error code.

Definition at line 15055 of file opencmiss_iron.f90.

subroutine opencmiss_iron::cmfe_cellml_fieldcomponentget::cmfe_cellml_fieldcomponentgetnumbervs ( integer(intg), intent(in)  regionUserNumber,
integer(intg), intent(in)  CellMLUserNumber,
integer(intg), intent(in)  CellMLModelUserNumber,
integer(intg), intent(in)  CellMLFieldType,
type(varying_string), intent(in)  variableID,
integer(intg), intent(out)  fieldComponent,
integer(intg), intent(out)  err 
)
private

Returns the field component number that corresponds to a varying string variable ID for a CellML environment identified by a user number.

Parameters
[in]regionusernumberThe user number of the region containing the CellML environment.
[in]cellmlusernumberThe user number of the CellML enviroment to get the field component for.
[in]cellmlmodelusernumberThe user number of the CellML model to map from.
[in]cellmlfieldtypeThe type of CellML field to get the component for.
See also
OPENCMISS::CellML::FieldTypes,OPENCMISS
Parameters
[in]variableidThe ID to get the corresponding field component for.
[out]fieldcomponentOn return, the field component corresponding to the ID.
[out]errThe error code.

Definition at line 15135 of file opencmiss_iron.f90.

subroutine opencmiss_iron::cmfe_cellml_fieldcomponentget::cmfe_cellml_fieldcomponentgetobjc ( type(cmfe_cellmltype), intent(inout)  CellML,
integer(intg), intent(in)  CellMLModelUserNumber,
integer(intg), intent(in)  CellMLFieldType,
character(len=*), intent(in)  variableID,
integer(intg), intent(out)  fieldComponent,
integer(intg), intent(out)  err 
)
private

Returns the field component number that corresponds to a character string variable ID for a CellML environment identified by an object.

Parameters
[in,out]cellmlThe CellML environment to get the field component for.
[in]cellmlmodelusernumberThe user number of the CellML model to map from.
[in]cellmlfieldtypeThe type of CellML field to get the component for.
See also
OPENCMISS::CellML::FieldTypes,OPENCMISS
Parameters
[in]variableidThe ID to get the corresponding field component for.
[out]fieldcomponentOn return, the field component corresponding to the ID.
[out]errThe error code.

Definition at line 15105 of file opencmiss_iron.f90.

subroutine opencmiss_iron::cmfe_cellml_fieldcomponentget::cmfe_cellml_fieldcomponentgetobjvs ( type(cmfe_cellmltype), intent(inout)  CellML,
integer(intg), intent(in)  CellMLModelUserNumber,
integer(intg), intent(in)  CellMLFieldType,
type(varying_string), intent(in)  variableID,
integer(intg), intent(out)  fieldComponent,
integer(intg), intent(out)  err 
)
private

Returns the field component number that corresponds to a varying string variable ID for a CellML environment identified by an object.

Parameters
[in,out]cellmlThe CellML environment to get the field component for.
[in]cellmlmodelusernumberThe user number of the CellML model to map from.
[in]cellmlfieldtypeThe type of CellML field to get the component for.
See also
OPENCMISS::CellML::FieldTypes,OPENCMISS
Parameters
[in]variableidThe ID to get the corresponding field component for.
[out]fieldcomponentOn return, the field component corresponding to the ID.
[out]errThe error code.

Definition at line 15184 of file opencmiss_iron.f90.