VolumeSet Class Reference

#include <lib_volumeset.h>

Inheritance diagram for VolumeSet:

Detailed Description

The volume group class of type Ovolumeset. A volume group is a container for multiple volume objects. The .vdb file format exporter will store all volumes in the volumegroup into a single file.

Note

Has to be created with Alloc() and destroyed with Free(). Use AutoAlloc to automate the allocation and destruction based on scope.

Private Member Functions
	VolumeSet ()
	~VolumeSet ()

Alloc/Free
static VolumeSet *	Alloc ()
static void	Free (VolumeSet *&p)

Operations
void	AddVolume (VolumeObject *volumeObj)
Bool	DetachVolume (VolumeObject *volumeObj)
Bool	DetachVolumeAtIndex (Int32 index)
VolumeObject *	GetVolumeAtIndex (Int32 index) const
Bool	GetActiveAtIndex (Int32 index) const

Constructor & Destructor Documentation

VolumeSet()

VolumeSet ( )

private

~VolumeSet()

~VolumeSet ( )

private

Member Function Documentation

Alloc()

static VolumeSet* Alloc ( )

static

Allocates a VolumeSet object. Destroy the allocated VolumeSet object with Free(). Use AutoAlloc to automate the allocation and destruction based on scope.

Returns

The allocated VolumeSet object, or nullptr if the allocation failed.

Free()

static void Free ( VolumeSet *&  p )

static

Destructs VolumeSet objects allocated with Alloc(). Use AutoAlloc to automate the allocation and destruction based on scope.

Parameters

[in]

p

The VolumeSet object to destruct. If the pointer is nullptr nothing happens. The pointer is assigned nullptr afterwards.

AddVolume()

void AddVolume

(

VolumeObject *

volumeObj

)

Adds a volume to this group.

Parameters

[in]

volumeObj

The volume object that should be added to the group.

DetachVolume()

Bool DetachVolume

(

VolumeObject *

volumeObj

)

Detaches a volume from this group and moves it into the object system.

Parameters

[in]

volumeObj

The volume object that should be detached to the group.

Returns

True if the volume was found in the group and detached.

DetachVolumeAtIndex()

Bool DetachVolumeAtIndex

(

Int32

index

)

Detaches a volume from this group and moves it into the object system.

Parameters

[in]

index

The index of the volume object that should be detached to the group.

Returns

True if the index was whithin the bounds of the group if the volume was sucessfully detached from the group.

GetVolumeAtIndex()

VolumeObject* GetVolumeAtIndex

(

Int32

index

)

const

Returns the volume object in this group at a specified index.

Parameters

[in]

index

The index to get the volume at.

Returns

The volume object at the index. Nullptr if there is none at the index.

GetActiveAtIndex()

Bool GetActiveAtIndex

(

Int32

index

)

const

Returns if the volume at the specified index is active or not.

Parameters

[in]

index

The index to get the activation state at.

Returns

True if the volume at that index is active. False otherwise.