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

abstract change view action More...

#include <soccer_action.h>

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

Public Types

typedef std::shared_ptr< ViewActionPtr
 smart pointer type
 

Public Member Functions

virtual ~ViewAction ()=default
 nothing to do, but should be virtual.
 
virtual bool execute (PlayerAgent *agent)=0
 pure virtual. set command to the action effector More...
 
virtual ViewActionclone () const =0
 create cloned action object More...
 
- Public Member Functions inherited from rcsc::AbstractAction
virtual ~AbstractAction ()=default
 nothing to do, but should be virtual.
 
virtual bool execute (PlayerAgent *agent)=0
 pure virtual. set command to the action effector More...
 
long actionObjectID () const
 get ID of action object to identify action instances More...
 

Protected Member Functions

 ViewAction ()=default
 nothing to do. but accessible only from derived classes.
 
- Protected Member Functions inherited from rcsc::AbstractAction
 AbstractAction ()
 nothing to do. but accessible only from derived classes.
 

Detailed Description

abstract change view action

Member Function Documentation

◆ clone()

virtual ViewAction * rcsc::ViewAction::clone ( ) const
pure virtual

create cloned action object

Returns
pointer to the cloned object instance.

◆ execute()

virtual bool rcsc::ViewAction::execute ( PlayerAgent agent)
pure virtual

pure virtual. set command to the action effector

Return values
trueif action is performed
falseif action is failed or not needed.

Implements rcsc::AbstractAction.


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