PPL API Reference
Overview Core Algorithm Abstractions Utilities Parallel Methods
Modules Class Hierarchy Classes Functions
Todo List Bug List Dead Code
List of all members
RobotGroup Class Referencefinal

A group of one or more robots. More...

Public Member Functions

Construction
 RobotGroup (MPProblem *const _problem, const std::string &_label, const std::vector< Robot * > &_robots)
 
 RobotGroup (MPProblem *const _problem, XMLNode &_node)
 
Accessors
std::string GetLabel () const noexcept
 Get the group label.
 
RobotGetRobot (const size_t _index) const noexcept
 Get a robot by index.
 
RobotGetRobot (const std::string &_label) const noexcept
 Get a robot by label.
 
const std::vector< Robot * > & GetRobots () const noexcept
 Get all robots.
 
size_t GetGroupIndex (Robot *const _robot) const noexcept
 
bool VerifyRobotInGroup (Robot *const _robot) const noexcept
 Check whether the robot is in the group or not.
 
size_t Size () const noexcept
 Get the number of robots in the group.
 
size_t TotalDofs () const noexcept
 Get the number of DOFs accumulated over all robots.
 
Iteration

Iterate over the robots in the group.

iterator begin () noexcept
 
iterator end () noexcept
 
const_iterator begin () const noexcept
 
const_iterator end () const noexcept
 

Public Types

Local Types
typedef std::vector< Robot * >::iterator iterator
 
typedef std::vector< Robot * >::const_iterator const_iterator
 

Detailed Description

A group of one or more robots.

Constructor & Destructor Documentation

◆ RobotGroup() [1/2]

RobotGroup::RobotGroup ( MPProblem *const  _problem,
const std::string &  _label,
const std::vector< Robot * > &  _robots 
)

Construct a group from a set of robots.

Parameters
_problemThe owning MPProblem.
_labelThe group label.
_robotThe set of robots in this group.

◆ RobotGroup() [2/2]

RobotGroup::RobotGroup ( MPProblem *const  _problem,
XMLNode _node 
)

Construct a group from an XML node. The referenced robots must be specified before the group in the XML file.

Parameters
_problemThe owning MPProblem.
_nodeThe XML node.

Member Function Documentation

◆ GetGroupIndex()

size_t RobotGroup::GetGroupIndex ( Robot *const  _robot) const
noexcept

Get the group index for a robot.

Note
This is NOT the index in the MPProblem.

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