Reinforcement Learning Toolbox 2.0
last updated:
General
Documentation
Manual
Tutorial
Class Reference
Master Thesis
Examples
Related Papers
Downloads
Links
News
mailto:webmaster
Main Page     Class Hierarchy   Compound List   File List   Compound Members   File Members

CStateCollectionList Class Reference

Class for storing a sequence of state collections. More...

#include <cstatecollection.h>

Inheritance diagram for CStateCollectionList:

CStateModifiersObject CStateObject List of all members.


Public Member Functions

  CStateCollectionList (CStateProperties *model)
  create a state collection list with "model" as the basic state for the collections

  CStateCollectionList (CStateProperties *model, std::list< CStateModifier * > *modifier)
  create a state collection list with "model" as the basic state for the collections and the modifiers already added

virtual  ~CStateCollectionList ()
void  clearStateLists ()
  clears alls state lists

void  addStateCollection (CStateCollection *stateCollection)
  add state collection to the list.

void  getStateCollection (int index, CStateCollectionImpl *stateCollection)
  retrieve collection from the list.

void  removeLastStateCollection ()
CStateList getStateList (CStateProperties *properties)
void  getState (int index, CState *state)
  get a State directly from the collection list, without the need of an state collection.

virtual void  addStateModifier (CStateModifier *modifier)
  add a state modifier to the collection list.

virtual void  removeStateModifier (CStateModifier *modifier)
  remove state modifier from the list, the coresponding state list is deleted

void  loadASCII (FILE *stream)
void  saveASCII (FILE *stream)
void  loadBIN (FILE *stream)
void  saveBIN (FILE *stream)
int  getNumStateCollections ()


Protected Attributes

std::list< CStateList * > *  stateLists
  the list of state lists


Detailed Description

Class for storing a sequence of state collections.

This class is able to store a sequence of state collections, all state collections added to the list are supposed to have the same state modifiers. For storing the collection it uses a list of CStateList objects, for each state in the collection there is a state list. When a state collection is added, the collection is split into its states and the states are added to the state lists.

When retrieving a state collection from the list, only the states which are member of the given state collection get set in the collection, no new state modifiers get added.

See also:
CStateList

Constructor & Destructor Documentation

CStateCollectionList::CStateCollectionList CStateProperties model  ) 
 

create a state collection list with "model" as the basic state for the collections

CStateCollectionList::CStateCollectionList CStateProperties model,
std::list< CStateModifier * > *  modifier
 

create a state collection list with "model" as the basic state for the collections and the modifiers already added

virtual CStateCollectionList::~CStateCollectionList  )  [virtual]
 

Member Function Documentation

void CStateCollectionList::addStateCollection CStateCollection stateCollection  ) 
 

add state collection to the list.

the collection is split into its states and the states are added to the statelists.

virtual void CStateCollectionList::addStateModifier CStateModifier modifier  )  [virtual]
 

add a state modifier to the collection list.

An own statelist is created for that modifier

Reimplemented from CStateModifiersObject.

void CStateCollectionList::clearStateLists  ) 
 

clears alls state lists

int CStateCollectionList::getNumStateCollections  ) 
 
void CStateCollectionList::getState int  index,
CState state
 

get a State directly from the collection list, without the need of an state collection.

void CStateCollectionList::getStateCollection int  index,
CStateCollectionImpl stateCollection
 

retrieve collection from the list.

When retrieving a state collection from the list, only the states which are member of the given state collection get set in the collection, no new state modifiers get added

CStateList* CStateCollectionList::getStateList CStateProperties properties  ) 
 
void CStateCollectionList::loadASCII FILE *  stream  ) 
 
void CStateCollectionList::loadBIN FILE *  stream  ) 
 
void CStateCollectionList::removeLastStateCollection  ) 
 
virtual void CStateCollectionList::removeStateModifier CStateModifier modifier  )  [virtual]
 

remove state modifier from the list, the coresponding state list is deleted

Reimplemented from CStateModifiersObject.

void CStateCollectionList::saveASCII FILE *  stream  ) 
 
void CStateCollectionList::saveBIN FILE *  stream  ) 
 

Member Data Documentation

std::list<CStateList *>* CStateCollectionList::stateLists [protected]
 

the list of state lists


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