VxSdk::IVxDataStorage Struct Reference

Represents a data storage provider in the system (e.g. NSM5200 storage pool or VideoXpert Storage) hosted by a system device. The data storage can be directed to store media produced by a device by assigning the device to it. More...

#include <IVxDataStorage.h>

Public Member Functions
virtual VxResult::Value	AssignDevice (VxNewDeviceAssignment &newDeviceAssignment) const =0
	Assign a device to this data storage to be managed and recorded based on its configuration. More...
virtual VxResult::Value	Delete () const =0
	Deletes this instance. More...
virtual VxResult::Value	GetDataSources (VxCollection< IVxDataSource ** > &dataSourceCollection) const =0
	Gets the data sources assigned to this data storage. More...
virtual VxResult::Value	GetDeviceAssignments (VxCollection< IVxDeviceAssignment ** > &deviceAssignmentCollection) const =0
	Gets the devices assigned to this data storage. More...
virtual VxResult::Value	GetDrivers (VxCollection< IVxDriver ** > &driverCollection) const =0
	Gets all of the available device drivers that this data storage provides. More...
virtual VxResult::Value	GetHostDevice (IVxDevice *&hostDevice) const =0
	Gets the host device of this data storage. More...
virtual VxResult::Value	GetStorageConfiguration (IVxConfiguration::Storage *&storageConfig) const =0
	Gets the storage configuration. More...
virtual VxResult::Value	Refresh ()=0
	Refreshes the member values for this object by retrieving its current information from the VideoXpert system. More...
virtual VxResult::Value	SetName (char name[64])=0
	Sets the name property. More...
virtual VxResult::Value	UnassignDevice (IVxDevice &device) const =0
	Unassign a device from this data storage. More...
void	Clear ()
	Clears this instance. More...

Public Attributes
bool	isFailover
	Indicates whether the data storage is configured as a failover unit. More...
char	id [64]
	The unique identifier of the data storage. More...
char	name [64]
	The friendly name of the data storage. More...
VxDataStorageType::Value	type
	The data storage type. More...

Detailed Description

Represents a data storage provider in the system (e.g. NSM5200 storage pool or VideoXpert Storage) hosted by a system device. The data storage can be directed to store media produced by a device by assigning the device to it.

Definition at line 17 of file IVxDataStorage.h.

Member Function Documentation

virtual VxResult::Value VxSdk::IVxDataStorage::AssignDevice ( VxNewDeviceAssignment &  newDeviceAssignment ) const

pure virtual

Assign a device to this data storage to be managed and recorded based on its configuration.

Parameters

newDeviceAssignment

The device assignment to add to the data storage.

Returns

The Result of the request.

void VxSdk::IVxDataStorage::Clear ( )

inline

Clears this instance.

Definition at line 103 of file IVxDataStorage.h.

                     {
            this->isFailover = false;
            VxZeroArray(this->id);
            VxZeroArray(this->name);
            this->type = VxDataStorageType::kUnknown;
        }

virtual VxResult::Value VxSdk::IVxDataStorage::Delete ( ) const

pure virtual

Deletes this instance.

Returns

The Result of deleting this instance.

virtual VxResult::Value VxSdk::IVxDataStorage::GetDataSources ( VxCollection< IVxDataSource ** > &  dataSourceCollection ) const

pure virtual

Gets the data sources assigned to this data storage.

Available filters: kAllTags, kAllPrivateTags, kCapturing, kId, kIp, kManualRecording, kModifiedSince, kName, kNumber, kRecording, kState, kType, kUnassigned.

Parameters

dataSourceCollection

A VxCollection of the assigned data sources.

Returns

The Result of the request.

virtual VxResult::Value VxSdk::IVxDataStorage::GetDeviceAssignments ( VxCollection< IVxDeviceAssignment ** > &  deviceAssignmentCollection ) const

pure virtual

Gets the devices assigned to this data storage.

Available filters: kDataSourceId, kModifiedSince.

Parameters

deviceAssignmentCollection

A VxCollection of the assigned devices.

Returns

The Result of the request.

virtual VxResult::Value VxSdk::IVxDataStorage::GetDrivers ( VxCollection< IVxDriver ** > &  driverCollection ) const

pure virtual

Gets all of the available device drivers that this data storage provides.

Available filters: kModifiedSince, kName, kVendor, kVersion.

Parameters

driverCollection

A VxCollection of available drivers.

Returns

The Result of the request.

virtual VxResult::Value VxSdk::IVxDataStorage::GetHostDevice ( IVxDevice *&  hostDevice ) const

pure virtual

Gets the host device of this data storage.

Parameters

hostDevice

The host device of this data storage.

Returns

The Result of the request.

virtual VxResult::Value VxSdk::IVxDataStorage::GetStorageConfiguration ( IVxConfiguration::Storage *&  storageConfig ) const

pure virtual

Gets the storage configuration.

Parameters

storageConfig

The storage configuration.

Returns

The Result of the request.

virtual VxResult::Value VxSdk::IVxDataStorage::Refresh ( )

pure virtual

Refreshes the member values for this object by retrieving its current information from the VideoXpert system.

Returns

The Result of refreshing the member values for this object.

virtual VxResult::Value VxSdk::IVxDataStorage::SetName ( char  name[64] )

pure virtual

Sets the name property.

Parameters

name	The new name value.

Returns

The Result of setting the property.

virtual VxResult::Value VxSdk::IVxDataStorage::UnassignDevice ( IVxDevice &  device ) const

pure virtual

Unassign a device from this data storage.

Parameters

device

The device to remove from the data storage.

Returns

The Result of the request.

Member Data Documentation

char VxSdk::IVxDataStorage::id[64]

The unique identifier of the data storage.

Definition at line 89 of file IVxDataStorage.h.

bool VxSdk::IVxDataStorage::isFailover

Indicates whether the data storage is configured as a failover unit.

Definition at line 85 of file IVxDataStorage.h.

char VxSdk::IVxDataStorage::name[64]

The friendly name of the data storage.

Definition at line 93 of file IVxDataStorage.h.

VxDataStorageType::Value VxSdk::IVxDataStorage::type

The data storage type.

Definition at line 97 of file IVxDataStorage.h.

---

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

• C:/Git/VXSDK_M3/VxSdk/Include/IVxDataStorage.h