VideoXpert SDK  2.0
A software development kit for third party vendors to integrate with the VideoXpert platform
Public Member Functions | Public Attributes | Protected Member Functions | List of all members
VxSdk::IVxDriver Struct Referenceabstract

Represents a device communication driver. More...

#include <IVxDriver.h>

Public Member Functions

virtual VxResult::Value Delete () const =0
 Deletes this instance. More...
 
virtual VxResult::Value GetDataStorage (IVxDataStorage *&dataStorage) const =0
 Gets the IVxDataStorage that hosts this driver. More...
 
virtual VxResult::Value Refresh ()=0
 Refreshes the member values for this object by retrieving its current information from the VideoXpert system. More...
 

Public Attributes

char name [64]
 The friendly name of the driver. More...
 
char type [64]
 The driver type identifier. More...
 
char vendor [64]
 The name of the vendor that manufactured the device that the driver is for. More...
 
char version [64]
 The driver version number. More...
 

Protected Member Functions

void Clear ()
 Clears this instance. More...
 

Detailed Description

Represents a device communication driver.

Definition at line 14 of file IVxDriver.h.

Member Function Documentation

void VxSdk::IVxDriver::Clear ( )
inlineprotected

Clears this instance.

Definition at line 55 of file IVxDriver.h.

55  {
56  VxZeroArray(this->name);
57  VxZeroArray(this->type);
58  VxZeroArray(this->vendor);
59  VxZeroArray(this->version);
60  }
VxZeroArray
#define VxZeroArray(src)
Definition: VxMacros.h:25
VxSdk::IVxDriver::vendor
char vendor[64]
The name of the vendor that manufactured the device that the driver is for.
Definition: IVxDriver.h:45
VxSdk::IVxDriver::type
char type[64]
The driver type identifier.
Definition: IVxDriver.h:41
VxSdk::IVxDriver::name
char name[64]
The friendly name of the driver.
Definition: IVxDriver.h:37
VxSdk::IVxDriver::version
char version[64]
The driver version number.
Definition: IVxDriver.h:49
virtual VxResult::Value VxSdk::IVxDriver::Delete ( ) const
pure virtual

Deletes this instance.

Returns
The Result of deleting this instance.
virtual VxResult::Value VxSdk::IVxDriver::GetDataStorage ( IVxDataStorage *&  dataStorage) const
pure virtual

Gets the IVxDataStorage that hosts this driver.

Parameters
dataStorageThe host IVxDataStorage.
Returns
The Result of the request.
virtual VxResult::Value VxSdk::IVxDriver::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.

Member Data Documentation

char VxSdk::IVxDriver::name[64]

The friendly name of the driver.

Definition at line 37 of file IVxDriver.h.

char VxSdk::IVxDriver::type[64]

The driver type identifier.

Definition at line 41 of file IVxDriver.h.

char VxSdk::IVxDriver::vendor[64]

The name of the vendor that manufactured the device that the driver is for.

Definition at line 45 of file IVxDriver.h.

char VxSdk::IVxDriver::version[64]

The driver version number.

Definition at line 49 of file IVxDriver.h.

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