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

Returns the label for a data point identified by a given global number. More...

Private Member Functions

subroutine cmfe_datapoints_labelgetcnumber (regionUserNumber, dataPointGlobalNumber, label, err)
 Returns the character label for a data point in a set of data points identified by user number. More...
 
subroutine cmfe_datapoints_labelgetcobj (dataPoints, dataPointGlobalNumber, label, err)
 Returns the character label for a data point in a set of data points identified by an object. More...
 
subroutine cmfe_datapoints_labelgetvsnumber (regionUserNumber, dataPointGlobalNumber, label, err)
 Returns the varying string label for a data point in a set of data points identified by user number. More...
 
subroutine cmfe_datapoints_labelgetvsobj (dataPoints, dataPointGlobalNumber, label, err)
 Returns the varying string label for a data point in a set of data points identified by an object. More...
 

Detailed Description

Returns the label for a data point identified by a given global number.

Todo:
should this be a user number?

Definition at line 1713 of file opencmiss_iron.f90.

Member Function/Subroutine Documentation

subroutine opencmiss_iron::cmfe_datapoints_labelget::cmfe_datapoints_labelgetcnumber ( integer(intg), intent(in)  regionUserNumber,
integer(intg), intent(in)  dataPointGlobalNumber,
character(len=*), intent(out)  label,
integer(intg), intent(out)  err 
)
private

Returns the character label for a data point in a set of data points identified by user number.

Parameters
[in]regionusernumberThe user number of the region containing the data points to get the label for.
[in]datapointglobalnumberThe global number of the data points to get the label for.
[out]labelOn return, the label for the data point.
[out]errThe error code.

Definition at line 19473 of file opencmiss_iron.f90.

subroutine opencmiss_iron::cmfe_datapoints_labelget::cmfe_datapoints_labelgetcobj ( type(cmfe_datapointstype), intent(in)  dataPoints,
integer(intg), intent(in)  dataPointGlobalNumber,
character(len=*), intent(out)  label,
integer(intg), intent(out)  err 
)
private

Returns the character label for a data point in a set of data points identified by an object.

Parameters
[in]datapointsThe data points to get the label for.
[in]datapointglobalnumberThe global number of the data points to get the label for.
[out]labelOn return, the label for the data point.
[out]errThe error code.

Definition at line 19513 of file opencmiss_iron.f90.

subroutine opencmiss_iron::cmfe_datapoints_labelget::cmfe_datapoints_labelgetvsnumber ( integer(intg), intent(in)  regionUserNumber,
integer(intg), intent(in)  dataPointGlobalNumber,
type(varying_string), intent(out)  label,
integer(intg), intent(out)  err 
)
private

Returns the varying string label for a data point in a set of data points identified by user number.

Parameters
[in]regionusernumberThe user number of the region containing the data points to get the label for.
[in]datapointglobalnumberThe global number of the data points to get the label for.
[out]labelOn return, the label for the data point.
[out]errThe error code.

Definition at line 19540 of file opencmiss_iron.f90.

subroutine opencmiss_iron::cmfe_datapoints_labelget::cmfe_datapoints_labelgetvsobj ( type(cmfe_datapointstype), intent(in)  dataPoints,
integer(intg), intent(in)  dataPointGlobalNumber,
type(varying_string), intent(out)  label,
integer(intg), intent(out)  err 
)
private

Returns the varying string label for a data point in a set of data points identified by an object.

Parameters
[in]datapointsThe data points to get the label for.
[in]datapointglobalnumberThe global number of the data points to get the label for.
[out]labelOn return, the label for the data point.
[out]errThe error code.

Definition at line 19580 of file opencmiss_iron.f90.