FreeFOAM The Cross-Platform CFD Toolkit
Hosted by SourceForge:
Get FreeFOAM at SourceForge.net.
            Fast, secure and Free Open Source software downloads

An instant of time. Contains the time value and name. More...

#include <OpenFOAM/instant.H>


Detailed Description

An instant of time. Contains the time value and name.

Source files

Definition at line 65 of file instant.H.

Collaboration diagram for instant:

List of all members.

Classes

class  less
 Less function class used in sorting instants. More...

Public Member Functions

 instant ()
 Construct null.
 instant (const scalar, const word &)
 Construct from components.
 instant (const scalar)
 Construct from time value.
 instant (const word &)
 Construct from word.
scalar  value () const
 Value (const access)
scalar &  value ()
 Value (non-const access)
const word &  name () const
 Name (const access)
word &  name ()
 Name (non-const access)

Static Public Attributes

static const char *const  typeName = "instant"

Friends

bool  operator== (const instant &, const instant &)
bool  operator!= (const instant &, const instant &)
Istream &  operator>> (Istream &, instant &)
Ostream &  operator<< (Ostream &, const instant &)

Constructor & Destructor Documentation

instant (  )

Construct null.

Definition at line 35 of file instant.C.

instant ( const scalar   val,
const word &   tname  
)

Construct from components.

Definition at line 38 of file instant.C.

instant ( const scalar   val  )

Construct from time value.

Definition at line 44 of file instant.C.

instant ( const word &   tname  )

Construct from word.

Definition at line 50 of file instant.C.


Member Function Documentation

scalar value (  ) const [inline]

Value (const access)

Definition at line 113 of file instant.H.

Referenced by instant::less::operator()(), timeSelector::selected(), and Time::setTime().

scalar& value (  ) [inline]

Value (non-const access)

Definition at line 119 of file instant.H.

const word& name (  ) const [inline]

Name (const access)

Definition at line 125 of file instant.H.

Referenced by Time::setTime().

word& name (  ) [inline]

Name (non-const access)

Definition at line 131 of file instant.H.


Friends And Related Function Documentation

bool operator== ( const instant &   ,
const instant &    
) [friend]
bool operator!= ( const instant &   ,
const instant &    
) [friend]
Istream& operator>> ( Istream &   ,
instant &    
) [friend]
Ostream& operator<< ( Ostream &   ,
const instant &    
) [friend]

Member Data Documentation

const char *const typeName = "instant" [static]

Definition at line 90 of file instant.H.


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