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 | Static Public Attributes | List of all members
rcsc::CLangUnumSet Class Reference

set of uniform number More...

#include <clang_unum.h>

Public Types

typedef std::shared_ptr< CLangUnumSetPtr
 smart pointer type
 
typedef std::set< int > Set
 set container type
 

Public Member Functions

 CLangUnumSet ()
 create empty uniform number set.
 
 CLangUnumSet (const Set &unum_set)
 create with uniform number set. More...
 
 CLangUnumSet (const int unum)
 create with an uniform number. More...
 
const Setentries () const
 get entry numbers More...
 
void add (const int unum)
 add new entry More...
 
bool isAll () const
 check if the set contains '0' that indicates all uniform number. More...
 
bool contains (const int unum) const
 check if the set contains the uniform number. More...
 
std::ostream & print (std::ostream &os) const
 output clang format message More...
 

Static Public Attributes

static const int All
 

Detailed Description

set of uniform number

Constructor & Destructor Documentation

◆ CLangUnumSet() [1/2]

rcsc::CLangUnumSet::CLangUnumSet ( const Set unum_set)
inlineexplicit

create with uniform number set.

Parameters
unum_setuniform number set.

◆ CLangUnumSet() [2/2]

rcsc::CLangUnumSet::CLangUnumSet ( const int  unum)
inlineexplicit

create with an uniform number.

Parameters
unumuniform number entry.

Member Function Documentation

◆ add()

void rcsc::CLangUnumSet::add ( const int  unum)
inline

add new entry

Parameters
unumadded uniform number

◆ contains()

bool rcsc::CLangUnumSet::contains ( const int  unum) const
inline

check if the set contains the uniform number.

Parameters
unumchecked uniform number
Returns
checked result

◆ entries()

const Set & rcsc::CLangUnumSet::entries ( ) const
inline

get entry numbers

Returns
the set of uniform numbers

◆ isAll()

bool rcsc::CLangUnumSet::isAll ( ) const
inline

check if the set contains '0' that indicates all uniform number.

Returns
checked result

◆ print()

std::ostream & rcsc::CLangUnumSet::print ( std::ostream &  os) const

output clang format message

Parameters
osreference to the output stream
Returns
os reference to the output stream

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