IVolumeDataContext Struct Reference

Inheritance diagram for IVolumeDataContext:

Public Member Functions
virtual signed int	AskInterface (const BGUID *piid, IRoot **ppr)=0
virtual signed int	DecRef ()=0
virtual signed int	GetHistogram (unsigned int *hist)=0
virtual signed int	GetHistogramEx (unsigned int histLength, unsigned long long *hist)=0
virtual signed int	GetID (signed long long *id)=0
virtual signed int	GetVolumeDataParams (VOLUME_DATA_PARAMS *vdp)=0
virtual signed int	GetVolumeDataParamsEx (VOLUME_DATA_PARAMS *vdp, signed int bUseCached)=0
virtual signed int	IncRef ()=0
virtual signed int	ReleaseSessionResources ()=0
Public Member Functions inherited from IRoot
template<class T >
signed int	AskInterface (T **pp)

Detailed Description

The IVolumeData interface represents a volume data set in memory. This object is created by the various volume data loading functions in IServerContext.

Member Function Documentation

virtual signed int IVolumeDataContext::AskInterface ( const BGUID *  piid, IRoot **  ppr  )

pure virtual

Queries this object to see if the interface piid is supported and returns the result in ppr.

Parameters

piid	The BGUID of the requested interface.
ppr	The address of an IRoot pointer which will receive the new interface.

Returns

S_OK if the interface is supported. E_FAIL if it is not.

Implements IRoot.

virtual signed int IVolumeDataContext::DecRef ( )

pure virtual

Decreases the reference count on this object by 1. If the reference count reaches 0, the object is deallocated.

Implements IRoot.

virtual signed int IVolumeDataContext::GetHistogram ( unsigned int *  hist )

pure virtual

Fills an array with the number of voxels in the dataset with the specified HU+1024 value.

Parameters

hist	Allocated integer array of size 4096 to get results.

Returns

int

virtual signed int IVolumeDataContext::GetID ( signed long long *  id )

pure virtual

Integer that represents the server side object that contains the volume data.

virtual signed int IVolumeDataContext::GetVolumeDataParams ( VOLUME_DATA_PARAMS *  vdp )

pure virtual

Returns information about the volume data in question.

virtual signed int IVolumeDataContext::GetVolumeDataParamsEx ( VOLUME_DATA_PARAMS *  vdp, signed int  bUseCached  )

pure virtual

If bUseCached is H_TRUE, then every call to this function after the first call will return a cached version of the volume's VOLUME_DATA_PARAMS rather than requesting the information from the server.

virtual signed int IVolumeDataContext::IncRef ( )

pure virtual

Increases the reference count on this object by 1. You do not need to call this after an object is first created. It is 1 by default.

Implements IRoot.

virtual signed int IVolumeDataContext::ReleaseSessionResources ( )

pure virtual

Call this function if you wish to free server resources before disconnecting.