OpenZWave Library  1.4.3016
Public Member Functions | List of all members
OpenZWave::HidController Class Reference

#include <HidController.h>

+ Inheritance diagram for OpenZWave::HidController:
+ Collaboration diagram for OpenZWave::HidController:

Public Member Functions

 HidController ()
 
virtual ~HidController ()
 
bool SetVendorId (uint32 const _vendorId)
 
bool SetProductId (uint32 const _productId)
 
bool SetSerialNumber (string const &_serialNumber)
 
bool Open (string const &_hidControllerName)
 
bool Close ()
 
uint32 Write (uint8 *_buffer, uint32 _length)
 
 HidController ()
 
virtual ~HidController ()
 
bool SetVendorId (uint32 const _vendorId)
 
bool SetProductId (uint32 const _productId)
 
bool SetSerialNumber (string const &_serialNumber)
 
bool Open (string const &_hidControllerName)
 
bool Close ()
 
uint32 Write (uint8 *_buffer, uint32 _length)
 
- Public Member Functions inherited from OpenZWave::Controller
 Controller ()
 
virtual ~Controller ()
 
void PlayInitSequence (Driver *_driver)
 
uint32 Read (uint8 *_buffer, uint32 _length)
 
- Public Member Functions inherited from OpenZWave::Stream
 Stream (uint32 _bufferSize)
 
void SetSignalThreshold (uint32 _size)
 
bool Get (uint8 *_buffer, uint32 _size)
 
bool Put (uint8 *_buffer, uint32 _size)
 
uint32 GetDataSize () const
 
void Purge ()
 
- Public Member Functions inherited from OpenZWave::Wait
void AddWatcher (pfnWaitNotification_t _callback, void *_context)
 
void RemoveWatcher (pfnWaitNotification_t _callback, void *_context)
 
- Public Member Functions inherited from OpenZWave::Ref
 Ref ()
 
void AddRef ()
 
int32 Release ()
 

Additional Inherited Members

- Public Types inherited from OpenZWave::Wait
enum  { Timeout_Immediate = 0, Timeout_Infinite = -1 }
 
typedef void(* pfnWaitNotification_t) (void *_context)
 
- Static Public Member Functions inherited from OpenZWave::Wait
static int32 Single (Wait *_object, int32 _timeout=-1)
 
static int32 Multiple (Wait **_objects, uint32 _numObjects, int32 _timeout=-1)
 
- Protected Member Functions inherited from OpenZWave::Stream
void LogData (uint8 *_buffer, uint32 _size, const string &_function)
 
virtual bool IsSignalled ()
 
 ~Stream ()
 
- Protected Member Functions inherited from OpenZWave::Wait
 Wait ()
 
virtual ~Wait ()
 
void Notify ()
 
- Protected Member Functions inherited from OpenZWave::Ref
virtual ~Ref ()
 

Constructor & Destructor Documentation

HidController::HidController ( )

Constructor. Creates an object that represents a HID port.

HidController::~HidController ( )
virtual

Destructor. Destroys the HID port object.

OpenZWave::HidController::HidController ( )

Constructor. Creates an object that represents a HID port.

virtual OpenZWave::HidController::~HidController ( )
virtual

Destructor. Destroys the HID port object.

Member Function Documentation

bool OpenZWave::HidController::Close ( )
virtual

Close a HID port. Closes the HID port.

Returns
True if the port was closed successfully, or false if the port was already closed, or an error occurred.
See also
Open

Implements OpenZWave::Controller.

bool HidController::Close ( )
virtual

Close a HID port. Closes the HID port.

Returns
True if the port was closed successfully, or false if the port was already closed, or an error occurred.
See also
Open

Implements OpenZWave::Controller.

bool OpenZWave::HidController::Open ( string const &  _hidControllerName)
virtual

Open a HID port. Attempts to open a HID port and initialize it with the specified paramters.

Parameters
_HidControllerNameThe name of the port to open. For example, ttyS1 on Linux, or \. in Windows.
Returns
True if the port was opened and configured successfully.
See also
Close, Read, Write

Implements OpenZWave::Controller.

bool HidController::Open ( string const &  _hidControllerName)
virtual

Open a HID port. Attempts to open a HID port and initialize it with the specified parameters.

Parameters
_HidControllerNameThe name of the port to open. For example, ttyS1 on Linux, or \. in Windows.
Returns
True if the port was opened and configured successfully.
See also
Close, Read, Write

Implements OpenZWave::Controller.

bool OpenZWave::HidController::SetProductId ( uint32 const  _productId)

Set the USB product ID search value. The HID port must be closed for the setting to be accepted.

Parameters
_parityProduct ID value to match when enumerating USB HID devices.
Returns
True if the product ID value was accepted.
See also
Open, Close
bool HidController::SetProductId ( uint32 const  _productId)

Set the USB product ID search value. The HID port must be closed for the setting to be accepted.

Parameters
_parityProduct ID value to match when enumerating USB HID devices.
Returns
True if the product ID value was accepted.
See also
Open, Close
bool OpenZWave::HidController::SetSerialNumber ( string const &  _serialNumber)

Set the USB serial number search value. The HID port must be closed for the setting to be accepted.

Parameters
_paritySerial number string to match when enumerating USB HID devices. If empty, any serial number will be accepted.
Returns
True if the serial number value was accepted.
See also
Open, Close
bool HidController::SetSerialNumber ( string const &  _serialNumber)

Set the USB serial number search value. The HID port must be closed for the setting to be accepted.

Parameters
_paritySerial number string to match when enumerating USB HID devices. If empty, any serial number will be accepted.
Returns
True if the serial number value was accepted.
See also
Open, Close
bool OpenZWave::HidController::SetVendorId ( uint32 const  _vendorId)

Set the USB vendor ID search value. The HID port must be closed for the setting to be accepted.

Parameters
_baudVendor ID value to match when enumerating USB HID devices.
Returns
True if the vendor ID value was accepted.
See also
Open, Close
bool HidController::SetVendorId ( uint32 const  _vendorId)

Set the USB vendor ID search value. The HID port must be closed for the setting to be accepted.

Parameters
_baudVendor ID value to match when enumerating USB HID devices.
Returns
True if the vendor ID value was accepted.
See also
Open, Close
uint32 OpenZWave::HidController::Write ( uint8 _buffer,
uint32  _length 
)
virtual

Write to a HID port. Attempts to write data to an open HID port.

Parameters
_bufferPointer to a block of memory containing the data to be written.
_lengthLength in bytes of the data.
Returns
The number of bytes written.
See also
Read, Open, Close

Implements OpenZWave::Controller.

uint32 HidController::Write ( uint8 _buffer,
uint32  _length 
)
virtual

Write to a HID port. Attempts to write data to an open HID port.

Parameters
_bufferPointer to a block of memory containing the data to be written.
_lengthLength in bytes of the data.
Returns
The number of bytes written.
See also
Read, Open, Close

Implements OpenZWave::Controller.


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