makVrv::DtConfigurationCollection< ConfigurationType > Class Template Reference

A collection of configurations. More...

Inheritance diagram for makVrv::DtConfigurationCollection< ConfigurationType >:

List of all members.

Public Types
typedef std::set < ConfigurationType * >	Configurations
typedef Configurations::iterator	iterator
typedef Configurations::const_iterator	const_iterator
Public Member Functions
	DtConfigurationCollection ()
	DtConfigurationCollection (const DtConfigurationCollection &copy)
DtConfigurationCollection &	operator= (const DtConfigurationCollection &copy)
	~DtConfigurationCollection ()
template<class Archive >
void	serialize (Archive &ar, const unsigned int version)
	When the class Archive corresponds to an output archive, the & operator is defined similar to <<.
virtual ConfigurationType &	add (const ConfigurationType &orig)
	Add a Channel configuration.
virtual void	destroyConfiguration (ConfigurationType *config)
	Destroys a Channel configuration.
size_t	size () const
iterator	begin ()
const_iterator	begin () const
iterator	end ()
const_iterator	end () const
const Configurations &	configurations () const
	Get the channels for this window.
void	addConfigurations (const Configurations &configs)
	Add several configurations.
void	destroyAll ()
	Destroys all channel configurations.
virtual ConfigurationType *	findConfiguration (const std::string &name)
	Return the configuration associated with name or null if one doesn't exist.
virtual const ConfigurationType *	findConfiguration (const std::string &name) const
	Return the configuration associated with name or null if one doesn't exist.
Protected Attributes
Configurations	myConfigurations
Friends
class	boost::serialization::access

---

Detailed Description

template<typename ConfigurationType>
class makVrv::DtConfigurationCollection< ConfigurationType >

A collection of configurations.

---

Member Typedef Documentation

template<typename ConfigurationType>

typedef std::set<ConfigurationType*> makVrv::DtConfigurationCollection< ConfigurationType >::Configurations

template<typename ConfigurationType>

typedef Configurations::iterator makVrv::DtConfigurationCollection< ConfigurationType >::iterator

template<typename ConfigurationType>

typedef Configurations::const_iterator makVrv::DtConfigurationCollection< ConfigurationType >::const_iterator

---

Constructor & Destructor Documentation

template<typename ConfigurationType>

makVrv::DtConfigurationCollection< ConfigurationType >::DtConfigurationCollection

(

)

[inline]

template<typename ConfigurationType>

makVrv::DtConfigurationCollection< ConfigurationType >::DtConfigurationCollection

(

const DtConfigurationCollection< ConfigurationType > &

copy

)

[inline]

template<typename ConfigurationType>

makVrv::DtConfigurationCollection< ConfigurationType >::~DtConfigurationCollection

(

)

[inline]

---

Member Function Documentation

template<typename ConfigurationType>

DtConfigurationCollection& makVrv::DtConfigurationCollection< ConfigurationType >::operator=

(

const DtConfigurationCollection< ConfigurationType > &

copy

)

[inline]

template<typename ConfigurationType>

template<class Archive >

void makVrv::DtConfigurationCollection< ConfigurationType >::serialize	(	Archive &	ar,
		const unsigned int	version
	)		[inline]

When the class Archive corresponds to an output archive, the & operator is defined similar to <<.

Likewise, when the class Archive is a type of input archive the & operator is defined similar to >>.

template<typename ConfigurationType>

virtual ConfigurationType& makVrv::DtConfigurationCollection< ConfigurationType >::add

(

const ConfigurationType &

orig

)

[inline, virtual]

Add a Channel configuration.

Referenced by makVrv::DtConfigurationCollection< DtDisplayConfiguration >::addConfigurations().

template<typename ConfigurationType>

virtual void makVrv::DtConfigurationCollection< ConfigurationType >::destroyConfiguration

(

ConfigurationType *

config

)

[inline, virtual]

Destroys a Channel configuration.

Now the pointer must be a member of the channel Configuration. There is no operation performed if the configuration pointer is not found or is NULL.

   To remove the 3rd channel 
   ChannelConfigurationList::iterator iter = channelConfigurations().begin();
   std::advance(iter,2);
   removeChannelConfiguration(*iter);
   To remove the channel named 'Secondary'
  removeChannelConfiguration(findChannelConfiguration("Secondary"));

template<typename ConfigurationType>

size_t makVrv::DtConfigurationCollection< ConfigurationType >::size

(

)

const [inline]

template<typename ConfigurationType>

iterator makVrv::DtConfigurationCollection< ConfigurationType >::begin

(

)

[inline]

template<typename ConfigurationType>

const_iterator makVrv::DtConfigurationCollection< ConfigurationType >::begin

(

)

const [inline]

template<typename ConfigurationType>

iterator makVrv::DtConfigurationCollection< ConfigurationType >::end

(

)

[inline]

template<typename ConfigurationType>

const_iterator makVrv::DtConfigurationCollection< ConfigurationType >::end

(

)

const [inline]

template<typename ConfigurationType>

const Configurations& makVrv::DtConfigurationCollection< ConfigurationType >::configurations

(

)

const [inline]

Get the channels for this window.

template<typename ConfigurationType>

void makVrv::DtConfigurationCollection< ConfigurationType >::addConfigurations

(

const Configurations &

configs

)

[inline]

Add several configurations.

Referenced by makVrv::DtConfigurationCollection< DtDisplayConfiguration >::DtConfigurationCollection(), and makVrv::DtConfigurationCollection< DtDisplayConfiguration >::operator=().

template<typename ConfigurationType>

void makVrv::DtConfigurationCollection< ConfigurationType >::destroyAll

(

)

[inline]

Destroys all channel configurations.

Referenced by makVrv::DtConfigurationCollection< DtDisplayConfiguration >::operator=(), and makVrv::DtConfigurationCollection< DtDisplayConfiguration >::~DtConfigurationCollection().

template<typename ConfigurationType>

virtual ConfigurationType* makVrv::DtConfigurationCollection< ConfigurationType >::findConfiguration

(

const std::string &

name

)

[inline, virtual]

Return the configuration associated with name or null if one doesn't exist.

template<typename ConfigurationType>

virtual const ConfigurationType* makVrv::DtConfigurationCollection< ConfigurationType >::findConfiguration

(

const std::string &

name

)

const [inline, virtual]

Return the configuration associated with name or null if one doesn't exist.

---

Friends And Related Function Documentation

template<typename ConfigurationType>

friend class boost::serialization::access [friend]

---

Member Data Documentation

template<typename ConfigurationType>

Configurations makVrv::DtConfigurationCollection< ConfigurationType >::myConfigurations [protected]

Referenced by makVrv::DtConfigurationCollection< DtDisplayConfiguration >::add(), makVrv::DtConfigurationCollection< DtDisplayConfiguration >::begin(), makVrv::DtConfigurationCollection< DtDisplayConfiguration >::configurations(), makVrv::DtConfigurationCollection< DtDisplayConfiguration >::destroyAll(), makVrv::DtConfigurationCollection< DtDisplayConfiguration >::destroyConfiguration(), makVrv::DtConfigurationCollection< DtDisplayConfiguration >::DtConfigurationCollection(), makVrv::DtConfigurationCollection< DtDisplayConfiguration >::end(), makVrv::DtConfigurationCollection< DtDisplayConfiguration >::findConfiguration(), makVrv::DtConfigurationCollection< DtDisplayConfiguration >::operator=(), makVrv::DtConfigurationCollection< DtDisplayConfiguration >::serialize(), and makVrv::DtConfigurationCollection< DtDisplayConfiguration >::size().

---

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

• include/vrvUtil/DtConfigurationCollection.h