CPPCli::Driver Class Reference

The Driver class represents a device communication driver. More...

#include <Driver.h>

Public Member Functions
	Driver (VxSdk::IVxDriver *vxDriver)
	Constructor. More...
virtual	~Driver ()
	Destructor. More...
	!Driver ()
	Finaliser. More...
Results::Value	Refresh ()
	Refreshes this instances properties. More...

Package Functions
CPPCli::DataStorage^	_GetDataStorage ()

Package Attributes
VxSdk::IVxDriver *	_driver

Properties
CPPCli::DataStorage^	DataStorage [get]
	Gets the data storage that hosts this driver. More...
System::String^	Name [get]
	Gets the friendly name of the driver. More...
System::String^	Type [get]
	Gets the driver type identifier. More...
System::String^	Vendor [get]
	Gets the name of the vendor that manufactured the device that the driver is for. More...
System::String^	Version [get]
	Gets the driver version number. More...

Detailed Description

The Driver class represents a device communication driver.

Definition at line 14 of file Driver.h.

Constructor & Destructor Documentation

CPPCli::Driver::Driver

(

VxSdk::IVxDriver *

vxDriver

)

Constructor.

Parameters

vxDriver

The vx driver.

Definition at line 9 of file Driver.cpp.

                                             {
    _driver = vxDriver;
}

virtual CPPCli::Driver::~Driver ( )

inlinevirtual

Destructor.

Definition at line 26 of file Driver.h.

                          {
            this->!Driver();
        }

CPPCli::Driver::!Driver

(

)

Finaliser.

Definition at line 13 of file Driver.cpp.

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

Member Function Documentation

CPPCli::DataStorage CPPCli::Driver::_GetDataStorage ( )

package

Definition at line 22 of file Driver.cpp.

                                                 {
    // Get the data storage which hosts this driver
    VxSdk::IVxDataStorage* dataStorage = nullptr;
    VxSdk::VxResult::Value result = _driver->GetDataStorage(dataStorage);

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

    return nullptr;
}

CPPCli::Results::Value CPPCli::Driver::Refresh

(

)

Refreshes this instances properties.

Returns

The Result of updating the properties.

Definition at line 18 of file Driver.cpp.

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

Member Data Documentation

VxSdk::IVxDriver* CPPCli::Driver::_driver

package

Definition at line 87 of file Driver.h.

Property Documentation

CPPCli:: DataStorage^ CPPCli::Driver::DataStorage

get

Gets the data storage that hosts this driver.

The data storage.

Definition at line 45 of file Driver.h.

System:: String^ CPPCli::Driver::Name

get

Gets the friendly name of the driver.

The friendly name.

Definition at line 54 of file Driver.h.

System:: String^ CPPCli::Driver::Type

get

Gets the driver type identifier.

The driver type identifier.

Definition at line 63 of file Driver.h.

System:: String^ CPPCli::Driver::Vendor

get

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

The name of the vendor.

Definition at line 72 of file Driver.h.

System:: String^ CPPCli::Driver::Version

get

Gets the driver version number.

The version number.

Definition at line 81 of file Driver.h.

---

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

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