DtSequentialExecutionContainer< Texec > Class Template Reference

DtSequentialExecutionContainer is implementation of DtExecutionContainer which executes methods on all contained objects sequentially in a single thread. More...

Inheritance diagram for DtSequentialExecutionContainer< Texec >:

Public Types
typedef std::vector< Texec * >	SecContainerType
typedef SecContainerType::iterator	SecIteratorType

Public Member Functions
	DtSequentialExecutionContainer ()
	Construct a new container, default to parallel execution and grain_size of 10.
virtual	~DtSequentialExecutionContainer ()
	Virtual destructor does NOT destroy contents.
virtual void	add (Texec *item)
	Add a reference to the container.
virtual void	remove (Texec *item)
	Remove a reference from the container.
virtual void	clear ()
	Clear the container.
virtual void	deleteAndClear ()
	Delete all referenced objects and then clear the container.
virtual bool	empty () const
	Check if container is empty.
virtual bool	contains (Texec *item)
	Check if container contains item.
virtual SecIteratorType	begin ()
	Note: linux toolchain doesn't support const_iterator.
virtual SecIteratorType	end ()
	End iterator over the container.
virtual void	executeMethod (void(Texec::*theMethodPtr)())
	Execute method on all contained objects sequentially in a single thread.

Protected Attributes
SecContainerType	myExecVec
	The execution container.

Detailed Description

template<class Texec>
class DtSequentialExecutionContainer< Texec >

DtSequentialExecutionContainer is implementation of DtExecutionContainer which executes methods on all contained objects sequentially in a single thread.

Order of execution is guaranteed to be order-as-added.

Member Typedef Documentation

template<class Texec >

typedef std::vector<Texec *> DtSequentialExecutionContainer< Texec >::SecContainerType

template<class Texec >

typedef SecContainerType::iterator DtSequentialExecutionContainer< Texec >::SecIteratorType

Constructor & Destructor Documentation

template<class Texec >

DtSequentialExecutionContainer< Texec >::DtSequentialExecutionContainer ( )

inline

Construct a new container, default to parallel execution and grain_size of 10.

template<class Texec >

virtual DtSequentialExecutionContainer< Texec >::~DtSequentialExecutionContainer ( )

inlinevirtual

Virtual destructor does NOT destroy contents.

Call deleteAndClear explicitly to delete contents.

Member Function Documentation

template<class Texec >

virtual void DtSequentialExecutionContainer< Texec >::add ( Texec *  item )

inlinevirtual

Add a reference to the container.

Parameters

item	the item to add to the container.

Implements DtExecutionContainer< Texec >.

References DtSequentialExecutionContainer< Texec >::myExecVec.

template<class Texec >

virtual void DtSequentialExecutionContainer< Texec >::remove ( Texec *  item )

inlinevirtual

Remove a reference from the container.

Parameters

item	the item to remove from the container.

Implements DtExecutionContainer< Texec >.

References DtSequentialExecutionContainer< Texec >::myExecVec.

template<class Texec >

virtual void DtSequentialExecutionContainer< Texec >::clear ( )

inlinevirtual

Clear the container.

Implements DtExecutionContainer< Texec >.

References DtSequentialExecutionContainer< Texec >::myExecVec.

template<class Texec >

void DtSequentialExecutionContainer< Texec >::deleteAndClear ( )

inlinevirtual

Delete all referenced objects and then clear the container.

Items are deleted sequentially, not in parallel, so item's destructor isn't required to be thread safe.

Implements DtExecutionContainer< Texec >.

template<class Texec >

virtual bool DtSequentialExecutionContainer< Texec >::empty ( ) const

inlinevirtual

Check if container is empty.

Returns

true if container is empty.

References DtSequentialExecutionContainer< Texec >::myExecVec.

template<class Texec >

virtual bool DtSequentialExecutionContainer< Texec >::contains ( Texec *  item )

inlinevirtual

Check if container contains item.

Parameters

item	the item to check.

Returns

true if item is in container.

References DtSequentialExecutionContainer< Texec >::begin(), and DtSequentialExecutionContainer< Texec >::end().

template<class Texec >

virtual SecIteratorType DtSequentialExecutionContainer< Texec >::begin ( )

inlinevirtual

Note: linux toolchain doesn't support const_iterator.

:( Begin iterator over the container.

References DtSequentialExecutionContainer< Texec >::myExecVec.

Referenced by DtSequentialExecutionContainer< Texec >::contains().

template<class Texec >

virtual SecIteratorType DtSequentialExecutionContainer< Texec >::end ( )

inlinevirtual

End iterator over the container.

References DtSequentialExecutionContainer< Texec >::myExecVec.

Referenced by DtSequentialExecutionContainer< Texec >::contains().

template<class Texec >

void DtSequentialExecutionContainer< Texec >::executeMethod ( void(Texec::*)()  theMethodPtr )

inlinevirtual

Execute method on all contained objects sequentially in a single thread.

Parameters

theMethodPtr

the method to execute.

Implements DtExecutionContainer< Texec >.

Member Data Documentation

template<class Texec >

SecContainerType DtSequentialExecutionContainer< Texec >::myExecVec

protected

The execution container.

Referenced by DtSequentialExecutionContainer< Texec >::add(), DtSequentialExecutionContainer< Texec >::begin(), DtSequentialExecutionContainer< Texec >::clear(), DtSequentialExecutionContainer< Texec >::empty(), DtSequentialExecutionContainer< Texec >::end(), and DtSequentialExecutionContainer< Texec >::remove().

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfutil/sequentialExecutionContainer.h