rc_reconfigurable_set Class Reference

#include <rc_reconfigurable_set.h>

Inheritance diagram for rc_reconfigurable_set:

List of all members.

---

Detailed Description

Implemenation of a set of rc_reconfigurable objects.

This set class is used by several methods of rc_control to allow passing of multiple rc_reconfigurable objects at once.

Remarks:

rc_reconfigurable_set is derived from a std::set container.

Note:

For convenience, an rc_reconfigurable possesses an implicit casting operator to a rc_reconfigurable_set which returns a set that only contains this rc_reconfigurable instance.

See also:

rc_control, rc_reconfigurable

Definition at line 60 of file rc_reconfigurable_set.h.

Public Types
typedef base_type::iterator	iterator
	The iterator type of this set.
typedef base_type::const_iterator	const_iterator
	The constant iterator type of this set.
Public Member Functions
	rc_reconfigurable_set ()
	Default constructor.
	rc_reconfigurable_set (const rc_reconfigurable_set &reconf_set)
	Copy constructor.
rc_reconfigurable_set &	operator= (const rc_reconfigurable_set &reconf_set)
	Assigns the contents of another set.
int	size () const
	Returns the number of inserted set elements.
void	insert (rc_reconfigurable &reconf)
	Inserts an rc_reconfigurable.
void	insert (const rc_reconfigurable_set &reconf_set)
	Inserts the contents of another rc_reconfigurable_set.
void	erase (rc_reconfigurable &reconf)
	Removes an rc_reconfigurable from the set.
void	erase (const rc_reconfigurable_set &reconf_set)
	Removes multiple elements from the set.
bool	contains (const rc_reconfigurable &reconf) const
	Checks if a rc_reconfigurable is contained.
bool	contains (const rc_reconfigurable_set &reconf_set) const
	Checks if the given set is contained.
iterator	find (rc_reconfigurable &reconf)
	Finds an rc_reconfigurable.
const_iterator	find (const rc_reconfigurable &reconf) const
	Finds an rc_reconfigurable.
iterator	begin ()
	Returns an iterator beginning at the first element.
const_iterator	begin () const
	Returns an constant iterator beginning at the first element.
iterator	end ()
	Returns the end of the set.
const_iterator	end () const
	Returns the end of the set.
rc_reconfigurable_set &	operator+= (rc_reconfigurable &reconf)
rc_reconfigurable_set &	operator+= (const rc_reconfigurable_set &reconf_set)
rc_reconfigurable_set	operator+ (rc_reconfigurable &reconf) const
rc_reconfigurable_set	operator+ (const rc_reconfigurable_set &reconf_set) const
rc_reconfigurable_set &	operator-= (rc_reconfigurable &reconf)
rc_reconfigurable_set &	operator-= (const rc_reconfigurable_set &reconf_set)
rc_reconfigurable_set	operator- (rc_reconfigurable &reconf) const
rc_reconfigurable_set	operator- (const rc_reconfigurable_set &reconf_set) const
Private Types
typedef std::set < rc_reconfigurable * >	base_type
	The base type is a std::set of rc_reconfigurable pointers.
Friends
class	rc_control
	Grant rc_control full access to the set.

---

Member Typedef Documentation

typedef std::set<rc_reconfigurable*> base_type [private]

The base type is a std::set of rc_reconfigurable pointers.

Definition at line 72 of file rc_reconfigurable_set.h.

typedef base_type::iterator iterator

The iterator type of this set.

Definition at line 78 of file rc_reconfigurable_set.h.

typedef base_type::const_iterator const_iterator

The constant iterator type of this set.

Definition at line 82 of file rc_reconfigurable_set.h.

---

Constructor & Destructor Documentation

rc_reconfigurable_set

(

)

[inline]

Default constructor.

Creates an empty set.

Definition at line 90 of file rc_reconfigurable_set.h.

Referenced by rc_reconfigurable_set::operator+(), and rc_reconfigurable_set::operator-().

rc_reconfigurable_set

(

const rc_reconfigurable_set &

reconf_set

)

[inline]

Copy constructor.

Definition at line 95 of file rc_reconfigurable_set.h.

---

Member Function Documentation

rc_reconfigurable_set& operator=

(

const rc_reconfigurable_set &

reconf_set

)

[inline]

Assigns the contents of another set.

Definition at line 102 of file rc_reconfigurable_set.h.

int size

(

)

const [inline]

Returns the number of inserted set elements.

Definition at line 109 of file rc_reconfigurable_set.h.

Referenced by rc_control::_rc_do_action(), and rc_control::_rc_reconfigure().

void insert

(

rc_reconfigurable &

reconf

)

[inline]

Inserts an rc_reconfigurable.

Definition at line 115 of file rc_reconfigurable_set.h.

Referenced by rc_control::_rc_do_action(), rc_control::add(), rc_reconfigurable_set::operator+=(), and rc_reconfigurable::rc_reconfigurable().

void insert

(

const rc_reconfigurable_set &

reconf_set

)

[inline]

Inserts the contents of another rc_reconfigurable_set.

Definition at line 121 of file rc_reconfigurable_set.h.

void erase

(

rc_reconfigurable &

reconf

)

[inline]

Removes an rc_reconfigurable from the set.

Definition at line 127 of file rc_reconfigurable_set.h.

Referenced by rc_reconfigurable_set::operator-=(), and rc_control::remove().

void erase

(

const rc_reconfigurable_set &

reconf_set

)

Removes multiple elements from the set.

Definition at line 43 of file rc_reconfigurable_set.cpp.

bool contains

(

const rc_reconfigurable &

reconf

)

const [inline]

Checks if a rc_reconfigurable is contained.

Definition at line 138 of file rc_reconfigurable_set.h.

bool contains

(

const rc_reconfigurable_set &

reconf_set

)

const

Checks if the given set is contained.

Definition at line 53 of file rc_reconfigurable_set.cpp.

iterator find

(

rc_reconfigurable &

reconf

)

[inline]

Finds an rc_reconfigurable.

Definition at line 152 of file rc_reconfigurable_set.h.

Referenced by rc_control::has_control().

const_iterator find

(

const rc_reconfigurable &

reconf

)

const [inline]

Finds an rc_reconfigurable.

Definition at line 158 of file rc_reconfigurable_set.h.

iterator begin

(

)

[inline]

Returns an iterator beginning at the first element.

Definition at line 167 of file rc_reconfigurable_set.h.

Referenced by rc_control::_rc_do_action(), rc_control::_rc_reconfigure(), rc_control::add(), rc_reconfigurable_set::contains(), rc_reconfigurable_set::erase(), rc_control::has_control(), rc_reconfigurable_set::insert(), rc_control::is_locked(), rc_control::lock(), rc_control::move(), rc_control::remove(), rc_control::trylock(), rc_control::unlock(), and rc_control::update_delays().

const_iterator begin

(

)

const [inline]

Returns an constant iterator beginning at the first element.

Definition at line 173 of file rc_reconfigurable_set.h.

iterator end

(

)

[inline]

Returns the end of the set.

Definition at line 179 of file rc_reconfigurable_set.h.

Referenced by rc_control::_rc_do_action(), rc_control::_rc_reconfigure(), rc_control::add(), rc_reconfigurable_set::contains(), rc_reconfigurable_set::erase(), rc_control::has_control(), rc_reconfigurable_set::insert(), rc_control::is_locked(), rc_control::lock(), rc_control::move(), rc_control::remove(), rc_control::trylock(), rc_control::unlock(), and rc_control::update_delays().

const_iterator end

(

)

const [inline]

Returns the end of the set.

Definition at line 185 of file rc_reconfigurable_set.h.

rc_reconfigurable_set& operator+=

(

rc_reconfigurable &

reconf

)

[inline]

Definition at line 188 of file rc_reconfigurable_set.h.

rc_reconfigurable_set& operator+=

(

const rc_reconfigurable_set &

reconf_set

)

[inline]

Definition at line 192 of file rc_reconfigurable_set.h.

rc_reconfigurable_set operator+

(

rc_reconfigurable &

reconf

)

const [inline]

Definition at line 196 of file rc_reconfigurable_set.h.

rc_reconfigurable_set operator+

(

const rc_reconfigurable_set &

reconf_set

)

const [inline]

Definition at line 200 of file rc_reconfigurable_set.h.

rc_reconfigurable_set& operator-=

(

rc_reconfigurable &

reconf

)

[inline]

Definition at line 204 of file rc_reconfigurable_set.h.

rc_reconfigurable_set& operator-=

(

const rc_reconfigurable_set &

reconf_set

)

[inline]

Definition at line 208 of file rc_reconfigurable_set.h.

rc_reconfigurable_set operator-

(

rc_reconfigurable &

reconf

)

const [inline]

Definition at line 212 of file rc_reconfigurable_set.h.

rc_reconfigurable_set operator-

(

const rc_reconfigurable_set &

reconf_set

)

const [inline]

Definition at line 216 of file rc_reconfigurable_set.h.

---

Friends And Related Function Documentation

friend class rc_control [friend]

Grant rc_control full access to the set.

Definition at line 66 of file rc_reconfigurable_set.h.

---

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

• rc_reconfigurable_set.h
• rc_reconfigurable_set.cpp

---