argos::CRandom::CCategory Class Reference

The RNG category. More...

#include <rng.h>

Public Member Functions
	CCategory (const std::string &str_id, UInt32 un_seed)
	Class constructor.
virtual	~CCategory ()
	Class destructor.
const std::string &	GetId () const throw ()
	Returns the id of the category.
void	SetId (const std::string &str_id)
	Sets the new id of the category.
UInt32	GetSeed () const
	Returns the seed of the category.
void	SetSeed (UInt32 un_seed)
	Sets the new seed of the category.
CRNG *	CreateRNG ()
	Creates a new RNG inside this category.
void	ResetRNGs ()
	Resets the RNGs in this category.
void	ReseedRNGs ()
	Sets new seed for the RNGs in this category.

Detailed Description

The RNG category.

This class stores a specific category of RNGs.

Definition at line 244 of file rng.h.

Constructor & Destructor Documentation

CCategory()

argos::CRandom::CCategory::CCategory	(	const std::string &	str_id,
		UInt32	un_seed )

Class constructor.

Parameters

str_id	the id of the category.
un_seed	the seed of the category.

Definition at line 236 of file rng.cpp.

~CCategory()

argos::CRandom::CCategory::~CCategory ( )

virtual

Class destructor.

Definition at line 246 of file rng.cpp.

Member Function Documentation

CreateRNG()

CRandom::CRNG * argos::CRandom::CCategory::CreateRNG

(

)

Creates a new RNG inside this category.

Returns

the pointer to a new RNG inside this category.

Definition at line 264 of file rng.cpp.

GetId()

const std::string & argos::CRandom::CCategory::GetId ( ) const throw (  )

inline

Returns the id of the category.

Returns

the id of the category.

Definition at line 265 of file rng.h.

GetSeed()

UInt32 argos::CRandom::CCategory::GetSeed ( ) const

inline

Returns the seed of the category.

Returns

the seed of the category.

Definition at line 280 of file rng.h.

ReseedRNGs()

void argos::CRandom::CCategory::ReseedRNGs

(

)

Sets new seed for the RNGs in this category.

This method does not reset the RNGs. You must call Reset() explicitly.

See also

Reset()

Definition at line 288 of file rng.cpp.

ResetRNGs()

void argos::CRandom::CCategory::ResetRNGs

(

)

Resets the RNGs in this category.

Definition at line 275 of file rng.cpp.

SetId()

void argos::CRandom::CCategory::SetId ( const std::string & str_id )

inline

Sets the new id of the category.

Parameters

str_id

the new id of the category.

Definition at line 272 of file rng.h.

SetSeed()

void argos::CRandom::CCategory::SetSeed

(

UInt32

un_seed

)

Sets the new seed of the category.

This method does not reset the RNGs. You must call Reset() explicitly.

Parameters

un_seed

the new seed of the category.

See also

Reset()

Definition at line 256 of file rng.cpp.

---

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

• core/utility/math/rng.h
• core/utility/math/rng.cpp