Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
TableReader< Type > Class Template Referenceabstract

Base class to read table data for tables. More...

Inheritance diagram for TableReader< Type >:
Inheritance graph
[legend]

Public Member Functions

 TypeName ("TableReader")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, TableReader, dictionary,(const word &name, const Function1s::unitConversions &units, const dictionary &dict),(name, units, dict))
 
 TableReader ()
 Default construct. More...
 
virtual autoPtr< TableReader< Type > > clone () const =0
 Construct and return a clone. More...
 
virtual ~TableReader ()
 Destructor. More...
 
virtual List< Tuple2< scalar, Type > > read (const Function1s::unitConversions &units, const dictionary &dict, const word &valuesKeyword="values") const =0
 Read values. More...
 
virtual void write (Ostream &os, const Function1s::unitConversions &units, const List< Tuple2< scalar, Type >> &table, const word &valuesKeyword="values") const =0
 Write settings and values. More...
 

Static Public Member Functions

static autoPtr< TableReader< Type > > New (const word &name, const Function1s::unitConversions &units, const dictionary &dict)
 

Protected Member Functions

void convertRead (const Function1s::unitConversions &units, List< Tuple2< scalar, Type >> &table) const
 Do unit conversions on input data. More...
 
List< Tuple2< scalar, Type > > convertRead (const Function1s::unitConversions &units, const List< Tuple2< scalar, Type >> &table) const
 Do unit conversions on input data. More...
 
List< Tuple2< scalar, Type > > convertWrite (const Function1s::unitConversions &units, const List< Tuple2< scalar, Type >> &table) const
 Do unit conversions in order to output data. More...
 

Detailed Description

template<class Type>
class Foam::TableReader< Type >

Base class to read table data for tables.

Source files

Definition at line 50 of file TableReader.H.

Constructor & Destructor Documentation

◆ TableReader()

TableReader

Default construct.

Definition at line 82 of file TableReader.C.

◆ ~TableReader()

~TableReader
virtual

Destructor.

Definition at line 89 of file TableReader.C.

Member Function Documentation

◆ convertRead() [1/2]

void convertRead ( const Function1s::unitConversions &  units,
List< Tuple2< scalar, Type >> &  table 
) const
protected

Do unit conversions on input data.

Definition at line 31 of file TableReader.C.

References Foam::first(), forAll, Foam::second(), and Foam::units().

Referenced by Embedded< Type >::read().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ convertRead() [2/2]

Foam::List< Foam::Tuple2< Foam::scalar, Type > > convertRead ( const Function1s::unitConversions &  units,
const List< Tuple2< scalar, Type >> &  table 
) const
protected

Do unit conversions on input data.

Definition at line 47 of file TableReader.C.

References Foam::units().

Here is the call graph for this function:

◆ convertWrite()

Foam::List< Foam::Tuple2< Foam::scalar, Type > > convertWrite ( const Function1s::unitConversions &  units,
const List< Tuple2< scalar, Type >> &  table 
) const
protected

Do unit conversions in order to output data.

Definition at line 61 of file TableReader.C.

References UList< T >::first(), Foam::first(), forAll, Foam::second(), and Foam::units().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "TableReader< Type >"  )

Runtime type information.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable ( autoPtr  ,
TableReader< Type >  ,
dictionary  ,
(const word &name, const Function1s::unitConversions &units, const dictionary &dict)  ,
(name, units, dict)   
)

◆ clone()

virtual autoPtr<TableReader<Type> > clone ( ) const
pure virtual

Construct and return a clone.

Implemented in Foam< Type >, Embedded< Type >, and Csv< Type >.

◆ New()

Foam::autoPtr< Foam::TableReader< Type > > New ( const word &  name,
const Function1s::unitConversions &  units,
const dictionary &  dict 
)
static

Definition at line 32 of file TableReaderNew.C.

References dict, Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, Foam::name(), Foam::nl, and Foam::units().

Here is the call graph for this function:

◆ read()

virtual List<Tuple2<scalar, Type> > read ( const Function1s::unitConversions &  units,
const dictionary &  dict,
const word &  valuesKeyword = "values" 
) const
pure virtual

Read values.

Implemented in TableFileReader< Type >, and Embedded< Type >.

◆ write()

virtual void write ( Ostream &  os,
const Function1s::unitConversions &  units,
const List< Tuple2< scalar, Type >> &  table,
const word &  valuesKeyword = "values" 
) const
pure virtual

Write settings and values.

Implemented in TableFileReader< Type >, Foam< Type >, Csv< Type >, and Embedded< Type >.

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