A field returning a single component of a source field as a scalar. More...

#include <fieldcomposite.hpp>

Inheritance diagram for OpenCMISS::Zinc::FieldComponent:

Public Member Functions
	FieldComponent (cmzn_field_component_id field_component_id)

cmzn_field_component_id	getDerivedId ()

int	getComponentIndex ()

int	setComponentIndex (int componentIndex)

Public Member Functions inherited from OpenCMISS::Zinc::Field
	Field (cmzn_field_id field_id)

	Field (const Field &field)

Field &	operator= (const Field &field)

bool	isValid () const

cmzn_field_id	getId () const

bool	isManaged ()

int	setManaged (bool value)

char *	getComponentName (int componentNumber)

int	setComponentName (int componentNumber, const char *name)

double	getCoordinateSystemFocus ()

int	setCoordinateSystemFocus (double focus)

CoordinateSystemType	getCoordinateSystemType ()

int	setCoordinateSystemType (CoordinateSystemType coordinateSystemType)

int	getNumberOfComponents ()

char *	getName ()

int	setName (const char *name)

int	getNumberOfSourceFields ()

Field	getSourceField (int index)

bool	isTypeCoordinate ()

int	setTypeCoordinate (bool value)

ValueType	getValueType ()

Fieldmodule	getFieldmodule () const

int	assignMeshLocation (const Fieldcache &cache, const Element &element, int coordinatesCount, const double *coordinatesIn)

int	assignReal (const Fieldcache &cache, int valuesCount, const double *valuesIn)

int	assignString (const Fieldcache &cache, const char *stringValue)

Element	evaluateMeshLocation (const Fieldcache &cache, int coordinatesCount, double *coordinatesOut)

int	evaluateReal (const Fieldcache &cache, int valuesCount, double *valuesOut)

char *	evaluateString (const Fieldcache &cache)

int	evaluateDerivative (const Differentialoperator&differentialOperator, const Fieldcache &cache, int valuesCount, double *valuesOut)

bool	isDefinedAtLocation (const Fieldcache &cache)

FieldComponent	castComponent ()

FieldElementGroup	castElementGroup ()

FieldFindMeshLocation	castFindMeshLocation ()

FieldFiniteElement	castFiniteElement ()

FieldGroup	castGroup ()

FieldImage	castImage ()

FieldImagefilterBinaryThreshold	castImagefilterBinaryThreshold ()

FieldImagefilterDiscreteGaussian	castImagefilterDiscreteGaussian ()

FieldImagefilterHistogram	castImagefilterHistogram ()

FieldImagefilterThreshold	castImagefilterThreshold ()

FieldNodeGroup	castNodeGroup ()

FieldStoredMeshLocation	castStoredMeshLocation ()

FieldStoredString	castStoredString ()

Additional Inherited Members
Public Types inherited from OpenCMISS::Zinc::Field
enum	ChangeFlag { CHANGE_FLAG_NONE = CMZN_FIELD_CHANGE_FLAG_NONE, CHANGE_FLAG_ADD = CMZN_FIELD_CHANGE_FLAG_ADD, CHANGE_FLAG_REMOVE = CMZN_FIELD_CHANGE_FLAG_REMOVE, CHANGE_FLAG_IDENTIFIER = CMZN_FIELD_CHANGE_FLAG_IDENTIFIER, CHANGE_FLAG_DEFINITION = CMZN_FIELD_CHANGE_FLAG_DEFINITION, CHANGE_FLAG_FULL_RESULT = CMZN_FIELD_CHANGE_FLAG_FULL_RESULT, CHANGE_FLAG_PARTIAL_RESULT = CMZN_FIELD_CHANGE_FLAG_PARTIAL_RESULT, CHANGE_FLAG_RESULT = CMZN_FIELD_CHANGE_FLAG_RESULT, CHANGE_FLAG_FINAL = CMZN_FIELD_CHANGE_FLAG_FINAL }

enum	CoordinateSystemType { COORDINATE_SYSTEM_TYPE_INVALID = CMZN_FIELD_COORDINATE_SYSTEM_TYPE_INVALID, COORDINATE_SYSTEM_TYPE_RECTANGULAR_CARTESIAN = CMZN_FIELD_COORDINATE_SYSTEM_TYPE_RECTANGULAR_CARTESIAN, COORDINATE_SYSTEM_TYPE_CYLINDRICAL_POLAR = CMZN_FIELD_COORDINATE_SYSTEM_TYPE_CYLINDRICAL_POLAR, COORDINATE_SYSTEM_TYPE_SPHERICAL_POLAR = CMZN_FIELD_COORDINATE_SYSTEM_TYPE_SPHERICAL_POLAR, COORDINATE_SYSTEM_TYPE_PROLATE_SPHEROIDAL = CMZN_FIELD_COORDINATE_SYSTEM_TYPE_PROLATE_SPHEROIDAL, COORDINATE_SYSTEM_TYPE_OBLATE_SPHEROIDAL = CMZN_FIELD_COORDINATE_SYSTEM_TYPE_OBLATE_SPHEROIDAL, COORDINATE_SYSTEM_TYPE_FIBRE = CMZN_FIELD_COORDINATE_SYSTEM_TYPE_FIBRE }

enum	DomainType { DOMAIN_TYPE_INVALID = CMZN_FIELD_DOMAIN_TYPE_INVALID, DOMAIN_TYPE_POINT = CMZN_FIELD_DOMAIN_TYPE_POINT, DOMAIN_TYPE_NODES = CMZN_FIELD_DOMAIN_TYPE_NODES, DOMAIN_TYPE_DATAPOINTS = CMZN_FIELD_DOMAIN_TYPE_DATAPOINTS, DOMAIN_TYPE_MESH1D = CMZN_FIELD_DOMAIN_TYPE_MESH1D, DOMAIN_TYPE_MESH2D = CMZN_FIELD_DOMAIN_TYPE_MESH2D, DOMAIN_TYPE_MESH3D = CMZN_FIELD_DOMAIN_TYPE_MESH3D, DOMAIN_TYPE_MESH_HIGHEST_DIMENSION = CMZN_FIELD_DOMAIN_TYPE_MESH_HIGHEST_DIMENSION }

enum	ValueType { VALUE_TYPE_INVALID = CMZN_FIELD_VALUE_TYPE_INVALID, VALUE_TYPE_REAL = CMZN_FIELD_VALUE_TYPE_REAL, VALUE_TYPE_STRING = CMZN_FIELD_VALUE_TYPE_STRING, VALUE_TYPE_MESH_LOCATION = CMZN_FIELD_VALUE_TYPE_MESH_LOCATION }

typedef int	ChangeFlags

typedef int	DomainTypes

Protected Attributes inherited from OpenCMISS::Zinc::Field
cmzn_field_id	id

Detailed Description

A field returning a single component of a source field as a scalar.

Member Function Documentation

int OpenCMISS::Zinc::FieldComponent::getComponentIndex ( )

inline

Get the component number of the source field returned by this field.

Returns: The component number from 1 to number of components, or 0 on error.

cmzn_field_component_id OpenCMISS::Zinc::FieldComponent::getDerivedId ( )

inline

Return the C handle of the derived FieldComponent object.

Returns: C handle of the derived FieldComponent if this objects is valid, 0 otherwise.

int OpenCMISS::Zinc::FieldComponent::setComponentIndex ( int componentIndex )

inline

Modify the field to return the component with the given index of the source field.

Returns: Status OpenCMISS::Zinc::OK if component index is successfully set, any other value on failure.

The documentation for this class was generated from the following file:

cpp/fieldcomposite.hpp

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation