main page namespaces classes files
ELL home

ell::SPC_Listing Class Reference

#include <StatePairCollector.hh>

Inheritance diagram for ell::SPC_Listing:

[legend]

---

Detailed Description

This class stores an accessible list of all State pairs added to the collector.

Author:

Hannes Kochniss

Martin Mann

Definition at line 146 of file StatePairCollector.hh.

Public Types
typedef std::list< StatePair >	List
typedef std::pair< const State *, const State * >	StatePair
Public Member Functions
virtual void	add (const StatePair &s)=0
virtual void	add (const State *const s1, const State *const s2)
virtual void	add (const StatePair &s)
virtual const StatePair	getLastAdded () const
virtual const List &	getList () const
virtual size_t	size () const
	SPC_Listing ()
virtual	~SPC_Listing ()
Protected Attributes
List	statePairList

---

Member Typedef Documentation

typedef std::list<StatePair> ell::SPC_Listing::List

Definition at line 149 of file StatePairCollector.hh.

typedef std::pair<const State*,const State*> ell::StatePairCollector::StatePair [inherited]

a pair of States

Definition at line 27 of file StatePairCollector.hh.

---

Constructor & Destructor Documentation

ell::SPC_Listing::SPC_Listing

(

)

Definition at line 73 of file StatePairCollector.cc.

ell::SPC_Listing::~SPC_Listing

(

)

[virtual]

Definition at line 77 of file StatePairCollector.cc.

---

Member Function Documentation

virtual void ell::StatePairCollector::add

(

const StatePair &

s

)

[pure virtual, inherited]

This function makes the collector manage the given State pair.

Parameters:

s

the State pair to add

void ell::SPC_Listing::add	(	const State *const	s1,
		const State *const	s2
	)			[virtual]

Adds the given State pair to the list.

Parameters:

	s1	the first State of the pair to add
	s2	the second State of the pair to add

Implements ell::StatePairCollector.

Definition at line 103 of file StatePairCollector.cc.

void ell::SPC_Listing::add

(

const StatePair &

s

)

[virtual]

Adds the given State pair to the list.

Parameters:

s

the State pair to add

Definition at line 93 of file StatePairCollector.cc.

const SPC_Listing::StatePair ell::SPC_Listing::getLastAdded

(

)

const [virtual]

Returns last added State pair.

Returns:

last added State pair

Implements ell::StatePairCollector.

Definition at line 120 of file StatePairCollector.cc.

const SPC_Listing::List & ell::SPC_Listing::getList

(

)

const [virtual]

Returns a list of all added State pairs.

Returns:

the StatePair list

Definition at line 129 of file StatePairCollector.cc.

size_t ell::SPC_Listing::size

(

)

const [virtual]

Returns number of added State pairs.

Returns:

the number of added state pairs

Implements ell::StatePairCollector.

Definition at line 113 of file StatePairCollector.cc.

---

Field Documentation

List ell::SPC_Listing::statePairList [protected]

the internal storage of all added state pairs

Definition at line 154 of file StatePairCollector.hh.

---

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

• src/ell/StatePairCollector.hh
• src/ell/StatePairCollector.cc