TwiceAsNice  2019-02-18
Public Types | Public Member Functions | List of all members
Basda::AnalogIODevice Class Referenceabstract

Generic Class for a IODevice. More...

#include <Device.h>

Inheritance diagram for Basda::AnalogIODevice:
Inheritance graph
Collaboration diagram for Basda::AnalogIODevice:
Collaboration graph

Public Types

enum  PortState {
  PORT_STATE_OFF = 0, PORT_STATE_ON = 1, PORT_STATE_UNKNOWN = -1, PORT_STATE_OFF = 0,
  PORT_STATE_ON = 1, PORT_STATE_UNKNOWN = -1, PORT_STATE_OFF = 0, PORT_STATE_ON = 1,
  PORT_STATE_UNKNOWN = -1
}
 
enum  PortState {
  PORT_STATE_OFF = 0, PORT_STATE_ON = 1, PORT_STATE_UNKNOWN = -1, PORT_STATE_OFF = 0,
  PORT_STATE_ON = 1, PORT_STATE_UNKNOWN = -1, PORT_STATE_OFF = 0, PORT_STATE_ON = 1,
  PORT_STATE_UNKNOWN = -1
}
 
enum  PortState {
  PORT_STATE_OFF = 0, PORT_STATE_ON = 1, PORT_STATE_UNKNOWN = -1, PORT_STATE_OFF = 0,
  PORT_STATE_ON = 1, PORT_STATE_UNKNOWN = -1, PORT_STATE_OFF = 0, PORT_STATE_ON = 1,
  PORT_STATE_UNKNOWN = -1
}
 

Public Member Functions

 AnalogIODevice (const Nice::JointPtr &_config)
 
virtual std::vector< double > read ()=0
 read from the device all ports. More...
 
virtual void write (std::vector< double >)=0
 
virtual enum PortState readOutputPort (int index)=0
 
virtual void setOutputPort (int portIndex, enum PortState desiredState)=0
 
virtual Nice::JointPtrVector description ()=0
 read description More...
 
virtual bool isReachable ()=0
 reachability More...
 
 AnalogIODevice (const Nice::JointPtr &_config)
 
virtual std::vector< double > read ()=0
 read from the device all ports. More...
 
virtual void write (std::vector< double >)=0
 
virtual enum PortState readOutputPort (int index)=0
 
virtual void setOutputPort (int portIndex, enum PortState desiredState)=0
 
virtual Nice::JointPtrVector description ()=0
 read description More...
 
virtual bool isReachable ()=0
 reachability More...
 
 AnalogIODevice (const Nice::JointPtr &_config)
 
virtual std::vector< double > read ()=0
 read from the device all ports. More...
 
virtual void write (std::vector< double >)=0
 
virtual enum PortState readOutputPort (int index)=0
 
virtual void setOutputPort (int portIndex, enum PortState desiredState)=0
 
virtual Nice::JointPtrVector description ()=0
 read description More...
 
virtual bool isReachable ()=0
 reachability More...
 
- Public Member Functions inherited from Basda::Device
 Device (const Nice::JointPtr &_config)
 constructor. This is an elementary (lazy) action which stores the name and gets configuration. More...
 
virtual ~Device ()
 destructor Does nothing More...
 
virtual void setConfig (const Nice::JointPtr &_config)
 init with config tree ptr More...
 
Nice::JointPtrconfig ()
 retrieve the property tree More...
 
std::string & name ()
 retrieve the name set at ctor time. More...
 
virtual void open ()=0
 open device More...
 
virtual void close ()=0
 close device More...
 
virtual void reset (DeviceAsync &=s_async)=0
 reset the device More...
 
virtual void version ()=0
 version More...
 
virtual void init (DeviceAsync &=s_async)=0
 init the device More...
 
virtual void deinit (DeviceAsync &=s_async)=0
 deinit the device More...
 
virtual void activate (DeviceAsync &=s_async)=0
 activate the device More...
 
virtual void deactivate (DeviceAsync &=s_async)=0
 deactivate the device More...
 
 Device (const Nice::JointPtr &_config)
 constructor. This is an elementary (lazy) action which stores the name and gets configuration. More...
 
virtual ~Device ()
 destructor Does nothing More...
 
virtual void setConfig (const Nice::JointPtr &_config)
 init with config tree ptr More...
 
Nice::JointPtrconfig ()
 retrieve the property tree More...
 
std::string & name ()
 retrieve the name set at ctor time. More...
 
virtual void open ()=0
 open device More...
 
virtual void close ()=0
 close device More...
 
virtual void reset (DeviceAsync &=s_async)=0
 reset the device More...
 
virtual void version ()=0
 version More...
 
virtual void init (DeviceAsync &=s_async)=0
 init the device More...
 
virtual void deinit (DeviceAsync &=s_async)=0
 deinit the device More...
 
virtual void activate (DeviceAsync &=s_async)=0
 activate the device More...
 
virtual void deactivate (DeviceAsync &=s_async)=0
 deactivate the device More...
 

Additional Inherited Members

- Static Public Attributes inherited from Basda::Device
static DeviceAsyncImpl s_async
 
- Protected Attributes inherited from Basda::Device
Nice::JointPtr m_config
 
Nice::JointPtr m_cfg
 
Nice::JointPtr m_var
 
std::string m_name
 

Detailed Description

Generic Class for a IODevice.

Author
Florian Briegel
Version
09.01.26
Date
2009-07-03 11:58:06 AM

Member Enumeration Documentation

◆ PortState [1/3]

Enumerator
PORT_STATE_OFF 
PORT_STATE_ON 
PORT_STATE_UNKNOWN 
PORT_STATE_OFF 
PORT_STATE_ON 
PORT_STATE_UNKNOWN 
PORT_STATE_OFF 
PORT_STATE_ON 
PORT_STATE_UNKNOWN 

◆ PortState [2/3]

Enumerator
PORT_STATE_OFF 
PORT_STATE_ON 
PORT_STATE_UNKNOWN 
PORT_STATE_OFF 
PORT_STATE_ON 
PORT_STATE_UNKNOWN 
PORT_STATE_OFF 
PORT_STATE_ON 
PORT_STATE_UNKNOWN 

◆ PortState [3/3]

Enumerator
PORT_STATE_OFF 
PORT_STATE_ON 
PORT_STATE_UNKNOWN 
PORT_STATE_OFF 
PORT_STATE_ON 
PORT_STATE_UNKNOWN 
PORT_STATE_OFF 
PORT_STATE_ON 
PORT_STATE_UNKNOWN 

Constructor & Destructor Documentation

◆ AnalogIODevice() [1/3]

Basda::AnalogIODevice::AnalogIODevice ( const Nice::JointPtr _config)
inline

◆ AnalogIODevice() [2/3]

Basda::AnalogIODevice::AnalogIODevice ( const Nice::JointPtr _config)
inline

◆ AnalogIODevice() [3/3]

Basda::AnalogIODevice::AnalogIODevice ( const Nice::JointPtr _config)
inline

Member Function Documentation

◆ description() [1/3]

virtual Nice::JointPtrVector Basda::AnalogIODevice::description ( )
pure virtual

read description

Implemented in mpia::FakeIoDevice, mpia::FakeIoDevice, and Basda::IODeviceWut.

◆ description() [2/3]

virtual Nice::JointPtrVector Basda::AnalogIODevice::description ( )
pure virtual

read description

Implemented in mpia::FakeIoDevice, mpia::FakeIoDevice, and Basda::IODeviceWut.

◆ description() [3/3]

virtual Nice::JointPtrVector Basda::AnalogIODevice::description ( )
pure virtual

read description

Implemented in mpia::FakeIoDevice, mpia::FakeIoDevice, and Basda::IODeviceWut.

◆ isReachable() [1/3]

virtual bool Basda::AnalogIODevice::isReachable ( )
pure virtual

reachability

Implemented in mpia::FakeIoDevice, Basda::IODeviceWut, and mpia::FakeIoDevice.

◆ isReachable() [2/3]

virtual bool Basda::AnalogIODevice::isReachable ( )
pure virtual

reachability

Implemented in mpia::FakeIoDevice, Basda::IODeviceWut, and mpia::FakeIoDevice.

◆ isReachable() [3/3]

virtual bool Basda::AnalogIODevice::isReachable ( )
pure virtual

reachability

Implemented in mpia::FakeIoDevice, Basda::IODeviceWut, and mpia::FakeIoDevice.

◆ read() [1/3]

virtual std::vector<double> Basda::AnalogIODevice::read ( )
pure virtual

read from the device all ports.

Implemented in mpia::FakeIoDevice, mpia::FakeIoDevice, Basda::IODeviceWutFake, and Basda::IODeviceWut.

◆ read() [2/3]

virtual std::vector<double> Basda::AnalogIODevice::read ( )
pure virtual

read from the device all ports.

Implemented in mpia::FakeIoDevice, mpia::FakeIoDevice, Basda::IODeviceWutFake, and Basda::IODeviceWut.

◆ read() [3/3]

virtual std::vector<double> Basda::AnalogIODevice::read ( )
pure virtual

read from the device all ports.

Implemented in mpia::FakeIoDevice, mpia::FakeIoDevice, Basda::IODeviceWutFake, and Basda::IODeviceWut.

◆ readOutputPort() [1/3]

virtual enum PortState Basda::AnalogIODevice::readOutputPort ( int  index)
pure virtual

◆ readOutputPort() [2/3]

virtual enum PortState Basda::AnalogIODevice::readOutputPort ( int  index)
pure virtual

◆ readOutputPort() [3/3]

virtual enum PortState Basda::AnalogIODevice::readOutputPort ( int  index)
pure virtual

◆ setOutputPort() [1/3]

virtual void Basda::AnalogIODevice::setOutputPort ( int  portIndex,
enum PortState  desiredState 
)
pure virtual

◆ setOutputPort() [2/3]

virtual void Basda::AnalogIODevice::setOutputPort ( int  portIndex,
enum PortState  desiredState 
)
pure virtual

◆ setOutputPort() [3/3]

virtual void Basda::AnalogIODevice::setOutputPort ( int  portIndex,
enum PortState  desiredState 
)
pure virtual

◆ write() [1/3]

virtual void Basda::AnalogIODevice::write ( std::vector< double >  )
pure virtual

◆ write() [2/3]

virtual void Basda::AnalogIODevice::write ( std::vector< double >  )
pure virtual

◆ write() [3/3]

virtual void Basda::AnalogIODevice::write ( std::vector< double >  )
pure virtual

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