DtPublisherList< Publisher > Class Template Reference

Defines the DtPublisherList template. The parameter is the VR-Link Publisher object class type. More...

Collaboration diagram for DtPublisherList< Publisher >:

Public Types
typedef DtDelegate< void, Publisher * >	DtPublisherListDelegate
	Defines a delegate that has a Publisher object pointer as a parameter and returns a void type.

Public Member Functions
	DtPublisherList ()
	constructor
	~DtPublisherList ()
	destructor
void	tick ()
	Ticks all of the publishers.
void	add (Publisher *pub)
	add a publisher to the list
void	remove (Publisher *pub)
	remove the publisher from the list
Publisher *	find (std::string id)
	find a particular object publisher in the list
void	addPublisherAddedDelegate (DtPublisherListDelegate *del)
	add a callback for when a publisher is added to the list
void	removePublisherAddedDelegate (DtPublisherListDelegate *del)
	remove a callback for when a publisher is added to the list
void	addPublisherRemovedDelegate (DtPublisherListDelegate *del)
	add a callback for when a publisher is removed from the list
void	removePublisherRemovedDelegate (DtPublisherListDelegate *del)
	remove a callback for when a publisher is removed from the list
std::list< Publisher * >::iterator	begin ()
	Get the beginning of the list for iteration.
std::list< Publisher * >::iterator	end ()
	Get the end of the list for iteration.
void	clear ()
	Clears the list and all delegates. This will release the memory used by the delegates or object publishers.

Protected Attributes
std::list< Publisher * >	myPublishers
std::list < DtPublisherListDelegate * >	myAddedDelegates
std::list < DtPublisherListDelegate * >	myRemovedDelegates

Detailed Description

template<typename Publisher>
class DtPublisherList< Publisher >

Defines the DtPublisherList template. The parameter is the VR-Link Publisher object class type.

Member Typedef Documentation

template<typename Publisher >

typedef DtDelegate<void, Publisher*> DtPublisherList< Publisher >::DtPublisherListDelegate

Defines a delegate that has a Publisher object pointer as a parameter and returns a void type.

Constructor & Destructor Documentation

template<typename Publisher >

DtPublisherList< Publisher >::DtPublisherList ( )

inline

constructor

template<typename Publisher >

DtPublisherList< Publisher >::~DtPublisherList ( )

inline

destructor

References DtPublisherList< Publisher >::clear().

Member Function Documentation

template<typename Publisher >

void DtPublisherList< Publisher >::add ( Publisher *  pub )

inline

add a publisher to the list

References DtPublisherList< Publisher >::myAddedDelegates, and DtPublisherList< Publisher >::myPublishers.

template<typename Publisher >

void DtPublisherList< Publisher >::addPublisherAddedDelegate ( DtPublisherListDelegate *  del )

inline

add a callback for when a publisher is added to the list

References DtPublisherList< Publisher >::myAddedDelegates.

template<typename Publisher >

void DtPublisherList< Publisher >::addPublisherRemovedDelegate ( DtPublisherListDelegate *  del )

inline

add a callback for when a publisher is removed from the list

References DtPublisherList< Publisher >::myRemovedDelegates.

template<typename Publisher >

std::list<Publisher*>::iterator DtPublisherList< Publisher >::begin ( )

inline

Get the beginning of the list for iteration.

References DtPublisherList< Publisher >::myPublishers.

template<typename Publisher >

void DtPublisherList< Publisher >::clear ( )

inline

Clears the list and all delegates. This will release the memory used by the delegates or object publishers.

References DtPublisherList< Publisher >::myAddedDelegates, DtPublisherList< Publisher >::myPublishers, and DtPublisherList< Publisher >::myRemovedDelegates.

Referenced by DtPublisherList< Publisher >::~DtPublisherList().

template<typename Publisher >

std::list<Publisher*>::iterator DtPublisherList< Publisher >::end ( )

inline

Get the end of the list for iteration.

References DtPublisherList< Publisher >::myPublishers.

template<typename Publisher >

Publisher* DtPublisherList< Publisher >::find ( std::string  id )

inline

find a particular object publisher in the list

References DtPublisherList< Publisher >::myPublishers.

template<typename Publisher >

void DtPublisherList< Publisher >::remove ( Publisher *  pub )

inline

remove the publisher from the list

References DtPublisherList< Publisher >::myPublishers, and DtPublisherList< Publisher >::myRemovedDelegates.

template<typename Publisher >

void DtPublisherList< Publisher >::removePublisherAddedDelegate ( DtPublisherListDelegate *  del )

inline

remove a callback for when a publisher is added to the list

References DtPublisherList< Publisher >::myAddedDelegates.

template<typename Publisher >

void DtPublisherList< Publisher >::removePublisherRemovedDelegate ( DtPublisherListDelegate *  del )

inline

remove a callback for when a publisher is removed from the list

References DtPublisherList< Publisher >::myRemovedDelegates.

template<typename Publisher >

void DtPublisherList< Publisher >::tick ( )

inline

Ticks all of the publishers.

References DtPublisherList< Publisher >::myPublishers.

Member Data Documentation

template<typename Publisher >

std::list<DtPublisherListDelegate*> DtPublisherList< Publisher >::myAddedDelegates

protected

Referenced by DtPublisherList< Publisher >::add(), DtPublisherList< Publisher >::addPublisherAddedDelegate(), DtPublisherList< Publisher >::clear(), and DtPublisherList< Publisher >::removePublisherAddedDelegate().

template<typename Publisher >

std::list<Publisher*> DtPublisherList< Publisher >::myPublishers

protected

Referenced by DtPublisherList< Publisher >::add(), DtPublisherList< Publisher >::begin(), DtPublisherList< Publisher >::clear(), DtPublisherList< Publisher >::end(), DtPublisherList< Publisher >::find(), DtPublisherList< Publisher >::remove(), and DtPublisherList< Publisher >::tick().

template<typename Publisher >

std::list<DtPublisherListDelegate*> DtPublisherList< Publisher >::myRemovedDelegates

protected

Referenced by DtPublisherList< Publisher >::addPublisherRemovedDelegate(), DtPublisherList< Publisher >::clear(), DtPublisherList< Publisher >::remove(), and DtPublisherList< Publisher >::removePublisherRemovedDelegate().

---

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

• publisherList.h