LIBRCSC Docs
Documentation for HELIOS's BASE LIBRCSC library for RoboCup 2D Simulation League.
All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros
Public Member Functions | List of all members
rcsc::SoccerIntentionQueue Class Reference

intention queue More...

#include <soccer_intention.h>

Inheritance diagram for rcsc::SoccerIntentionQueue:
Inheritance graph
[legend]
Collaboration diagram for rcsc::SoccerIntentionQueue:
Collaboration graph
[legend]

Public Member Functions

bool finished (const PlayerAgent *agent)
 check if this intention queue is finished or not More...
 
bool execute (PlayerAgent *agent)
 execute queued intention More...
 
void push (Ptr intention)
 push new intention More...
 
bool pop (PlayerAgent *agent)
 execute queued intention. More...
 
void clear ()
 clear queued intention.
 
- Public Member Functions inherited from rcsc::SoccerIntention
virtual ~SoccerIntention ()=default
 virtual destructor
 
virtual bool finished (const PlayerAgent *agent)=0
 (pure virtual) check if this intention is finished or not More...
 
virtual bool execute (PlayerAgent *agent)=0
 execute suitable action More...
 

Additional Inherited Members

- Public Types inherited from rcsc::SoccerIntention
typedef std::shared_ptr< SoccerIntentionPtr
 smart pointer type.
 
- Protected Member Functions inherited from rcsc::SoccerIntention
 SoccerIntention ()=default
 constructor is used only from derived class.
 

Detailed Description

intention queue

Member Function Documentation

◆ execute()

bool rcsc::SoccerIntentionQueue::execute ( PlayerAgent agent)
inlinevirtual

execute queued intention

Returns
result of action

Implements rcsc::SoccerIntention.

◆ finished()

bool rcsc::SoccerIntentionQueue::finished ( const PlayerAgent agent)
inlinevirtual

check if this intention queue is finished or not

Returns
true if intention is finished

Implements rcsc::SoccerIntention.

◆ pop()

bool rcsc::SoccerIntentionQueue::pop ( PlayerAgent agent)
inline

execute queued intention.

Parameters
agentagent object pointer
Return values
trueif action is executed
falseif queue is empty, or action is failed.

◆ push()

void rcsc::SoccerIntentionQueue::push ( Ptr  intention)
inline

push new intention

Parameters
intentiondynamic allocated intention pointer

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