VideoXpert SDK  2.0
A software development kit for third party vendors to integrate with the VideoXpert platform
•All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros
Public Member Functions | Public Attributes | List of all members
VxSdk::IVxDevice Struct Referenceabstract

Represents a particular physical device in the system. More...

#include <IVxDevice.h>

Public Member Functions

virtual VxResult::Value Delete () const =0
 Deletes this instance. More...
 
virtual VxResult::Value DeleteDevice () const =0
 Remove the device and its hosted data sources and data storages. If the device is assigned to a data storage, it shall be unassigned. More...
 
virtual VxResult::Value GetAlarmInputs (VxCollection< IVxAlarmInput ** > &alarmInputCollection) const =0
 Gets the alarm inputs hosted by this device. More...
 
virtual VxResult::Value GetDataSources (VxCollection< IVxDataSource ** > &dataSourceCollection) const =0
 Gets the data sources hosted by this device. More...
 
virtual VxResult::Value GetDeviceAssignments (VxCollection< IVxDeviceAssignment ** > &deviceAssignmentCollection) const =0
 Gets the assignments to a data storage for this device. More...
 
virtual VxResult::Value GetMonitors (VxCollection< IVxMonitor ** > &monitorCollection) const =0
 Gets the monitors residing on the device. More...
 
virtual VxResult::Value GetRelayOutputs (VxCollection< IVxRelayOutput ** > &relayOutputCollection) const =0
 Gets the relay outputs hosted by this device. 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 SetPassword (char password[64])=0
 Sets the password property. More...
 
virtual VxResult::Value SetUsername (char username[64])=0
 Sets the username property. More...
 
void Clear ()
 Clears this instance. More...
 

Public Attributes

bool isCommissioned
 Indicates whether the device is commissioned. More...
 
bool isLicenseRequired
 Indicates whether a license is required for commissioning the device. More...
 
bool isPelcoHardware
 Indicates whether the device is running on Pelco hardware. More...
 
char driverDeviceId [64]
 The driver device identifier. More...
 
char id [64]
 The unique identifier of the device. More...
 
char ip [64]
 The IP of the device. More...
 
char model [64]
 The device model name. More...
 
char name [64]
 The friendly name of the device. More...
 
char serial [64]
 The serial number of the device. More...
 
char username [64]
 The account username used to communicate with the device, if any. More...
 
char vendor [64]
 The device vendor, if any. More...
 
char version [64]
 The current version of software running on the device. More...
 
char virtualIp [64]
 The virtual IP of the device, if any. More...
 
int statusSize
 The size of status. More...
 
VxDeviceState::Value state
 The current operational state of the device. More...
 
VxDeviceStatus::Value * status
 The current device status. More...
 
VxDeviceType::Value type
 The type of device. More...
 

Detailed Description

Represents a particular physical device in the system.

Definition at line 19 of file IVxDevice.h.

Member Function Documentation

void VxSdk::IVxDevice::Clear ( )
inline

Clears this instance.

Definition at line 165 of file IVxDevice.h.

165  {
166  this->isCommissioned = false;
167  this->isLicenseRequired = false;
168  this->isPelcoHardware = false;
169  VxZeroArray(this->driverDeviceId);
170  VxZeroArray(this->id);
171  VxZeroArray(this->ip);
172  VxZeroArray(this->model);
173  VxZeroArray(this->name);
174  VxZeroArray(this->serial);
175  VxZeroArray(this->username);
176  VxZeroArray(this->vendor);
177  VxZeroArray(this->version);
178  VxZeroArray(this->virtualIp);
179  this->statusSize = 0;
180  this->status = nullptr;
181  this->state = VxDeviceState::kUnknown;
182  this->type = VxDeviceType::kUnknown;
183  }
VxSdk::IVxDevice::username
char username[64]
The account username used to communicate with the device, if any.
Definition: IVxDevice.h:131
VxSdk::IVxDevice::isPelcoHardware
bool isPelcoHardware
Indicates whether the device is running on Pelco hardware.
Definition: IVxDevice.h:103
VxZeroArray
#define VxZeroArray(src)
Definition: VxMacros.h:25
VxSdk::IVxDevice::type
VxDeviceType::Value type
The type of device.
Definition: IVxDevice.h:159
VxSdk::IVxDevice::status
VxDeviceStatus::Value * status
The current device status.
Definition: IVxDevice.h:155
VxSdk::IVxDevice::vendor
char vendor[64]
The device vendor, if any.
Definition: IVxDevice.h:135
VxSdk::IVxDevice::model
char model[64]
The device model name.
Definition: IVxDevice.h:119
VxSdk::IVxDevice::statusSize
int statusSize
The size of status.
Definition: IVxDevice.h:147
VxSdk::IVxDevice::virtualIp
char virtualIp[64]
The virtual IP of the device, if any.
Definition: IVxDevice.h:143
VxSdk::IVxDevice::serial
char serial[64]
The serial number of the device.
Definition: IVxDevice.h:127
VxSdk::IVxDevice::driverDeviceId
char driverDeviceId[64]
The driver device identifier.
Definition: IVxDevice.h:107
VxSdk::VxDeviceState::kUnknown
An error or unknown value was returned.
Definition: VxPrimitives.h:289
VxSdk::IVxDevice::state
VxDeviceState::Value state
The current operational state of the device.
Definition: IVxDevice.h:151
VxSdk::IVxDevice::isCommissioned
bool isCommissioned
Indicates whether the device is commissioned.
Definition: IVxDevice.h:95
VxSdk::IVxDevice::isLicenseRequired
bool isLicenseRequired
Indicates whether a license is required for commissioning the device.
Definition: IVxDevice.h:99
VxSdk::IVxDevice::ip
char ip[64]
The IP of the device.
Definition: IVxDevice.h:115
VxSdk::VxDeviceType::kUnknown
An error or unknown value was returned.
Definition: VxPrimitives.h:341
VxSdk::IVxDevice::version
char version[64]
The current version of software running on the device.
Definition: IVxDevice.h:139
VxSdk::IVxDevice::name
char name[64]
The friendly name of the device.
Definition: IVxDevice.h:123
virtual VxResult::Value VxSdk::IVxDevice::Delete ( ) const
pure virtual

Deletes this instance.

Returns
The Result of deleting this instance.
virtual VxResult::Value VxSdk::IVxDevice::DeleteDevice ( ) const
pure virtual

Remove the device and its hosted data sources and data storages. If the device is assigned to a data storage, it shall be unassigned.

Returns
The Result of the request.
virtual VxResult::Value VxSdk::IVxDevice::GetAlarmInputs ( VxCollection< IVxAlarmInput ** > &  alarmInputCollection) const
pure virtual

Gets the alarm inputs hosted by this device.

Available filters: kModifiedSince, kName, kState.

Parameters
alarmInputCollectionA VxCollection of the alarm inputs hosted by this device.
Returns
The Result of the request.
virtual VxResult::Value VxSdk::IVxDevice::GetDataSources ( VxCollection< IVxDataSource ** > &  dataSourceCollection) const
pure virtual

Gets the data sources hosted by this device.

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

Parameters
dataSourceCollectionA VxCollection of the associated data sources.
Returns
The Result of the request.
virtual VxResult::Value VxSdk::IVxDevice::GetDeviceAssignments ( VxCollection< IVxDeviceAssignment ** > &  deviceAssignmentCollection) const
pure virtual

Gets the assignments to a data storage for this device.

Available filters: kDataSourceId, kModifiedSince.

Parameters
deviceAssignmentCollectionA VxCollection of the device assignments.
Returns
The Result of the request.
virtual VxResult::Value VxSdk::IVxDevice::GetMonitors ( VxCollection< IVxMonitor ** > &  monitorCollection) const
pure virtual

Gets the monitors residing on the device.

Available filters: kModifiedSince, kName, kNumber.

Parameters
monitorCollectionA VxCollection of the monitors residing on the device.
Returns
The Result of the request.
virtual VxResult::Value VxSdk::IVxDevice::GetRelayOutputs ( VxCollection< IVxRelayOutput ** > &  relayOutputCollection) const
pure virtual

Gets the relay outputs hosted by this device.

Available filters: kModifiedSince, kName, kState.

Parameters
relayOutputCollectionA VxCollection of the relay outputs hosted by this device.
Returns
The Result of the request.
virtual VxResult::Value VxSdk::IVxDevice::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::IVxDevice::SetName ( char  name[64])
pure virtual

Sets the name property.

Parameters
nameThe new name value.
Returns
The Result of setting the property.
virtual VxResult::Value VxSdk::IVxDevice::SetPassword ( char  password[64])
pure virtual

Sets the password property.

Parameters
passwordThe new password value.
Returns
The Result of setting the property.
virtual VxResult::Value VxSdk::IVxDevice::SetUsername ( char  username[64])
pure virtual

Sets the username property.

Parameters
usernameThe new username value.
Returns
The Result of setting the property.

Member Data Documentation

char VxSdk::IVxDevice::driverDeviceId[64]

The driver device identifier.

Definition at line 107 of file IVxDevice.h.

char VxSdk::IVxDevice::id[64]

The unique identifier of the device.

Definition at line 111 of file IVxDevice.h.

char VxSdk::IVxDevice::ip[64]

The IP of the device.

Definition at line 115 of file IVxDevice.h.

bool VxSdk::IVxDevice::isCommissioned

Indicates whether the device is commissioned.

Definition at line 95 of file IVxDevice.h.

bool VxSdk::IVxDevice::isLicenseRequired

Indicates whether a license is required for commissioning the device.

Definition at line 99 of file IVxDevice.h.

bool VxSdk::IVxDevice::isPelcoHardware

Indicates whether the device is running on Pelco hardware.

Definition at line 103 of file IVxDevice.h.

char VxSdk::IVxDevice::model[64]

The device model name.

Definition at line 119 of file IVxDevice.h.

char VxSdk::IVxDevice::name[64]

The friendly name of the device.

Definition at line 123 of file IVxDevice.h.

char VxSdk::IVxDevice::serial[64]

The serial number of the device.

Definition at line 127 of file IVxDevice.h.

VxDeviceState::Value VxSdk::IVxDevice::state

The current operational state of the device.

Definition at line 151 of file IVxDevice.h.

VxDeviceStatus::Value* VxSdk::IVxDevice::status

The current device status.

Definition at line 155 of file IVxDevice.h.

int VxSdk::IVxDevice::statusSize

The size of status.

Definition at line 147 of file IVxDevice.h.

VxDeviceType::Value VxSdk::IVxDevice::type

The type of device.

Definition at line 159 of file IVxDevice.h.

char VxSdk::IVxDevice::username[64]

The account username used to communicate with the device, if any.

Definition at line 131 of file IVxDevice.h.

char VxSdk::IVxDevice::vendor[64]

The device vendor, if any.

Definition at line 135 of file IVxDevice.h.

char VxSdk::IVxDevice::version[64]

The current version of software running on the device.

Definition at line 139 of file IVxDevice.h.

char VxSdk::IVxDevice::virtualIp[64]

The virtual IP of the device, if any.

Definition at line 143 of file IVxDevice.h.

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