RobotNameHelper Class Reference

#include <RobotAPI/libraries/RobotStatechartHelpers/RobotNameHelper.h>

+ Inheritance diagram for RobotNameHelper:

Classes

class  Node
 

Public Types

using Arm = armarx::Arm
 
using RobotArm = armarx::RobotArm
 

Public Member Functions

Arm getArm (const std::string &side) const
 
const std::vector< std::string > & getProfiles () const
 
RobotArm getRobotArm (const std::string &side, const VirtualRobot::RobotPtr &robot) const
 
const RobotInfoNodePtr & getRobotInfoNodePtr () const
 
RobotNameHelperoperator= (const RobotNameHelper &)=default
 
RobotNameHelperoperator= (RobotNameHelper &&)=default
 
 RobotNameHelper (const RobotInfoNodePtr &robotInfo, const StatechartProfilePtr &profile=nullptr)
 
 RobotNameHelper (const RobotNameHelper &)=default
 
 RobotNameHelper (RobotNameHelper &&)=default
 
std::string select (const std::string &path) const
 

Static Public Member Functions

static RobotNameHelperPtr Create (const RobotInfoNodePtr &robotInfo, const StatechartProfilePtr &profile)
 
static RobotNameHelperPtr Create (const std::string &robotXmlFilename, const StatechartProfilePtr &profile=nullptr)
 
static void writeRobotInfoNode (const RobotInfoNodePtr &n, std::ostream &str, std::size_t indent=0, char indentChar=' ')
 

Static Public Attributes

static const std::string LocationLeft = "Left"
 
static const std::string LocationRight = "Right"
 

Detailed Description

Definition at line 145 of file RobotNameHelper.h.

Member Typedef Documentation

◆ Arm

using Arm = armarx::Arm

Definition at line 150 of file RobotNameHelper.h.

◆ RobotArm

Definition at line 151 of file RobotNameHelper.h.

Constructor & Destructor Documentation

◆ RobotNameHelper() [1/3]

RobotNameHelper ( const RobotInfoNodePtr &  robotInfo,
const StatechartProfilePtr profile = nullptr 
)

Definition at line 64 of file RobotNameHelper.cpp.

+ Here is the caller graph for this function:

◆ RobotNameHelper() [2/3]

RobotNameHelper ( RobotNameHelper &&  )
default

◆ RobotNameHelper() [3/3]

RobotNameHelper ( const RobotNameHelper )
default

Member Function Documentation

◆ Create() [1/2]

RobotNameHelperPtr Create ( const RobotInfoNodePtr &  robotInfo,
const StatechartProfilePtr profile 
)
static

Definition at line 96 of file RobotNameHelper.cpp.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ Create() [2/2]

RobotNameHelperPtr Create ( const std::string &  robotXmlFilename,
const StatechartProfilePtr profile = nullptr 
)
static

Definition at line 102 of file RobotNameHelper.cpp.

+ Here is the call graph for this function:

◆ getArm()

Arm getArm ( const std::string &  side) const

Definition at line 133 of file RobotNameHelper.cpp.

+ Here is the caller graph for this function:

◆ getProfiles()

const std::vector< std::string > & getProfiles ( ) const

Definition at line 385 of file RobotNameHelper.cpp.

◆ getRobotArm()

RobotArm getRobotArm ( const std::string &  side,
const VirtualRobot::RobotPtr robot 
) const

Definition at line 139 of file RobotNameHelper.cpp.

◆ getRobotInfoNodePtr()

const RobotInfoNodePtr & getRobotInfoNodePtr ( ) const

Definition at line 56 of file RobotNameHelper.cpp.

◆ operator=() [1/2]

RobotNameHelper& operator= ( const RobotNameHelper )
default

◆ operator=() [2/2]

RobotNameHelper& operator= ( RobotNameHelper &&  )
default

◆ select()

std::string select ( const std::string &  path) const

Definition at line 78 of file RobotNameHelper.cpp.

+ Here is the call graph for this function:

◆ writeRobotInfoNode()

void writeRobotInfoNode ( const RobotInfoNodePtr &  n,
std::ostream &  str,
std::size_t  indent = 0,
char  indentChar = ' ' 
)
static

Definition at line 39 of file RobotNameHelper.cpp.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Member Data Documentation

◆ LocationLeft

const std::string LocationLeft = "Left"
static

Definition at line 169 of file RobotNameHelper.h.

◆ LocationRight

const std::string LocationRight = "Right"
static

Definition at line 170 of file RobotNameHelper.h.


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