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::ContainsPlayerPredicate< T > Class Template Reference

check if target player is in region More...

#include <player_predicate.h>

Inheritance diagram for rcsc::ContainsPlayerPredicate< T >:
Inheritance graph
[legend]
Collaboration diagram for rcsc::ContainsPlayerPredicate< T >:
Collaboration graph
[legend]

Public Member Functions

 ContainsPlayerPredicate (const T &region)
 construct with the geometry object More...
 
bool operator() (const AbstractPlayerObject &p) const
 predicate function More...
 
PlayerPredicate::Ptr clone () const
 create clone object. More...
 
- Public Member Functions inherited from rcsc::PlayerPredicate
virtual ~PlayerPredicate ()
 virtual destructor
 
virtual bool operator() (const AbstractPlayerObject &p) const =0
 predicate function More...
 
virtual Ptr clone () const =0
 create clone object. More...
 

Additional Inherited Members

- Public Types inherited from rcsc::PlayerPredicate
typedef std::shared_ptr< PlayerPredicatePtr
 smart pointer type
 
typedef std::shared_ptr< const PlayerPredicateConstPtr
 const smart pointer type
 
- Protected Member Functions inherited from rcsc::PlayerPredicate
 PlayerPredicate ()
 protected constructor
 

Detailed Description

template<typename T>
class rcsc::ContainsPlayerPredicate< T >

check if target player is in region

Constructor & Destructor Documentation

◆ ContainsPlayerPredicate()

template<typename T >
rcsc::ContainsPlayerPredicate< T >::ContainsPlayerPredicate ( const T &  region)
inline

construct with the geometry object

Parameters
geomgeometry object for checking

Member Function Documentation

◆ clone()

template<typename T >
PlayerPredicate::Ptr rcsc::ContainsPlayerPredicate< T >::clone ( ) const
inlinevirtual

create clone object.

Returns
cloned object.

Implements rcsc::PlayerPredicate.

◆ operator()()

template<typename T >
bool rcsc::ContainsPlayerPredicate< T >::operator() ( const AbstractPlayerObject p) const
inlinevirtual

predicate function

Parameters
pconst reference to the target player object
Returns
true if target player is in the region

Implements rcsc::PlayerPredicate.


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