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 | Protected Attributes
InteractionInformation Class Reference

Public Member Functions

Construction
 InteractionInformation (MPProblem *_problem, XMLNode &_node)
 
Accessors
std::string GetLabel () const
 Get label for handoff template.
 
size_t GetMaxAttempts () const
 Get max attempts for placing template in real environment.
 
MPProblemGetMPProblem () const
 Get MPProblem for handoff.
 
std::vector< std::shared_ptr< MPTask > > & GetInteractionTasks ()
 Get interaction tasks for handoff.
 
std::vector< std::shared_ptr< MPTask > > & GetTypeTasks (const std::string &_s)
 
double GetInteractionWeight () const
 Get interaction weight.
 
void AddTemplateLocation (Cfg _location)
 
std::vector< Cfg > & GetTemplateLocations ()
 Gets the set of locations to place ITs.
 
std::vector< CfgGetInteractionPositions ()
 Gets the final position of robots at each of the IT locations.
 
std::vector< std::pair< Cfg, Cfg > > GetInteractionPositionPairs ()
 
std::vector< std::vector< Cfg > > GetInteractionPaths ()
 Gets the paths of robots at each of the IT locations.
 
std::vector< CfgGetInteractionPosition (std::string _capability)
 Get the final position of robot of input capability.
 
std::vector< std::vector< Cfg > > GetInteractionPath (std::string _capability)
 Get the paths of robot of input capability.
 
bool SavedPaths ()
 
EnvironmentGetInteractionEnvironment ()
 Gets the environment to plan the interaction in.
 

Protected Attributes

MPProblemm_problem {nullptr}
 The handoff template problem.
 
std::vector< std::shared_ptr< MPTask > > m_tasks
 The set of tasks that must be performed to handoff.
 
std::unordered_map< std::string, std::vector< std::shared_ptr< MPTask > > > m_taskType
 The list of tasks stored by type.
 
std::string m_label
 The handoff label.
 
size_t m_maxAttempts
 The number of attempts to try and place the template in the environment.
 
double m_interactionWeight {0}
 The weight of the edge between interaction cfgs.
 
std::vector< Cfgm_handoffLocations
 The locations for manually placed handoffs.
 
std::unique_ptr< Environmentm_interactionEnvironment
 Environment to plan the interaction in.
 
bool m_savePaths
 

Detailed Description

This represents a Handoff Template, which stores the tasks required for robots to perform a handoff.

Constructor & Destructor Documentation

◆ InteractionInformation()

InteractionInformation::InteractionInformation ( MPProblem _problem,
XMLNode _node 
)

Parse tasks in Handoff template

Parameters
_problemMPProblem for Handoff
_nodeXMLNode to parse

Member Function Documentation

◆ GetTypeTasks()

std::vector< std::shared_ptr< MPTask > > & InteractionInformation::GetTypeTasks ( const std::string &  _s)

Get all tasks of the given type

Parameters
_sType of tasks desired

◆ AddTemplateLocation()

void InteractionInformation::AddTemplateLocation ( Cfg  _location)

Adds an addition location to place an IT

Parameters
_locationLocation to add to handoff locations

◆ GetInteractionPositionPairs()

std::vector< std::pair< Cfg, Cfg > > InteractionInformation::GetInteractionPositionPairs ( )

Gets the final position of robot pairs at each of the IT locations. First is the robot handing off. Second is robot receving.

◆ SavedPaths()

bool InteractionInformation::SavedPaths ( )

Get if paths are saved

Returns
True if paths are saved

Member Data Documentation

◆ m_savePaths

bool InteractionInformation::m_savePaths
protected

Indicates if the interaction template should save the entire paths of the interaction or just the final configurations.


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