TimeEventRangeIndex specifies a start, stop and stride index. More...

#include <Tempus_TimeEventRangeIndex_decl.hpp>

Inheritance diagram for Tempus::TimeEventRangeIndex< Scalar >:

Public Member Functions
	TimeEventRangeIndex ()
	Default constructor. More...

	TimeEventRangeIndex (std::string name, int start, int stop, int stride)
	Construct with full argument list of data members. More...

virtual	~TimeEventRangeIndex ()
	Destructor. More...

Basic methods
virtual bool	isIndex (int index) const
	Test if index is a time event. More...

virtual int	indexToNextEvent (int index) const
	How many indices until the next event. Negative indicating the last event is in the past. More...

virtual int	indexOfNextEvent (int index) const
	Index of the next event. Negative indicating the last event is in the past. More...

virtual bool	eventInRangeIndex (int index1, int index2) const
	Test if an event occurs within the index range. More...

virtual void	describe () const
	Describe member data. More...

Accessor methods
virtual void	setIndexRange (int start, int stop, int stride)

virtual int	getIndexStart () const

virtual void	setIndexStart (int start)

virtual int	getIndexStop () const

virtual void	setIndexStop (int stop)

virtual int	getIndexStride () const

virtual void	setIndexStride (int stride)

virtual int	getNumEvents () const

virtual void	setNumEvents ()

Public Member Functions inherited from Tempus::TimeEventBase< Scalar >
	TimeEventBase ()
	Constructor. More...

virtual	~TimeEventBase ()
	Destructor. More...

virtual bool	isTime (Scalar time) const
	Test if time is near a TimeEvent (within tolerance). More...

virtual Scalar	getAbsTol () const

virtual Scalar	timeToNextEvent (Scalar time) const
	How much time until the next event. Negative indicating the last event is in the past. More...

virtual Scalar	timeOfNextEvent (Scalar time) const
	Time of the next event. Negative indicating the last event is in the past. More...

virtual bool	eventInRange (Scalar time1, Scalar time2) const
	Test if an event occurs within the time range. More...

virtual std::string	getName () const

virtual void	setName (std::string name)

virtual Scalar	getDefaultTime () const

virtual Scalar	getDefaultTol () const

virtual int	getDefaultIndex () const

Protected Attributes
int	start_

int	stop_

int	stride_

unsigned	numEvents_

Detailed Description

template<class Scalar>
class Tempus::TimeEventRangeIndex< Scalar >

TimeEventRangeIndex specifies a start, stop and stride index.

Definition at line 29 of file Tempus_TimeEventRangeIndex_decl.hpp.

Constructor & Destructor Documentation

template<class Scalar >

Tempus::TimeEventRangeIndex< Scalar >::TimeEventRangeIndex ( )

Default constructor.

Definition at line 16 of file Tempus_TimeEventRangeIndex_impl.hpp.

template<class Scalar >

Tempus::TimeEventRangeIndex< Scalar >::TimeEventRangeIndex	(	std::string	name,
		int	start,
		int	stop,
		int	stride
	)

Construct with full argument list of data members.

Definition at line 25 of file Tempus_TimeEventRangeIndex_impl.hpp.

template<class Scalar >

virtual Tempus::TimeEventRangeIndex< Scalar >::~TimeEventRangeIndex ( )

inlinevirtual

Destructor.

Definition at line 40 of file Tempus_TimeEventRangeIndex_decl.hpp.

Member Function Documentation

template<class Scalar >

void Tempus::TimeEventRangeIndex< Scalar >::describe ( ) const

virtual

Describe member data.

Reimplemented from Tempus::TimeEventBase< Scalar >.

Definition at line 137 of file Tempus_TimeEventRangeIndex_impl.hpp.

template<class Scalar >

bool Tempus::TimeEventRangeIndex< Scalar >::eventInRangeIndex	(	int	index1,
		int	index2
	)		const

virtual

Test if an event occurs within the index range.

Reimplemented from Tempus::TimeEventBase< Scalar >.

Definition at line 113 of file Tempus_TimeEventRangeIndex_impl.hpp.

template<class Scalar >

virtual int Tempus::TimeEventRangeIndex< Scalar >::getIndexStart ( ) const

inlinevirtual

Definition at line 65 of file Tempus_TimeEventRangeIndex_decl.hpp.

template<class Scalar >

virtual int Tempus::TimeEventRangeIndex< Scalar >::getIndexStop ( ) const

inlinevirtual

Definition at line 68 of file Tempus_TimeEventRangeIndex_decl.hpp.

template<class Scalar >

virtual int Tempus::TimeEventRangeIndex< Scalar >::getIndexStride ( ) const

inlinevirtual

Definition at line 71 of file Tempus_TimeEventRangeIndex_decl.hpp.

template<class Scalar >

virtual int Tempus::TimeEventRangeIndex< Scalar >::getNumEvents ( ) const

inlinevirtual

Definition at line 74 of file Tempus_TimeEventRangeIndex_decl.hpp.

template<class Scalar >

int Tempus::TimeEventRangeIndex< Scalar >::indexOfNextEvent ( int index ) const

virtual

Index of the next event. Negative indicating the last event is in the past.

Reimplemented from Tempus::TimeEventBase< Scalar >.

Definition at line 94 of file Tempus_TimeEventRangeIndex_impl.hpp.

template<class Scalar >

int Tempus::TimeEventRangeIndex< Scalar >::indexToNextEvent ( int index ) const

virtual

How many indices until the next event. Negative indicating the last event is in the past.

Reimplemented from Tempus::TimeEventBase< Scalar >.

Definition at line 87 of file Tempus_TimeEventRangeIndex_impl.hpp.

template<class Scalar >

bool Tempus::TimeEventRangeIndex< Scalar >::isIndex ( int index ) const

virtual

Test if index is a time event.

Reimplemented from Tempus::TimeEventBase< Scalar >.

Definition at line 80 of file Tempus_TimeEventRangeIndex_impl.hpp.

template<class Scalar >

virtual void Tempus::TimeEventRangeIndex< Scalar >::setIndexRange	(	int	start,
		int	stop,
		int	stride
	)

inlinevirtual

Definition at line 62 of file Tempus_TimeEventRangeIndex_decl.hpp.

template<class Scalar >

void Tempus::TimeEventRangeIndex< Scalar >::setIndexStart ( int start )

virtual

Definition at line 34 of file Tempus_TimeEventRangeIndex_impl.hpp.

template<class Scalar >

void Tempus::TimeEventRangeIndex< Scalar >::setIndexStop ( int stop )

virtual

Definition at line 45 of file Tempus_TimeEventRangeIndex_impl.hpp.

template<class Scalar >

void Tempus::TimeEventRangeIndex< Scalar >::setIndexStride ( int stride )

virtual

Definition at line 57 of file Tempus_TimeEventRangeIndex_impl.hpp.

template<class Scalar >

void Tempus::TimeEventRangeIndex< Scalar >::setNumEvents ( )

virtual

Definition at line 70 of file Tempus_TimeEventRangeIndex_impl.hpp.

Member Data Documentation

template<class Scalar >

unsigned Tempus::TimeEventRangeIndex< Scalar >::numEvents_

protected

Definition at line 84 of file Tempus_TimeEventRangeIndex_decl.hpp.

template<class Scalar >

int Tempus::TimeEventRangeIndex< Scalar >::start_

protected

Definition at line 81 of file Tempus_TimeEventRangeIndex_decl.hpp.

template<class Scalar >

int Tempus::TimeEventRangeIndex< Scalar >::stop_

protected

Definition at line 82 of file Tempus_TimeEventRangeIndex_decl.hpp.

template<class Scalar >

int Tempus::TimeEventRangeIndex< Scalar >::stride_

protected

Definition at line 83 of file Tempus_TimeEventRangeIndex_decl.hpp.

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

http://docs.trilinos.org/r13.0/packages/tempus/src/Tempus_TimeEventRangeIndex_decl.hpp
http://docs.trilinos.org/r13.0/packages/tempus/src/Tempus_TimeEventRangeIndex_impl.hpp

Public Member Functions

Protected Attributes

Detailed Description

template<class Scalar> class Tempus::TimeEventRangeIndex< Scalar >

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<class Scalar>
class Tempus::TimeEventRangeIndex< Scalar >