CPPCli::Device Class Reference

The Device class represents a particular physical device in the system. More...

#include <Device.h>

Public Types
enum	DeviceStatus {   DeviceStatus::Unknown,   DeviceStatus::Initializing,   DeviceStatus::Unauthenticated }
	Values that represent the operational state of a device. More...
enum	Types {   Types::Camera,   Types::Core,   Types::CoreMg,   Types::Decoder,   Types::Encoder,   Types::External,   Types::Manager,   Types::Mg,   Types::Monitor,   Types::Recorder,   Types::Udi,   Types::Ui,   Types::Unknown,   Types::Vcd }
	Values that represent device types. More...

Public Member Functions
	Device (VxSdk::IVxDevice *vxDevice)
	Constructor. More...
virtual	~Device ()
	Destructor. More...
	!Device ()
	Finaliser. More...
Results::Value	Refresh ()
	Refreshes this instances properties. More...

Package Functions
System::Collections::Generic::List< AlarmInput^ >^	_GetAlarmInputs ()
System::Collections::Generic::List< DataSource^ >^	_GetDataSources ()
System::Collections::Generic::List< DeviceAssignment^ >^	_GetDeviceAssignments ()
System::Collections::Generic::List< RelayOutput^ >^	_GetRelayOutputs ()

Package Attributes
VxSdk::IVxDevice *	_device

Properties
System::Collections::Generic::List< AlarmInput^ >^	AlarmInputs [get]
	Gets the alarm inputs hosted by this device. More...
System::Collections::Generic::List< DataSource^ >^	DataSources [get]
	Gets the data sources hosted by this device. More...
System::Collections::Generic::List< DeviceAssignment^ >^	DeviceAssignments [get]
	Gets the assignments to a data storage for this device. More...
System::String^	DriverDeviceId [get]
	Gets the driver device identifier. More...
System::String^	Id [get]
	Gets the unique identifier of the device. More...
System::String^	Ip [get]
	Gets the IP of the device. More...
bool	IsCommissioned [get]
	Gets a value indicating whether the device is commissioned. More...
bool	IsLicenseRequired [get]
	Gets a value indicating whether a license is required for commissioning the device. More...
bool	IsPelcoHardware [get]
	Gets a value indicating whether the device is running on Pelco hardware. More...
System::String^	Model [get]
	Gets the device model. More...
System::String^	Name [get, set]
	Gets or sets the friendly name of the device. More...
System::String^	Password [set]
	Sets the account password used to communicate with the device, if any. More...
System::Collections::Generic::List< RelayOutput^ >^	RelayOutputs [get]
	Gets the relay outputs hosted by this device. More...
System::String^	Serial [get]
	Gets the serial number. More...
DataSource::States	State [get]
	Gets the current operational state of the device. More...
System::Collections::Generic::List< DeviceStatus >^	Status [get]
	Gets the current device status. More...
Types	Type [get]
	Gets the type of device. More...
System::String^	Username [get, set]
	Gets or sets the account username used to communicate with the device, if any. More...
System::String^	Vendor [get]
	Gets the device vendor, if any. More...
System::String^	Version [get]
	Gets the current version of software running on the device. More...
System::String^	VirtualIp [get]
	Gets the virtual IP of the device, if any. More...

Detailed Description

The Device class represents a particular physical device in the system.

Definition at line 15 of file Device.h.

Member Enumeration Documentation

enum CPPCli::Device::DeviceStatus

strong

Values that represent the operational state of a device.

Enumerator
Unknown	An error or unknown value was returned.
Initializing	Being prepared for use.
Unauthenticated	Invalid/missing credentials.

Definition at line 21 of file Device.h.

                                {
            Unknown,

            Initializing,

            Unauthenticated
        };

enum CPPCli::Device::Types

strong

Values that represent device types.

Enumerator
Camera	A camera device.
Core	A VideoXpert Core device.
CoreMg	A VideoXpert Core/MediaGateway device.
Decoder	A decoder device.
Encoder	An encoder device.
External	An external device.
Manager	A system manager device.
Mg	A VideoXpert MediaGateway device.
Monitor	A monitor device.
Recorder	A network storage device.
Udi	A UDI device.
Ui	A UI device.
Unknown	An error or unknown value was returned.
Vcd	A VCD device.

Definition at line 35 of file Device.h.

                         {
            Camera,

            Core,

            CoreMg,

            Decoder,

            Encoder,

            External,

            Manager,

            Mg,

            Monitor,

            Recorder,

            Udi,

            Ui,

            Unknown,

            Vcd
        };

Constructor & Destructor Documentation

CPPCli::Device::Device

(

VxSdk::IVxDevice *

vxDevice

)

Constructor.

Parameters

vxDevice

The vx device.

Definition at line 8 of file Device.cpp.

                                             {
    _device = vxDevice;
}

virtual CPPCli::Device::~Device ( )

inlinevirtual

Destructor.

Definition at line 88 of file Device.h.

                          {
            this->!Device();
        }

CPPCli::Device::!Device

(

)

Finaliser.

Definition at line 12 of file Device.cpp.

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

Member Function Documentation

List< CPPCli::AlarmInput^ > CPPCli::Device::_GetAlarmInputs ( )

package

Definition at line 21 of file Device.cpp.

                                                       {
    // Create a list of managed alarm input objects
    List<AlarmInput^>^ mlist = gcnew List<AlarmInput^>();
    // Create a collection of unmanaged alarm input objects
    VxSdk::VxCollection<VxSdk::IVxAlarmInput**> alarmInputs;

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

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

package

Definition at line 45 of file Device.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 = _device->GetDataSources(dataSources);
    // Unless there are no data sources hosted on the device, 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 = _device->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::Device::_GetDeviceAssignments ( )

package

Definition at line 69 of file Device.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 = _device->GetDeviceAssignments(deviceAssignments);
    // Unless there are no device assignments hosted on the device, 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 = _device->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::RelayOutput^ > CPPCli::Device::_GetRelayOutputs ( )

package

Definition at line 93 of file Device.cpp.

                                                         {
    // Create a list of managed relay output objects
    List<RelayOutput^>^ mlist = gcnew List<RelayOutput^>();
    // Create a collection of unmanaged relay output objects
    VxSdk::VxCollection<VxSdk::IVxRelayOutput**> relayOutputs;

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

CPPCli::Results::Value CPPCli::Device::Refresh

(

)

Refreshes this instances properties.

Returns

The Result of updating the properties.

Definition at line 17 of file Device.cpp.

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

Member Data Documentation

VxSdk::IVxDevice* CPPCli::Device::_device

package

Definition at line 313 of file Device.h.

Property Documentation

System:: Collections:: Generic:: List< AlarmInput^>^ CPPCli::Device::AlarmInputs

get

Gets the alarm inputs hosted by this device.

A List of alarm inputs.

Definition at line 107 of file Device.h.

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

get

Gets the data sources hosted by this device.

A List of data sources.

Definition at line 116 of file Device.h.

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

get

Gets the assignments to a data storage for this device.

A List of device assignments.

Definition at line 125 of file Device.h.

System:: String^ CPPCli::Device::DriverDeviceId

get

Gets the driver device identifier.

The driver device identifier.

Definition at line 134 of file Device.h.

System:: String^ CPPCli::Device::Id

get

Gets the unique identifier of the device.

The unique identifier.

Definition at line 143 of file Device.h.

System:: String^ CPPCli::Device::Ip

get

Gets the IP of the device.

The IP.

Definition at line 152 of file Device.h.

bool CPPCli::Device::IsCommissioned

get

Gets a value indicating whether the device is commissioned.

true if commissioned, false if not.

Definition at line 161 of file Device.h.

bool CPPCli::Device::IsLicenseRequired

get

Gets a value indicating whether a license is required for commissioning the device.

true if license required, false if not.

Definition at line 170 of file Device.h.

bool CPPCli::Device::IsPelcoHardware

get

Gets a value indicating whether the device is running on Pelco hardware.

true if a Pelco device, false if not.

Definition at line 179 of file Device.h.

System:: String^ CPPCli::Device::Model

get

Gets the device model.

The model name.

Definition at line 188 of file Device.h.

System:: String^ CPPCli::Device::Name

getset

Gets or sets the friendly name of the device.

The friendly name.

Definition at line 197 of file Device.h.

System:: String^ CPPCli::Device::Password

set

Sets the account password used to communicate with the device, if any.

The password.

Definition at line 211 of file Device.h.

System:: Collections:: Generic:: List< RelayOutput^>^ CPPCli::Device::RelayOutputs

get

Gets the relay outputs hosted by this device.

A List of relay outputs.

Definition at line 224 of file Device.h.

System:: String^ CPPCli::Device::Serial

get

Gets the serial number.

The serial number.

Definition at line 233 of file Device.h.

DataSource:: States CPPCli::Device::State

get

Gets the current operational state of the device.

The current state of the device.

Definition at line 242 of file Device.h.

System:: Collections:: Generic:: List< DeviceStatus>^ CPPCli::Device::Status

get

Gets the current device status.

A device status List.

Definition at line 251 of file Device.h.

Types CPPCli::Device::Type

get

Gets the type of device.

The device Type.

Definition at line 266 of file Device.h.

System:: String^ CPPCli::Device::Username

getset

Gets or sets the account username used to communicate with the device, if any.

The username.

Definition at line 275 of file Device.h.

System:: String^ CPPCli::Device::Vendor

get

Gets the device vendor, if any.

The name of the devices vendor.

Definition at line 289 of file Device.h.

System:: String^ CPPCli::Device::Version

get

Gets the current version of software running on the device.

The software version.

Definition at line 298 of file Device.h.

System:: String^ CPPCli::Device::VirtualIp

get

Gets the virtual IP of the device, if any.

The virtual IP.

Definition at line 307 of file Device.h.

---

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

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