A description of a resource for reading from or writing to. More...

#include <stream.hpp>

Inheritance diagram for OpenCMISS::Zinc::Streamresource:

Public Member Functions
	Streamresource (cmzn_streamresource_id in_streamresource_id)

	Streamresource (const Streamresource &streamResource)

Streamresource &	operator= (const Streamresource &streamResource)

bool	isValid () const

cmzn_streamresource_id	getId () const

StreamresourceFile	castFile ()

StreamresourceMemory	castMemory ()

Detailed Description

A description of a resource for reading from or writing to.

A description of a resource for reading from or writing to, such as a file or memory buffer. These are created through the stream information object.

See also: Streaminformation; StreamresourceFile; StreamresourceMemory; Streaminformation::createStreamresourceFile; Streaminformation::createStreamresourceMemory; Streaminformation::createStreamresourceMemory_buffer; Streaminformation::createStreamresourceMemory_buffer_copy

Member Function Documentation

StreamresourceFile OpenCMISS::Zinc::Streamresource::castFile ( )

inline

If the stream resource is of file type, then this function returns the derived file stream resource handle.

Returns: Handle to derived file stream resource, or NULL/invalid handle if wrong type or failed.

StreamresourceMemory OpenCMISS::Zinc::Streamresource::castMemory ( )

inline

If the stream resource is of memory type, then this function returns the derived memory stream resource handle.

See also: StreamresourceMemory::getBuffer; StreamresourceMemory::getBuffer_copy

Returns: Handle to derived memory stream resource, or NULL/invalid handle if wrong type or failed.

cmzn_streamresource_id OpenCMISS::Zinc::Streamresource::getId ( ) const

inline

Return the C handle of the Streamresource object.

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

inline

Check if this is a valid Streamresource object.

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