token::Compound< T > Class Template Reference

A templated class for holding compound tokens. More...

Inheritance diagram for token::Compound< T >:

Collaboration diagram for token::Compound< T >:

Public Member Functions
	TypeName ("Compound<T>")
	Declare type-name, virtual type (with debug switch) More...
	Compound (const T &val)
	Copy construct. More...
	Compound (T &&val)
	Move construct. More...
	Compound (Istream &is)
	Read construct from Istream. More...
virtual label	size () const
	The size of the underlying content. More...
virtual void	write (Ostream &os) const
	Redirect write to underlying content. More...
Public Member Functions inherited from token::compound
	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...
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...

Additional Inherited Members
Static Public Member Functions inherited from token::compound
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...

Detailed Description

template<class T>
class Foam::token::Compound< T >

A templated class for holding compound tokens.

Definition at line 281 of file token.H.

Constructor & Destructor Documentation

Compound() [1/3]

Compound ( const T &  val )

inlineexplicit

Copy construct.

Definition at line 298 of file token.H.

Compound() [2/3]

Compound ( T &&  val )

inlineexplicit

Move construct.

Definition at line 306 of file token.H.

Compound() [3/3]

Compound ( Istream &  is )

inlineexplicit

Read construct from Istream.

Definition at line 314 of file token.H.

Member Function Documentation

TypeName()

TypeName

(

"Compound<T>"

)

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

size()

virtual label size ( ) const

inlinevirtual

The size of the underlying content.

Implements token::compound.

Definition at line 325 of file token.H.

write()

virtual void write ( Ostream &  os ) const

inlinevirtual

Redirect write to underlying content.

Implements token::compound.

Definition at line 333 of file token.H.

---

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

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