CPPCli::DataStorage Class Reference

The DataStorage class represents a data storage provider in the system (e.g. an NSM5200 storage pool or a VxRecorder) hosted by a system device. The DataStorage can be directed to store media produced by a device by assigning the device to it. More...

#include <DataStorage.h>

Public Types
enum	DataStorageTypes {   DataStorageTypes::Unknown,   DataStorageTypes::DigitalSentry,   DataStorageTypes::NSM,   DataStorageTypes::VideoXpertStorage,   DataStorageTypes::Edge }
	Values that represent data storage hardware types. More...

Public Member Functions
	DataStorage (VxSdk::IVxDataStorage *vxDataStorage)
	Constructor. More...
virtual	~DataStorage ()
	Destructor. More...
	!DataStorage ()
	Finaliser. More...
Results::Value	AssignDevice (NewDeviceAssignment^ newDeviceAssignment)
	Assign a device to this data storage to be managed and recorded based on its configuration. More...
Results::Value	Refresh ()
	Refreshes this instances properties. More...
Results::Value	UnassignDevice (Device^ device)
	Unassign a device from this data storage. More...

Package Functions
System::Collections::Generic::List< CPPCli::DataSource^ >^	_GetDataSources ()
System::Collections::Generic::List< CPPCli::DeviceAssignment^ >^	_GetDeviceAssignments ()
System::Collections::Generic::List< CPPCli::Driver^ >^	_GetDrivers ()
CPPCli::Device^	_GetHostDevice ()
CPPCli::Configuration::Storage^	_GetStorageConfig ()

Package Attributes
VxSdk::IVxDataStorage *	_dataStorage

Properties
CPPCli::Configuration::Storage^	Configuration [get]
	Gets the device assignments for this data storage. More...
System::Collections::Generic::List< CPPCli::DataSource^ >^	DataSources [get]
	Gets the data sources assigned to this data storage. More...
System::Collections::Generic::List< CPPCli::DeviceAssignment^ >^	DeviceAssignments [get]
	Gets the device assignments for this data storage. More...
System::Collections::Generic::List< CPPCli::Driver^ >^	Drivers [get]
	Gets the drivers provided by this data storage. More...
CPPCli::Device^	HostDevice [get]
	Gets the device that hosts this data storage. More...
System::String^	Id [get]
	Gets the unique identifier of the data storage. More...
bool	IsFailover [get]
	Gets a value indicating whether the data storage is configured as a failover unit. More...
System::String^	Name [get, set]
	Gets or sets the friendly name of the data storage. More...
DataStorageTypes	Type [get]
	Gets the type of data storage. More...

Detailed Description

The DataStorage class represents a data storage provider in the system (e.g. an NSM5200 storage pool or a VxRecorder) hosted by a system device. The DataStorage can be directed to store media produced by a device by assigning the device to it.

Definition at line 18 of file DataStorage.h.

Member Enumeration Documentation

enum CPPCli::DataStorage::DataStorageTypes

strong

Values that represent data storage hardware types.

Enumerator
Unknown	An error or unknown value was returned.
DigitalSentry	A Digital Sentry device.
NSM	An NSM network video recorder device.
VideoXpertStorage	A VideoXpert storage device.
Edge	An edge storage device.

Definition at line 24 of file DataStorage.h.

                                    {
            Unknown,

            DigitalSentry,

            NSM,

            VideoXpertStorage,

            Edge
        };

Constructor & Destructor Documentation

CPPCli::DataStorage::DataStorage

(

VxSdk::IVxDataStorage *

vxDataStorage

)

Constructor.

Parameters

vxDataStorage

The vx data storage.

Definition at line 8 of file DataStorage.cpp.

                                                                 {
    _dataStorage = vxDataStorage;
}

virtual CPPCli::DataStorage::~DataStorage ( )

inlinevirtual

Destructor.

Definition at line 50 of file DataStorage.h.

                               {
            this->!DataStorage();
        }

CPPCli::DataStorage::!DataStorage

(

)

Finaliser.

Definition at line 12 of file DataStorage.cpp.

                                {
    _dataStorage->Delete();
    _dataStorage = nullptr;
}

Member Function Documentation

List< CPPCli::DataSource^ > CPPCli::DataStorage::_GetDataSources ( )

package

Definition at line 56 of file DataStorage.cpp.

                                                            {
    // Create a list of managed data source objects
    List<DataSource^>^ mlist = gcnew List<DataSource^>();
    // Create a collection of unmanaged data source objects
    VxSdk::VxCollection<VxSdk::IVxDataSource**> dataSources;

    // Make the GetDataSources call, which will return with the total count of data sources, this allows the client to allocate memory.
    VxSdk::VxResult::Value result = _dataStorage->GetDataSources(dataSources);
    // Unless there are no data sources on the system, this should return VxSdk::VxResult::kInsufficientSize
    if (result == VxSdk::VxResult::kInsufficientSize) {
        // An array of pointers is allocated using the size returned by the previous GetDataSources call
        dataSources.collection = new VxSdk::IVxDataSource*[dataSources.collectionSize];
        result = _dataStorage->GetDataSources(dataSources);
        // The result should now be kOK since we have allocated enough space
        if (result == VxSdk::VxResult::kOK) {
            for (int i = 0; i < dataSources.collectionSize; i++)
                mlist->Add(gcnew CPPCli::DataSource(dataSources.collection[i]));
        }
        // Remove the memory we previously allocated to the collection
        delete[] dataSources.collection;
    }
    return mlist;
}

List< CPPCli::DeviceAssignment^ > CPPCli::DataStorage::_GetDeviceAssignments ( )

package

Definition at line 80 of file DataStorage.cpp.

                                                                        {
    // Create a list of managed device assignment objects
    List<DeviceAssignment^>^ mlist = gcnew List<DeviceAssignment^>();
    // Create a collection of unmanaged device assignment objects
    VxSdk::VxCollection<VxSdk::IVxDeviceAssignment**> deviceAssignments;

    // Make the GetDeviceAssignments call, which will return with the total count of device assignments, this allows the client to allocate memory.
    VxSdk::VxResult::Value result = _dataStorage->GetDeviceAssignments(deviceAssignments);
    // Unless there are no device assignments on the system, this should return VxSdk::VxResult::kInsufficientSize
    if (result == VxSdk::VxResult::kInsufficientSize) {
        // An array of pointers is allocated using the size returned by the previous GetDeviceAssignments call
        deviceAssignments.collection = new VxSdk::IVxDeviceAssignment*[deviceAssignments.collectionSize];
        result = _dataStorage->GetDeviceAssignments(deviceAssignments);
        // The result should now be kOK since we have allocated enough space
        if (result == VxSdk::VxResult::kOK) {
            for (int i = 0; i < deviceAssignments.collectionSize; i++)
                mlist->Add(gcnew CPPCli::DeviceAssignment(deviceAssignments.collection[i]));
        }
        // Remove the memory we previously allocated to the collection
        delete[] deviceAssignments.collection;
    }
    return mlist;
}

List< CPPCli::Driver^ > CPPCli::DataStorage::_GetDrivers ( )

package

Definition at line 104 of file DataStorage.cpp.

                                                    {
    // Create a list of managed driver objects
    List<Driver^>^ mlist = gcnew List<Driver^>();
    // Create a collection of unmanaged driver objects
    VxSdk::VxCollection<VxSdk::IVxDriver**> drivers;

    // Make the GetDrivers call, which will return with the total count of drivers, this allows the client to allocate memory.
    VxSdk::VxResult::Value result = _dataStorage->GetDrivers(drivers);
    // Unless there are no drivers on the system, this should return VxSdk::VxResult::kInsufficientSize
    if (result == VxSdk::VxResult::kInsufficientSize) {
        // An array of pointers is allocated using the size returned by the previous GetDrivers call
        drivers.collection = new VxSdk::IVxDriver*[drivers.collectionSize];
        result = _dataStorage->GetDrivers(drivers);
        // The result should now be kOK since we have allocated enough space
        if (result == VxSdk::VxResult::kOK) {
            for (int i = 0; i < drivers.collectionSize; i++)
                mlist->Add(gcnew CPPCli::Driver(drivers.collection[i]));
        }
        // Remove the memory we previously allocated to the collection
        delete[] drivers.collection;
    }
    return mlist;
}

CPPCli::Device CPPCli::DataStorage::_GetHostDevice ( )

package

Definition at line 128 of file DataStorage.cpp.

                                                {
    // Get the device which hosts this data storage
    VxSdk::IVxDevice* device = nullptr;
    VxSdk::VxResult::Value result = _dataStorage->GetHostDevice(device);

    // Return the device if GetHostDevice was successful
    if (result == VxSdk::VxResult::kOK)
        return gcnew Device(device);

    return nullptr;
}

CPPCli::Configuration::Storage CPPCli::DataStorage::_GetStorageConfig ( )

package

Definition at line 140 of file DataStorage.cpp.

                                                                 {
    // Get the storage config
    VxSdk::IVxConfiguration::Storage* storageConfig = nullptr;
    VxSdk::VxResult::Value result = _dataStorage->GetStorageConfiguration(storageConfig);

    // Return the storage config if GetStorageConfiguration was successful
    if (result == VxSdk::VxResult::kOK)
        return gcnew CPPCli::Configuration::Storage(storageConfig);

    return nullptr;
}

CPPCli::Results::Value CPPCli::DataStorage::AssignDevice

(

CPPCli::NewDeviceAssignment^

newDeviceAssignment

)

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

Parameters

newDeviceAssignment

The new device assignment to be added to the data storage.

Returns

The Result of assigning the device.

Definition at line 17 of file DataStorage.cpp.

                                                                                                 {
    // Create a new device assignment object and populate its fields using newDeviceAssignment
    VxSdk::VxNewDeviceAssignment vxNewDeviceAssignment;
    VxSdk::Utilities::StrCopySafe(vxNewDeviceAssignment.deviceId, Utils::ConvertSysString(newDeviceAssignment->DeviceId));
    VxSdk::Utilities::StrCopySafe(vxNewDeviceAssignment.driverType, Utils::ConvertSysString(newDeviceAssignment->DriverType));
    int size = newDeviceAssignment->DataSourceIds->Count;

    vxNewDeviceAssignment.dataSourceIdSize = size;
    vxNewDeviceAssignment.dataSourceIds = new char*[size];
    for (int i = 0; i < size; i++) {
        int idLength = newDeviceAssignment->DataSourceIds[i]->Length + 1;
        vxNewDeviceAssignment.dataSourceIds[i] = new char[idLength];
        VxSdk::Utilities::StrCopySafe(vxNewDeviceAssignment.dataSourceIds[i], Utils::ConvertSysString(newDeviceAssignment->DataSourceIds[i]), idLength);
    }

    // Make the call to add the situation into VideoXpert
    VxSdk::VxResult::Value result = _dataStorage->AssignDevice(vxNewDeviceAssignment);
    // Unless there was an issue adding the situation the result should be VxSdk::VxResult::kOK
    if (result == VxSdk::VxResult::kOK) {
        // Remove the memory we previously allocated
        delete[] vxNewDeviceAssignment.dataSourceIds;
    }
    return CPPCli::Results::Value(result);
}

CPPCli::Results::Value CPPCli::DataStorage::Refresh

(

)

Refreshes this instances properties.

Returns

The Result of updating the properties.

Definition at line 42 of file DataStorage.cpp.

                                              {
    return (CPPCli::Results::Value)_dataStorage->Refresh();
}

CPPCli::Results::Value CPPCli::DataStorage::UnassignDevice

(

CPPCli::Device^

device

)

Unassign a device from this data storage.

Parameters

device

The device to be unassigned from the data storage.

Returns

The Result of unassigning the device.

Definition at line 46 of file DataStorage.cpp.

                                                                         {
    // Create an IVxDevice object using the device
    VxSdk::IVxDevice* delDevice = device->_device;

    // Call UnassignDevice using the IVxDevice object
    VxSdk::VxResult::Value result = _dataStorage->UnassignDevice(*delDevice);
    // Unless there was an issue unassigning the device the result should be VxSdk::VxResult::kOK
    return CPPCli::Results::Value(result);
}

Member Data Documentation

VxSdk::IVxDataStorage* CPPCli::DataStorage::_dataStorage

package

Definition at line 166 of file DataStorage.h.

Property Documentation

CPPCli:: Configuration:: Storage^ CPPCli::DataStorage::Configuration

get

Gets the device assignments for this data storage.

A List of device assignments.

Definition at line 83 of file DataStorage.h.

System:: Collections:: Generic:: List< CPPCli:: DataSource^>^ CPPCli::DataStorage::DataSources

get

Gets the data sources assigned to this data storage.

A List of data sources.

Definition at line 92 of file DataStorage.h.

System:: Collections:: Generic:: List< CPPCli:: DeviceAssignment^>^ CPPCli::DataStorage::DeviceAssignments

get

Gets the device assignments for this data storage.

A List of device assignments.

Definition at line 101 of file DataStorage.h.

System:: Collections:: Generic:: List< CPPCli:: Driver^>^ CPPCli::DataStorage::Drivers

get

Gets the drivers provided by this data storage.

A List of drivers.

Definition at line 110 of file DataStorage.h.

CPPCli:: Device^ CPPCli::DataStorage::HostDevice

get

Gets the device that hosts this data storage.

The host device.

Definition at line 119 of file DataStorage.h.

System:: String^ CPPCli::DataStorage::Id

get

Gets the unique identifier of the data storage.

The unique identifier.

Definition at line 128 of file DataStorage.h.

bool CPPCli::DataStorage::IsFailover

get

Gets a value indicating whether the data storage is configured as a failover unit.

true if the data storage is a failover unit, false if not.

Definition at line 137 of file DataStorage.h.

System:: String^ CPPCli::DataStorage::Name

getset

Gets or sets the friendly name of the data storage.

The friendly name.

Definition at line 146 of file DataStorage.h.

DataStorageTypes CPPCli::DataStorage::Type

get

Gets the type of data storage.

The data storage type.

Definition at line 160 of file DataStorage.h.

---

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

• C:/Git/VxSDK-Samples/CSharpSample/CSharpWrapper/Include/DataStorage.h
• C:/Git/VxSDK-Samples/CSharpSample/CSharpWrapper/Source/DataStorage.cpp