DeviceBase Class Reference

#include <RobotAPI/components/units/RobotUnit/Devices/DeviceBase.h>

+ Inheritance diagram for DeviceBase:

Public Member Functions

 DeviceBase (const std::string &name)
 Create a Device with the given name. More...
 
const std::string & getDeviceName () const
 
const std::set< std::string > & getTags () const
 
virtual bool hasError ()
 
bool hasTag (const std::string &tag) const
 
const char * rtGetDeviceName () const
 
virtual ~DeviceBase ()=default
 

Protected Member Functions

void addDeviceTag (const std::string &tag)
 adds the given tag to the Device More...
 

Detailed Description

Definition at line 29 of file DeviceBase.h.

Constructor & Destructor Documentation

◆ DeviceBase()

DeviceBase ( const std::string &  name)
inline

Create a Device with the given name.

Definition at line 33 of file DeviceBase.h.

◆ ~DeviceBase()

virtual ~DeviceBase ( )
virtualdefault

Member Function Documentation

◆ addDeviceTag()

void addDeviceTag ( const std::string &  tag)
inlineprotected

adds the given tag to the Device

Definition at line 70 of file DeviceBase.h.

◆ getDeviceName()

const std::string & getDeviceName ( ) const
inline
Returns
The Device's name

Definition at line 76 of file DeviceBase.h.

+ Here is the caller graph for this function:

◆ getTags()

const std::set< std::string > & getTags ( ) const
inline
Returns
Thes set of tags for this Device

Definition at line 88 of file DeviceBase.h.

+ Here is the caller graph for this function:

◆ hasError()

virtual bool hasError ( )
inlinevirtual

Definition at line 48 of file DeviceBase.h.

◆ hasTag()

bool hasTag ( const std::string &  tag) const
inline
Returns
Whether the device has the given tag

Definition at line 64 of file DeviceBase.h.

+ Here is the call graph for this function:

◆ rtGetDeviceName()

const char * rtGetDeviceName ( ) const
inline
Returns
The Device's name

Definition at line 82 of file DeviceBase.h.


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