ControlAPI::DeviceInfo Class Reference

Base Class for describing a device to be attached to a DeviceController. More...

#include <HC_API.h>

Inheritance diagram for ControlAPI::DeviceInfo:

Public Member Functions

virtual std::string className ()
 
bool preLoopCommandCheck (bool checkCancelled=true)
 
bool isConnected () const
 Returns true is the device is currently connected.
 
void setEnableCommandLogging (bool enable)
 set the device to log messages to the console. (default true) More...
 
void setCommandLoggingLevel (int level)
 Set the command logging level, 0 - regular, 1 - more detail, 2 - even more detail, etc. More...
 
bool commandLoggingEnabled () const
 
int commandLoggingLevel () const
 
virtual DeviceCommandPackage * initializeCommand (DeviceCommandPackage *commandPackage)
 
CommandStatus * addCommandGeneric (DeviceCommandPackage *package)
 
DeviceController * deviceController ()
 access to owning controller.
 
ControlSystem * controlSystem ()
 access to owning control system.
 

Static Public Member Functions

static std::string staticClassName ()
 

Friends

class ControlSystem
 
class DeviceController
 
class CommandStatus
 

Additional Inherited Members

- Public Attributes inherited from ControlAPI::HardwareInfo
int apiDeviceId = -1
 
std::string alias
 

Detailed Description

Base Class for describing a device to be attached to a DeviceController.

Member Function Documentation

◆ setCommandLoggingLevel()

void ControlAPI::DeviceInfo::setCommandLoggingLevel (int level)

Set the command logging level, 0 - regular, 1 - more detail, 2 - even more detail, etc.

Parameters
level

◆ setEnableCommandLogging()

void ControlAPI::DeviceInfo::setEnableCommandLogging (bool enable)

set the device to log messages to the console. (default true)

Parameters
enable

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