token::compound Class Reference

Abstract base class for complex tokens. More...

Inheritance diagram for token::compound:

Collaboration diagram for token::compound:

Public Member Functions
	TypeName ("compound")
	Declare type-name, virtual type (with debug switch) More...
	declareRunTimeSelectionTable (autoPtr, compound, Istream,(Istream &is),(is))
	Declare run-time constructor selection table. More...
constexpr	compound () noexcept
	Default construct. More...
virtual	~compound () noexcept=default
	Destructor. More...
bool	moved () const noexcept
	Get compound transferred status. More...
void	moved (bool b) noexcept
	Set compound transferred status. More...
virtual label	size () const =0
	The size of the underlying content. More...
virtual void	write (Ostream &os) const =0
	Redirect write to underlying content. More...
Public Member Functions inherited from refCount
constexpr	refCount () noexcept
	Default construct, initializing count to 0. More...
int	count () const noexcept
	Return the current reference count. More...
bool	unique () const noexcept
	Return true if the reference count is zero. More...
void	operator++ () noexcept
	Increment the reference count. More...
void	operator++ (int) noexcept
	Increment the reference count. More...
void	operator-- () noexcept
	Decrement the reference count. More...
void	operator-- (int) noexcept
	Decrement the reference count. More...

Static Public Member Functions
static autoPtr< compound >	New (const word &type, Istream &is)
	Construct compound from Istream. More...
static bool	isCompound (const word &name)
	Test if name is a known (registered) compound type. More...

Friends
Ostream &	operator<< (Ostream &os, const compound &ct)
	Output operator. More...

Detailed Description

Abstract base class for complex tokens.

Definition at line 168 of file token.H.

Constructor & Destructor Documentation

compound()

constexpr compound ( )

inlineconstexprnoexcept

Default construct.

Definition at line 200 of file token.H.

~compound()

virtual ~compound ( )

virtualdefaultnoexcept

Destructor.

Member Function Documentation

TypeName()

TypeName

(

"compound"

)

Declare type-name, virtual type (with debug switch)

declareRunTimeSelectionTable()

declareRunTimeSelectionTable	(	autoPtr	,
		compound	,
		Istream	,
		(Istream &is)	,
		(is)
	)

Declare run-time constructor selection table.

New()

Foam::autoPtr< Foam::token::compound > New ( const word &  type, Istream &  is  )

static

Construct compound from Istream.

Definition at line 56 of file token.C.

References Foam::abort(), Foam::FatalIOError, and FatalIOErrorInLookup.

Referenced by UIPstream::read(), and ISstream::read().

Here is the call graph for this function:

Here is the caller graph for this function:

isCompound()

bool isCompound ( const word &  name )

static

Test if name is a known (registered) compound type.

Definition at line 80 of file token.C.

References Foam::name().

Referenced by UIPstream::read(), and ISstream::read().

Here is the call graph for this function:

Here is the caller graph for this function:

moved() [1/2]

bool moved ( ) const

inlinenoexcept

Get compound transferred status.

Definition at line 219 of file token.H.

Referenced by Foam::printTokenInfo().

Here is the caller graph for this function:

moved() [2/2]

void moved ( bool  b )

inlinenoexcept

Set compound transferred status.

Definition at line 225 of file token.H.

References Foam::constant::physicoChemical::b.

size()

virtual label size ( ) const

pure virtual

The size of the underlying content.

Implemented in token::Compound< T >.

write()

virtual void write ( Ostream &  os ) const

pure virtual

Redirect write to underlying content.

Implemented in token::Compound< T >.

Referenced by Foam::operator<<().

Here is the caller graph for this function:

Friends And Related Function Documentation

operator<<

Ostream& operator<< ( Ostream &  os, const compound &  ct  )

friend

Output operator.

---

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

• src/OpenFOAM/db/IOstreams/token/token.H
• src/OpenFOAM/db/IOstreams/token/token.C