A region-specific stream information object. More...

#include <streamregion.hpp>

Inheritance diagram for OpenCMISS::Zinc::StreaminformationRegion:

Public Types
enum	Attribute { ATTRIBUTE_INVALID = CMZN_STREAMINFORMATION_REGION_ATTRIBUTE_INVALID, ATTRIBUTE_TIME = CMZN_STREAMINFORMATION_REGION_ATTRIBUTE_TIME }

Public Types inherited from OpenCMISS::Zinc::Streaminformation
enum	DataCompressionType { DATA_COMPRESSION_TYPE_INVALID = CMZN_STREAMINFORMATION_DATA_COMPRESSION_TYPE_INVALID, DATA_COMPRESSION_TYPE_DEFAULT = CMZN_STREAMINFORMATION_DATA_COMPRESSION_TYPE_DEFAULT, DATA_COMPRESSION_TYPE_NONE = CMZN_STREAMINFORMATION_DATA_COMPRESSION_TYPE_NONE, DATA_COMPRESSION_TYPE_GZIP = CMZN_STREAMINFORMATION_DATA_COMPRESSION_TYPE_GZIP, DATA_COMPRESSION_TYPE_BZ2 = CMZN_STREAMINFORMATION_DATA_COMPRESSION_TYPE_BZIP2 }

Public Member Functions
	StreaminformationRegion (cmzn_streaminformation_region_id streaminformation_region_id)

bool	isValid () const

cmzn_streaminformation_region_id	getId () const

int	hasAttribute (Attribute attribute)

double	getAttributeReal (Attribute attribute)

int	setAttributeReal (Attribute attribute, double value)

int	hasResourceAttribute (const Streamresource &resource, Attribute attribute)

double	getResourceAttributeReal (const Streamresource &resource, Attribute attribute)

int	setResourceAttributeReal (const Streamresource &resource, Attribute attribute, double value)

Field::DomainTypes	getResourceDomainTypes (const Streamresource &resource)

int	setResourceDomainTypes (const Streamresource &resource, Field::DomainTypes domainTypes)

Public Member Functions inherited from OpenCMISS::Zinc::Streaminformation
	Streaminformation (cmzn_streaminformation_id in_streaminformation_id)

	Streaminformation (const Streaminformation &streamInformation)

Streaminformation &	operator= (const Streaminformation &streamInformation)

bool	isValid () const

cmzn_streaminformation_id	getId () const

StreamresourceFile	createStreamresourceFile (const char *file_name)

StreamresourceMemory	createStreamresourceMemory ()

StreamresourceMemory	createStreamresourceMemoryBuffer (const void *buffer, unsigned int buffer_length)

enum DataCompressionType	getResourceDataCompressionType (const Streamresource &resource)

int	setResourceDataCompressionType (const Streamresource &resource, DataCompressionType dataCompressionType)

enum DataCompressionType	getDataCompressionType ()

int	setDataCompressionType (DataCompressionType dataCompressionType)

StreaminformationImage	castImage ()

StreaminformationRegion	castRegion ()

Additional Inherited Members
Protected Attributes inherited from OpenCMISS::Zinc::Streaminformation
cmzn_streaminformation_id	id

Detailed Description

A region-specific stream information object.

A region-specific stream information object, used to specify one or more model files/resources for a region to read from or write to, with attributes specified for them either globally or per-resource.

See Also: Region::createStreaminformationRegion

Member Enumeration Documentation

enum OpenCMISS::Zinc::StreaminformationRegion::Attribute

Enumeration of attributes that can be set by generic stream information region methods.

Enumerator
ATTRIBUTE_INVALID	Unspecified attribute
ATTRIBUTE_TIME	Attribute used to specify at what time the stream resource(s) to be reading in or writing to.

Member Function Documentation

double OpenCMISS::Zinc::StreaminformationRegion::getAttributeReal ( Attribute attribute )

inline

Get a real value of an attribute of streaminformation.

Parameters

attribute The identifier of the real attribute to get.

Returns: Value of the attribute.

cmzn_streaminformation_region_id OpenCMISS::Zinc::StreaminformationRegion::getId ( ) const

inline

Return the C handle of the StreaminformationRegion object.

Returns: C handle of StreaminformationRegion if this objects is valid, 0 otherwise.

double OpenCMISS::Zinc::StreaminformationRegion::getResourceAttributeReal	(	const Streamresource &	resource,
		Attribute	attribute
	)

inline

Get a real value of an attribute of a stream in streaminformation.

Parameters

resource	Handle to the stream resource.
attribute	The identifier of the real attribute to get.

Returns: Value of the attribute.

Field::DomainTypes OpenCMISS::Zinc::StreaminformationRegion::getResourceDomainTypes ( const Streamresource & resource )

inline

Get the specified domain types for a stream resource in streaminformation.

Parameters

resource Handle to the stream resource.

Returns: Bitmasks for specified domain types for stream resource, CMZN_FIELD_DOMAIN_TYPE_INVALID if failed or unset

int OpenCMISS::Zinc::StreaminformationRegion::hasAttribute ( Attribute attribute )

inline

Check either an attribute of streaminformation has been set or not.

Parameters

attribute The identifier of the real attribute to get.

Returns: 1 if attribute has been set.

int OpenCMISS::Zinc::StreaminformationRegion::hasResourceAttribute	(	const Streamresource &	resource,
		Attribute	attribute
	)

inline

Check either an attribute of a stream in streaminformation has been set or not.

Parameters

resource	Handle to the stream resource.
attribute	The identifier of the real attribute to get.

Returns: 1 if attribute has been set.

bool OpenCMISS::Zinc::StreaminformationRegion::isValid ( ) const

inline

Check if this is a valid StreaminformationRegion object.

Returns: Status True if object is valid, false otherwise.

int OpenCMISS::Zinc::StreaminformationRegion::setAttributeReal	(	Attribute	attribute,
		double	value
	)

inline

Set a double attribute of the region stream information valid for all resources unless overridden for individual resources.

Parameters

attribute	The identifier of the double attribute to set.
value	The new value for the attribute.

Returns: status OpenCMISS::Zinc::OK if attribute successfully set, any other value if failed or attribute not valid or unable to be set for this cmzn_streaminformation_region.

int OpenCMISS::Zinc::StreaminformationRegion::setResourceAttributeReal	(	const Streamresource &	resource,
		Attribute	attribute,
		double	value
	)

inline

Set a double attribute for a resource in the region stream information.

Parameters

resource	Handle to the stream resource.
attribute	The identifier of the double attribute to set.
value	The new value for the attribute.

Returns: status OpenCMISS::Zinc::OK if attribute successfully set, any other value if failed or attribute not valid or unable to be set for this cmzn_streaminformation_region.

int OpenCMISS::Zinc::StreaminformationRegion::setResourceDomainTypes	(	const Streamresource &	resource,
		Field::DomainTypes	domainTypes
	)

inline

Set the domain types to be exported from the region this stream information is created in. The current default setting will output all domain types in region. On import, the domain type also specifies nodesets without a specified domain type in exformat file to be imported as nodes or datapoints domain. If unset, unspecified nodesets will be imported as nodes.

Parameters

resource Handle to the stream resource.

domainTypes Bitmasks for the domain type to be set for output. It currently supports the following domains: CMZN_FIELD_DOMAIN_TYPE_POINT - Only output the region name if this is the only bit set CMZN_FIELD_DOMAIN_TYPE_NODES - Enable output of nodes CMZN_FIELD_DOMAIN_TYPE_DATAPOINTS - Enable output of datapoints CMZN_FIELD_DOMAIN_TYPE_MESH1D - Enable output of 1D mesh CMZN_FIELD_DOMAIN_TYPE_MESH2D - Enable output of 2D mesh CMZN_FIELD_DOMAIN_TYPE_MESH3D - Enable output of 3D mesh CMZN_FIELD_DOMAIN_TYPE_MESH_HIGHEST_DIMENSION - Enable output of mesh with highest dimension possible

Returns: status OpenCMISS::Zinc::OK if domain types successfully set, any other value if failed or domain type not valid or unable to be set for this cmzn_streaminformation_region.

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

auto_comments_output/streamregion.hpp

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Member Function Documentation