CPPCli::DeviceAssignment Class Reference

The DeviceAssignment class represents a device assignment. More...

#include <DeviceAssignment.h>

Public Member Functions
	DeviceAssignment (VxSdk::IVxDeviceAssignment *vxDeviceAssignment)
	Constructor. More...
virtual	~DeviceAssignment ()
	Destructor. More...
	!DeviceAssignment ()
	Finaliser. More...

Package Functions
System::Collections::Generic::List< CPPCli::DataSource^ >^	_GetDataSources ()
CPPCli::DataStorage^	_GetDataStorage ()
CPPCli::Device^	_GetDevice ()
CPPCli::Driver^	_GetDriver ()
void	_SetDataSources (System::Collections::Generic::List< CPPCli::DataSource^ >^dataSources)

Package Attributes
VxSdk::IVxDeviceAssignment *	_deviceAssignment

Properties
System::Collections::Generic::List< CPPCli::DataSource^ >^	DataSources [get, set]
	Gets or sets the data sources assigned by this device assignment. More...
CPPCli::DataStorage^	DataStorage [get]
	Gets the data storage that this device assignment is for. More...
CPPCli::Device^	Device [get]
	Gets the assigned device. More...
CPPCli::Driver^	Driver [get]
	Gets the assigned driver. More...
System::String^	DriverType [get, set]
	Gets or sets the driver type. More...
System::String^	Id [get]
	Gets the unique identifier of the device assignment. More...

Detailed Description

The DeviceAssignment class represents a device assignment.

Definition at line 15 of file DeviceAssignment.h.

Constructor & Destructor Documentation

CPPCli::DeviceAssignment::DeviceAssignment

(

VxSdk::IVxDeviceAssignment *

vxDeviceAssignment

)

Constructor.

Parameters

vxDeviceAssignment

The vx device assignment.

Definition at line 9 of file DeviceAssignment.cpp.

                                                                                     {
    _deviceAssignment = vxDeviceAssignment;
}

virtual CPPCli::DeviceAssignment::~DeviceAssignment ( )

inlinevirtual

Destructor.

Definition at line 27 of file DeviceAssignment.h.

                                    {
            this->!DeviceAssignment();
        }

CPPCli::DeviceAssignment::!DeviceAssignment

(

)

Finaliser.

Definition at line 13 of file DeviceAssignment.cpp.

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

Member Function Documentation

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

package

Definition at line 18 of file DeviceAssignment.cpp.

                                                                 {
    // Create a list of managed data source objects
    List<CPPCli::DataSource^>^ mlist = gcnew List<CPPCli::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 = _deviceAssignment->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 = _deviceAssignment->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;
}

CPPCli::DataStorage CPPCli::DeviceAssignment::_GetDataStorage ( )

package

Definition at line 42 of file DeviceAssignment.cpp.

                                                           {
    // Get the data storage object
    VxSdk::IVxDataStorage* dataStorage = nullptr;
    VxSdk::VxResult::Value result = _deviceAssignment->GetDataStorage(dataStorage);

    // Return the data storage if GetDataStorage was successful
    if (result == VxSdk::VxResult::kOK)
        return gcnew CPPCli::DataStorage(dataStorage);

    // Return nullptr if GetDataStorage is unsuccessful
    return nullptr;
}

CPPCli::Device CPPCli::DeviceAssignment::_GetDevice ( )

package

Definition at line 55 of file DeviceAssignment.cpp.

                                                 {
    // Get the device object
    VxSdk::IVxDevice* device = nullptr;
    VxSdk::VxResult::Value result = _deviceAssignment->GetDevice(device);

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

    // Return nullptr if GetDevice is unsuccessful
    return nullptr;
}

CPPCli::Driver CPPCli::DeviceAssignment::_GetDriver ( )

package

Definition at line 68 of file DeviceAssignment.cpp.

                                                 {
    // Get the driver object
    VxSdk::IVxDriver* driver = nullptr;
    VxSdk::VxResult::Value result = _deviceAssignment->GetDriver(driver);

    // Return the driver if GetDriver was successful
    if (result == VxSdk::VxResult::kOK)
        return gcnew CPPCli::Driver(driver);

    // Return nullptr if GetDriver is unsuccessful
    return nullptr;
}

void CPPCli::DeviceAssignment::_SetDataSources ( System::Collections::Generic::List< CPPCli::DataSource^ >^  dataSources )

package

Definition at line 81 of file DeviceAssignment.cpp.

                                                                                 {
    // Set the data source id size based on the list count
    int dataSourceIdSize = dataSources->Count;
    if (dataSourceIdSize == 0)
        return;

    // Create a list of data source ids
    char** dataSourceIds;
    dataSourceIds = new char*[dataSourceIdSize];
    for (int i = 0; i < dataSourceIdSize; i++) {
        int idLength = dataSources[i]->Id->Length + 1;
        dataSourceIds[i] = new char[idLength];
        VxSdk::Utilities::StrCopySafe(dataSourceIds[i], Utils::ConvertSysString(dataSources[i]->Id), idLength);
    }

    // Set the data sources using the list of ids
    _deviceAssignment->SetDataSources(dataSourceIds, dataSourceIdSize);
}

Member Data Documentation

VxSdk::IVxDeviceAssignment* CPPCli::DeviceAssignment::_deviceAssignment

package

Definition at line 97 of file DeviceAssignment.h.

Property Documentation

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

getset

Gets or sets the data sources assigned by this device assignment.

A List of data sources.

Definition at line 40 of file DeviceAssignment.h.

CPPCli:: DataStorage^ CPPCli::DeviceAssignment::DataStorage

get

Gets the data storage that this device assignment is for.

The DataStorage for this assignment.

Definition at line 50 of file DeviceAssignment.h.

CPPCli:: Device^ CPPCli::DeviceAssignment::Device

get

Gets the assigned device.

The assigned Device.

Definition at line 59 of file DeviceAssignment.h.

CPPCli:: Driver^ CPPCli::DeviceAssignment::Driver

get

Gets the assigned driver.

The assigned Driver.

Definition at line 68 of file DeviceAssignment.h.

System:: String^ CPPCli::DeviceAssignment::DriverType

getset

Gets or sets the driver type.

The driver type.

Definition at line 77 of file DeviceAssignment.h.

System:: String^ CPPCli::DeviceAssignment::Id

get

Gets the unique identifier of the device assignment.

The unique identifier.

Definition at line 91 of file DeviceAssignment.h.

---

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

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