YARP
Yet Another Robot Platform
yarp::robotinterface Namespace Reference

Namespaces

 experimental
 
 impl
 

Classes

class  Action
 
class  Device
 
class  RobotInterfaceDTD
 
class  Param
 
class  Robot
 
class  XMLReaderResult
 Result of the parsing of XMLReader. More...
 
class  XMLReader
 

Typedefs

typedef std::vector< robotinterface::ParamParamList
 
typedef std::vector< robotinterface::ActionActionList
 
typedef std::vector< robotinterface::DeviceDeviceList
 
typedef std::list< yarp::os::Thread * > ThreadList
 

Enumerations

enum  ActionPhase {
  ActionPhaseUnknown = 0 ,
  ActionPhaseStartup ,
  ActionPhaseRun ,
  ActionPhaseInterrupt1 ,
  ActionPhaseInterrupt2 ,
  ActionPhaseInterrupt3 ,
  ActionPhaseShutdown ,
  ActionPhaseReserved = 0xFF
}
 
enum  ActionType {
  ActionTypeUnknown = 0 ,
  ActionTypeConfigure ,
  ActionTypeCalibrate ,
  ActionTypeAttach ,
  ActionTypeAbort ,
  ActionTypeDetach ,
  ActionTypePark ,
  ActionTypeCustom = 0xFF
}
 

Functions

RobotInterfaceDTD::DocType StringToDocType (const std::string &type)
 
std::string DocTypeToString (RobotInterfaceDTD::DocType doctype)
 
bool hasParam (const robotinterface::ParamList &list, const std::string &name)
 
std::string findParam (const robotinterface::ParamList &list, const std::string &name)
 
bool hasGroup (const robotinterface::ParamList &list, const std::string &name)
 
std::string findGroup (const robotinterface::ParamList &list, const std::string &name)
 
robotinterface::ParamList mergeDuplicateGroups (const robotinterface::ParamList &list)
 
robotinterface::ActionPhase StringToActionPhase (const std::string &phase)
 
std::string ActionPhaseToString (robotinterface::ActionPhase actionphase)
 
void operator>> (const std::stringstream &sstream, robotinterface::ActionPhase &actionphase)
 
robotinterface::ActionType StringToActionType (const std::string &type)
 
std::string ActionTypeToString (robotinterface::ActionType actiontype)
 
void operator>> (const std::stringstream &sstream, robotinterface::ActionType &actiontype)
 

Typedef Documentation

◆ ActionList

Definition at line 31 of file Types.h.

◆ DeviceList

Definition at line 32 of file Types.h.

◆ ParamList

Definition at line 30 of file Types.h.

◆ ThreadList

Definition at line 33 of file Types.h.

Enumeration Type Documentation

◆ ActionPhase

Enumerator
ActionPhaseUnknown 
ActionPhaseStartup 
ActionPhaseRun 
ActionPhaseInterrupt1 
ActionPhaseInterrupt2 
ActionPhaseInterrupt3 
ActionPhaseShutdown 
ActionPhaseReserved 

Definition at line 41 of file Types.h.

◆ ActionType

Enumerator
ActionTypeUnknown 
ActionTypeConfigure 
ActionTypeCalibrate 
ActionTypeAttach 
ActionTypeAbort 
ActionTypeDetach 
ActionTypePark 
ActionTypeCustom 

Definition at line 60 of file Types.h.

Function Documentation

◆ ActionPhaseToString()

std::string yarp::robotinterface::ActionPhaseToString ( robotinterface::ActionPhase  actionphase)

Definition at line 99 of file Types.cpp.

◆ ActionTypeToString()

std::string yarp::robotinterface::ActionTypeToString ( robotinterface::ActionType  actiontype)

Definition at line 147 of file Types.cpp.

◆ DocTypeToString()

std::string yarp::robotinterface::DocTypeToString ( RobotInterfaceDTD::DocType  doctype)

Definition at line 55 of file RobotInterfaceDTD.cpp.

◆ findGroup()

std::string yarp::robotinterface::findGroup ( const robotinterface::ParamList list,
const std::string &  name 
)

Definition at line 47 of file Types.cpp.

◆ findParam()

std::string yarp::robotinterface::findParam ( const robotinterface::ParamList list,
const std::string &  name 
)

Definition at line 26 of file Types.cpp.

◆ hasGroup()

bool yarp::robotinterface::hasGroup ( const robotinterface::ParamList list,
const std::string &  name 
)

Definition at line 37 of file Types.cpp.

◆ hasParam()

bool yarp::robotinterface::hasParam ( const robotinterface::ParamList list,
const std::string &  name 
)

Definition at line 16 of file Types.cpp.

◆ mergeDuplicateGroups()

yarp::robotinterface::ParamList yarp::robotinterface::mergeDuplicateGroups ( const robotinterface::ParamList list)

Definition at line 58 of file Types.cpp.

◆ operator>>() [1/2]

void yarp::robotinterface::operator>> ( const std::stringstream &  sstream,
robotinterface::ActionPhase actionphase 
)

Definition at line 120 of file Types.cpp.

◆ operator>>() [2/2]

void yarp::robotinterface::operator>> ( const std::stringstream &  sstream,
robotinterface::ActionType actiontype 
)

Definition at line 170 of file Types.cpp.

◆ StringToActionPhase()

yarp::robotinterface::ActionPhase yarp::robotinterface::StringToActionPhase ( const std::string &  phase)

Definition at line 81 of file Types.cpp.

◆ StringToActionType()

yarp::robotinterface::ActionType yarp::robotinterface::StringToActionType ( const std::string &  type)

Definition at line 126 of file Types.cpp.

◆ StringToDocType()

RobotInterfaceDTD::DocType yarp::robotinterface::StringToDocType ( const std::string &  type)

Definition at line 38 of file RobotInterfaceDTD.cpp.