GroupTask Class Reference

Public Member Functions
Property Accessors
RobotGroup *	GetRobotGroup () const noexcept
	Get the robot associated with this task.
void	SetRobotGroup (RobotGroup *const _r)
const std::string &	GetLabel () const noexcept
	Get the semantic label for this task.
void	SetLabel (const std::string &_label) noexcept
	Set the semantic label for this task.
size_t	Size () const noexcept
	Get the number of individual tasks within this group task.
bool	Empty () const noexcept
nonstd::status &	GetStatus () noexcept
	Get the status object for this task.
const nonstd::status &	GetStatus () const noexcept
Individual Tasks
Access, modify, and iterate over the individual tasks.
size_t	GetNumGoals () const noexcept
	Get the number of goals in the longest (most goals) task.
void	AddTask (const MPTask &_t)
iterator	RemoveTask (iterator _iter)
iterator	begin () noexcept
iterator	end () noexcept
const_iterator	begin () const noexcept
	Get iterator to beginning of tasks.
const_iterator	end () const noexcept
	Get iterator to end of tasks.
Constraint Accessors
void	GetStartConstraintCenter (GroupCfg &_center) const noexcept
Constraint Evaluation
bool	EvaluateStartConstraints (const GroupCfg &_cfg) const
bool	EvaluatePathConstraints (const GroupCfg &_cfg) const
bool	EvaluateGoalConstraints (const GroupCfg &_cfg) const
bool	EvaluateGoalConstraints (const GroupCfg &_cfg, const size_t _index) const

Public Types
Local Types
typedef std::vector< MPTask >	TaskSet
	A set of individual tasks.
typedef TaskSet::iterator	iterator
typedef TaskSet::const_iterator	const_iterator

Disassembly Items
To be moved to a specialized derived class.
RobotGroup *	GetEndEffectorGroup () const noexcept
	Get the optional manipulator robot group associated with this task.
RobotGroup *	GetManipulatorGroup () const noexcept
	Get the optional manipulator robot group associated with this task.
Robot *	GetEndEffectorRobot ()
	Get the robot pointer for the (optional) end effector for the group task.
Robot *	GetManipulatorRobot ()
	Get the robot pointer for the (optional) manipulator for this group task.

Construction
	GroupTask (RobotGroup *const _robotGroup)
	GroupTask (MPProblem *const _problem, XMLNode &_node)
virtual	~GroupTask ()
static std::unique_ptr< GroupTask >	Factory (MPProblem *const _problem, XMLNode &_node)

Detailed Description

Describes a motion task for a group of robots as a set of individual tasks.

The individual tasks may be assigned to specific robots in the group, or they may be completable by any robot in the group.

Note

The goals are 'right-aligned' in that we assume that all robots must reach their last goal together.

Assigning a group task to another group will clear any assignments of robots to individual tasks because there is no universal way to map the new robots to the same set of tasks. The new group may be smaller/larger, have different labels/capabilities, etc.

Todo:

Move disassembly-specific items to a derived class specifically for disassembly tasks.

Constructor & Destructor Documentation

GroupTask() [1/2]

GroupTask::GroupTask ( RobotGroup *const  _robotGroup )

explicit

Create an empty task for a given robot.

Parameters

_robotGroup

The robot group assigned to this task.

GroupTask() [2/2]

GroupTask::GroupTask ( MPProblem *const  _problem, XMLNode &  _node  )

explicit

Parse the set of task constraints described in an XML node and verify that tasks are assigned to robots in group.

Parameters

_problem	The MPProblem for this task.
_node	The XML node to parse.

Member Function Documentation

Factory()

std::unique_ptr< GroupTask > GroupTask::Factory ( MPProblem *const  _problem, XMLNode &  _node  )

static

Generate a group task of the appropriate type.

Parameters

_problem	The MPProblem for this task.
_node	The XML node to parse.

SetRobotGroup()

void GroupTask::SetRobotGroup

(

RobotGroup *const

_r

)

Assign this task to another robot group. If the new group is different, all individual tasks will have their robot pointers cleared (since there is no universal means of mapping the individual tasks to the new robots).

Parameters

_r	The destination robot which will receive this assignment.

Empty()

bool GroupTask::Empty ( ) const

noexcept

Check if there are no individual tasks.

Returns

False if no tasks or all tasks empty

AddTask()

void GroupTask::AddTask

(

const MPTask &

_t

)

Add an individual task.

Parameters

_t	The individual task to add.

RemoveTask()

GroupTask::iterator GroupTask::RemoveTask

(

iterator

_iter

)

Remove an individual task.

Parameters

_iter

An iterator to the task to remove.

Returns

An iterator to the following element.

GetStartConstraintCenter()

void GroupTask::GetStartConstraintCenter ( GroupCfg &  _center ) const

noexcept

Uses the robot group in _center to populate all of the individual cfgs in that group cfg.

Todo:

This is a hack that was needed to move the disassembly work forward before we had flushed out the tasks/groups. To be removed at the earliest opportunity.

Parameters

_center

Robot group to populate from

EvaluateStartConstraints()

bool GroupTask::EvaluateStartConstraints

(

const GroupCfg &

_cfg

)

const

Evaluate whether a configuration satisfies the start constraints.

Parameters

_cfg	The configuration to check.

Returns

True if each robot satsifies its individual start constraints at _cfg.

EvaluatePathConstraints()

bool GroupTask::EvaluatePathConstraints

(

const GroupCfg &

_cfg

)

const

Evaluate whether a configuration satisfies the path constraints.

Parameters

_cfg	The configuration to check.

Returns

True if each robot satsifies its individual path constraints at _cfg.

EvaluateGoalConstraints() [1/2]

bool GroupTask::EvaluateGoalConstraints

(

const GroupCfg &

_cfg

)

const

Evaluate whether a configuration satisfies the final goal constraints.

Parameters

_cfg	The configuration to check.

Returns

True if each robot satsifies its last individual goal constraints at _cfg.

EvaluateGoalConstraints() [2/2]

bool GroupTask::EvaluateGoalConstraints	(	const GroupCfg &	_cfg,
		const size_t	_index
	)		const

Evaluate whether a configuration satisfies the constraints for a designated goal.

Parameters

_cfg	The configuration to check.
_index	The goal index to check.

Returns

True if each robot satsifies its individual goal constraints at _cfg for goal _index.

---

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

• GroupTask.h
• GroupTask.cpp