Instant< T > Class Template Reference

A tuple of value and key. The value often corresponds to a time value, thus the naming of the class. The key will usually be a time name or a file name etc. More...

Inheritance diagram for Instant< T >:

Classes
struct	less

Public Member Functions
	Instant ()
	Instant (scalar val, const T &key)
	Instant (scalar val, T &&key)
	Instant (const Instant &)=default
	Instant (Instant &&)=default
scalar	value () const
scalar &	value ()
const T &	name () const
T &	name ()
bool	equal (scalar val) const
template<class T2 >
bool	equal (const Instant< T2 > &other) const
Instant &	operator= (const Instant &)=default
Instant &	operator= (Instant &&)=default

Detailed Description

template<class T>
class Foam::Instant< T >

A tuple of value and key. The value often corresponds to a time value, thus the naming of the class. The key will usually be a time name or a file name etc.

Source files

• Instant.H
• Instant.C

Definition at line 49 of file Instant.H.

Constructor & Destructor Documentation

Instant() [1/5]

Instant

Definition at line 26 of file Instant.C.

Instant() [2/5]

Instant	(	scalar	val,
		const T &	key
	)

Instant() [3/5]

Instant	(	scalar	val,
		T &&	key
	)

Instant() [4/5]

Instant ( const Instant< T > &  )

default

Instant() [5/5]

Instant ( Instant< T > &&  )

default

Member Function Documentation

value() [1/2]

scalar value ( ) const

inline

Definition at line 95 of file Instant.H.

Referenced by seriesWriter::append(), Instant< word >::equal(), noiseModel::findStartTimeIndex(), seriesWriter::load(), ensightCase::nextTime(), seriesLess::operator()(), Instant< T >::less::operator()(), Foam::operator<(), Foam::operator>(), seriesWriter::removeNewer(), timeSelector::selected(), ensightCase::setTime(), and Time::setTime().

Here is the caller graph for this function:

value() [2/2]

scalar& value ( )

inline

Definition at line 101 of file Instant.H.

name() [1/2]

const T& name ( ) const

inline

Definition at line 107 of file Instant.H.

Referenced by seriesWriter::append(), seriesWriter::load(), seriesLess::operator()(), seriesWriter::removeNewer(), and Time::setTime().

Here is the caller graph for this function:

name() [2/2]

T& name ( )

inline

Definition at line 113 of file Instant.H.

equal() [1/2]

bool equal

(

scalar

val

)

const

Definition at line 52 of file Instant.C.

Referenced by masterUncollatedFileOperation::findInstancePath(), Time::findInstancePath(), Foam::operator!=(), Foam::operator==(), and masterUncollatedFileOperation::readObjects().

Here is the caller graph for this function:

equal() [2/2]

bool equal

(

const Instant< T2 > &

other

)

const

Definition at line 60 of file Instant.C.

operator=() [1/2]

Instant& operator= ( const Instant< T > &  )

default

operator=() [2/2]

Instant& operator= ( Instant< T > &&  )

default

---

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

• src/OpenFOAM/db/Time/instant/Instant.H
• src/OpenFOAM/db/Time/instant/Instant.C