OTstream Class Reference

Output token stream. More...

Inheritance diagram for OTstream:
Collaboration diagram for OTstream:

Public Member Functions

 OTstream (const string &name, const streamFormat format=ASCII, const versionNumber version=currentVersion, const bool global=false)
 Construct given name write format and IO version. More...
 
virtual ~OTstream ()
 Destructor. More...
 
virtual const fileNamename () const
 Return the name of the stream. More...
 
virtual fileNamename ()
 Return non-const access to the name of the stream. More...
 
ios_base::fmtflags flags () const
 Return flags of output stream. More...
 
virtual Ostreamwrite (const token &)
 Write token. More...
 
virtual OstreamwriteCompoundTag (const word &typeName)
 No need to write the compound token tag for an OTstream. More...
 
virtual Ostreamwrite (const char)
 Write character. More...
 
virtual Ostreamwrite (const char *)
 Parse raw C-string and append tokens. More...
 
virtual Ostreamwrite (const word &)
 Write word. More...
 
virtual Ostreamwrite (const string &)
 Write string. More...
 
virtual Ostreamwrite (const keyType &)
 Write keyType. More...
 
virtual Ostreamwrite (const verbatimString &)
 Write verbatimString. More...
 
virtual OstreamwriteQuoted (const std::string &, const bool quoted=true)
 Write std::string surrounded by quotes. More...
 
virtual Ostreamwrite (const int32_t)
 Write int32_t. More...
 
virtual Ostreamwrite (const int64_t)
 Write int64_t. More...
 
virtual Ostreamwrite (const uint32_t)
 Write uint32_t. More...
 
virtual Ostreamwrite (const uint64_t)
 Write uint64_t. More...
 
virtual Ostreamwrite (const floatScalar)
 Write floatScalar. More...
 
virtual Ostreamwrite (const doubleScalar)
 Write doubleScalar. More...
 
virtual Ostreamwrite (const longDoubleScalar)
 Write longDoubleScalar. More...
 
virtual Ostreamwrite (const char *, std::streamsize)
 Write binary block. More...
 
virtual void indent ()
 Add indentation characters. More...
 
virtual void flush ()
 Flush stream. More...
 
virtual void endl ()
 Add newline and flush stream. More...
 
virtual int width () const
 Get width of output field. More...
 
virtual int width (const int)
 Set width of output field (and return old width) More...
 
virtual int precision () const
 Get precision of output field. More...
 
virtual int precision (const int)
 Set precision of output field (and return old precision) More...
 
ios_base::fmtflags flags (const ios_base::fmtflags)
 Set flags of stream. More...
 
void print (Ostream &) const
 Print description of IOstream to Ostream. More...
 
- Public Member Functions inherited from Ostream
 Ostream (const streamFormat format=ASCII, const versionNumber version=currentVersion, const compressionType compression=UNCOMPRESSED, const bool global=false)
 Set stream status. More...
 
virtual ~Ostream ()
 Destructor. More...
 
unsigned short indentLevel () const
 Return indent level. More...
 
unsigned short & indentLevel ()
 Access to indent level. More...
 
unsigned short indentSize () const
 Return the number of characters in an indent. More...
 
void incrIndent ()
 Incrememt the indent level. More...
 
void decrIndent ()
 Decrememt the indent level. More...
 
OstreamwriteKeyword (const keyType &)
 Write the keyword followed by an appropriate indentation. More...
 
Ostreamoperator() () const
 Return a non-const reference to const Ostream. More...
 
- Public Member Functions inherited from IOstream
 IOstream (const streamFormat format, const versionNumber version, const compressionType compression=UNCOMPRESSED, const bool global=false)
 Construct setting format and version. More...
 
virtual ~IOstream ()
 Destructor. More...
 
virtual bool check (const char *operation) const
 Check IOstream status for given operation. More...
 
void fatalCheck (const char *operation) const
 Check IOstream status for given operation. More...
 
bool opened () const
 Return true if stream has been opened. More...
 
bool closed () const
 Return true if stream is closed. More...
 
bool good () const
 Return true if next operation might succeed. More...
 
bool eof () const
 Return true if end of input seen. More...
 
bool fail () const
 Return true if next operation will fail. More...
 
bool bad () const
 Return true if stream is corrupted. More...
 
 operator void * () const
 Return non-zero if the stream has not failed. More...
 
bool operator! () const
 Return true if the stream has failed. More...
 
streamFormat format () const
 Return current stream format. More...
 
streamFormat format (const streamFormat fmt)
 Set the stream format. More...
 
streamFormat format (const word &fmt)
 Set the stream format from word. More...
 
versionNumber version () const
 Return the stream version. More...
 
versionNumber version (const versionNumber ver)
 Set the stream version. More...
 
compressionType compression () const
 Return the stream compression. More...
 
compressionType compression (const compressionType cmp)
 Set the stream compression. More...
 
compressionType compression (const word &cmp)
 Set the stream compression from word. More...
 
bool global () const
 Return global state. More...
 
bool & global ()
 Return global state. More...
 
label lineNumber () const
 Return current stream line number. More...
 
labellineNumber ()
 Return current stream line number. More...
 
label lineNumber (const label ln)
 Set the stream line number. More...
 
void setEof ()
 Set stream to have reached eof. More...
 
void setFail ()
 Set stream to have failed. More...
 
void setBad ()
 Set stream to be bad. More...
 
ios_base::fmtflags setf (const ios_base::fmtflags f)
 Set flags of stream. More...
 
ios_base::fmtflags setf (const ios_base::fmtflags f, const ios_base::fmtflags mask)
 Set flags of given field of stream. More...
 
void unsetf (const ios_base::fmtflags uf)
 Unset flags of stream. More...
 
void print (Ostream &, const int streamState) const
 Check given stream state bits. More...
 
InfoProxy< IOstreaminfo () const
 Return info proxy. More...
 
- Public Member Functions inherited from DynamicList< token >
 DynamicList ()
 Construct null. More...
 
 DynamicList (const label)
 Construct given size. More...
 
 DynamicList (const label, const token &)
 Construct with given size and value for all elements. More...
 
 DynamicList (const DynamicList< token, SizeInc, SizeMult, SizeDiv > &)
 Copy constructor. More...
 
 DynamicList (DynamicList< token, SizeInc, SizeMult, SizeDiv > &&)
 Move constructor. More...
 
 DynamicList (const UList< token > &)
 Construct from UList. Size set to UList size. More...
 
 DynamicList (const UIndirectList< token > &)
 Construct from UIndirectList. Size set to UIndirectList size. More...
 
 DynamicList (List< token > &&)
 Move constructor. More...
 
 DynamicList (Istream &)
 Construct from Istream. Size set to size of list read. More...
 
label capacity () const
 Size of the underlying storage. More...
 
void setCapacity (const label)
 Alter the size of the underlying storage. More...
 
void setSize (const label)
 Alter the addressed list size. More...
 
void setSize (const label, const token &)
 Alter the addressed list size and fill new space with a. More...
 
void resize (const label)
 Alter the addressed list size. More...
 
void resize (const label, const token &)
 Alter the addressed list size and fill new space with a. More...
 
void reserve (const label)
 Reserve allocation space for at least this size. More...
 
void clear ()
 Clear the addressed list, i.e. set the size to zero. More...
 
void clearStorage ()
 Clear the list and delete storage. More...
 
DynamicList< token, SizeInc, SizeMult, SizeDiv > & shrink ()
 Shrink the allocated space to the number of elements used. More...
 
void transfer (List< token > &)
 Transfer contents of the argument List into this. More...
 
void transfer (DynamicList< token, SizeInc, SizeMult, SizeDiv > &)
 Transfer contents of the argument DynamicList into this. More...
 
DynamicList< token, SizeInc, SizeMult, SizeDiv > & append (const token &)
 Append an element at the end of the list. More...
 
DynamicList< token, SizeInc, SizeMult, SizeDiv > & append (const UList< token > &)
 Append a List at the end of this list. More...
 
DynamicList< token, SizeInc, SizeMult, SizeDiv > & append (const UIndirectList< token > &)
 Append a UIndirectList at the end of this list. More...
 
token remove ()
 Remove and return the top element. More...
 
tokenoperator() (const label)
 Return non-const access to an element, resizing list if. More...
 
void operator= (const token &)
 Assignment of all addressed entries to the given value. More...
 
void operator= (const DynamicList< token, SizeInc, SizeMult, SizeDiv > &)
 Assignment operator. More...
 
void operator= (DynamicList< token, SizeInc, SizeMult, SizeDiv > &&)
 Move assignment operator. More...
 
void operator= (const UList< token > &)
 Assignment to UList. More...
 
void operator= (List< token > &&)
 Move assignment to List. More...
 
void operator= (const UIndirectList< token > &)
 Assignment to UIndirectList. More...
 
UList< token >::iterator erase (typename UList< token >::iterator)
 Erase an element, move the remaining elements to fill the gap. More...
 
- Public Member Functions inherited from List< T >
 List ()
 Null constructor. More...
 
 List (const label)
 Construct with given size. More...
 
 List (const label, const T &)
 Construct with given size and value for all elements. More...
 
 List (const label, const zero)
 Construct with given size initialising all elements to zero. More...
 
 List (const List< T > &)
 Copy constructor. More...
 
template<class T2 >
 List (const UList< T2 > &)
 Copy constructor from list containing another type. More...
 
 List (List< T > &&)
 Move constructor. More...
 
 List (List< T > &, bool reuse)
 Construct as copy or reuse as specified. More...
 
 List (const UList< T > &, const labelUList &mapAddressing)
 Construct as subset. More...
 
template<class InputIterator >
 List (InputIterator first, InputIterator last)
 Construct given start and end iterators. More...
 
template<unsigned Size>
 List (const FixedList< T, Size > &)
 Construct as copy of FixedList<T, Size> More...
 
 List (const PtrList< T > &)
 Construct as copy of PtrList<T> More...
 
 List (const SLList< T > &)
 Construct as copy of SLList<T> More...
 
 List (const UIndirectList< T > &)
 Construct as copy of UIndirectList<T> More...
 
 List (const BiIndirectList< T > &)
 Construct as copy of BiIndirectList<T> More...
 
 List (std::initializer_list< T >)
 Construct from an initialiser list. More...
 
 List (Istream &)
 Construct from Istream. More...
 
autoPtr< List< T > > clone () const
 Clone. More...
 
 ~List ()
 Destructor. More...
 
label size () const
 Return the number of elements in the UList. More...
 
void resize (const label)
 Alias for setSize(const label) More...
 
void resize (const label, const T &)
 Alias for setSize(const label, const T&) More...
 
void setSize (const label)
 Reset size of List. More...
 
void setSize (const label, const T &)
 Reset size of List and value for new elements. More...
 
void clear ()
 Clear the list, i.e. set size to zero. More...
 
void append (const T &)
 Append an element at the end of the list. More...
 
void append (const UList< T > &)
 Append a List at the end of this list. More...
 
void append (const UIndirectList< T > &)
 Append a UIndirectList at the end of this list. More...
 
void transfer (List< T > &)
 Transfer the contents of the argument List into this list. More...
 
template<unsigned SizeInc, unsigned SizeMult, unsigned SizeDiv>
void transfer (DynamicList< T, SizeInc, SizeMult, SizeDiv > &)
 Transfer the contents of the argument List into this list. More...
 
void transfer (SortableList< T > &)
 Transfer the contents of the argument List into this list. More...
 
TnewElmt (const label)
 Return subscript-checked element of UList. More...
 
void shallowCopy (const UList< T > &)=delete
 Disallow implicit shallowCopy. More...
 
void operator= (const UList< T > &)
 Assignment to UList operator. Takes linear time. More...
 
void operator= (const List< T > &)
 Assignment operator. Takes linear time. More...
 
void operator= (List< T > &&)
 Move assignment operator. More...
 
void operator= (const SLList< T > &)
 Assignment to SLList operator. Takes linear time. More...
 
void operator= (const UIndirectList< T > &)
 Assignment to UIndirectList operator. Takes linear time. More...
 
void operator= (const BiIndirectList< T > &)
 Assignment to BiIndirectList operator. Takes linear time. More...
 
void operator= (std::initializer_list< T >)
 Assignment to an initialiser list. More...
 
void operator= (const T &)
 Assignment of all entries to the given value. More...
 
void operator= (const zero)
 Assignment of all entries to zero. More...
 
- Public Member Functions inherited from UList< T >
 UList ()
 Null constructor. More...
 
 UList (T *__restrict__ v, label size)
 Construct from components. More...
 
 UList (const UList< T > &)=default
 Copy construct. More...
 
label fcIndex (const label i) const
 Return the forward circular index, i.e. the next index. More...
 
label rcIndex (const label i) const
 Return the reverse circular index, i.e. the previous index. More...
 
std::streamsize byteSize () const
 Return the binary size in number of characters of the UList. More...
 
const Tcdata () const
 Return a const pointer to the first data element,. More...
 
Tdata ()
 Return a pointer to the first data element,. More...
 
Tfirst ()
 Return the first element of the list. More...
 
const Tfirst () const
 Return first element of the list. More...
 
Tlast ()
 Return the last element of the list. More...
 
const Tlast () const
 Return the last element of the list. More...
 
void checkStart (const label start) const
 Check start is within valid range (0 ... size-1) More...
 
void checkSize (const label size) const
 Check size is within valid range (0 ... size) More...
 
void checkIndex (const label i) const
 Check index i is within valid range (0 ... size-1) More...
 
void shallowCopy (const UList< T > &)
 Copy the pointer held by the given UList. More...
 
void deepCopy (const UList< T > &)
 Copy elements of the given UList. More...
 
Toperator[] (const label)
 Return element of UList. More...
 
const Toperator[] (const label) const
 Return element of constant UList. More...
 
 operator const Foam::List< T > & () const
 Allow cast to a const List<T>&. More...
 
void operator= (const T &)
 Assignment of all entries to the given value. More...
 
void operator= (const zero)
 Assignment of all entries to zero. More...
 
iterator begin ()
 Return an iterator to begin traversing the UList. More...
 
iterator end ()
 Return an iterator to end traversing the UList. More...
 
const_iterator cbegin () const
 Return const_iterator to begin traversing the constant UList. More...
 
const_iterator cend () const
 Return const_iterator to end traversing the constant UList. More...
 
const_iterator begin () const
 Return const_iterator to begin traversing the constant UList. More...
 
const_iterator end () const
 Return const_iterator to end traversing the constant UList. More...
 
reverse_iterator rbegin ()
 Return reverse_iterator to begin reverse traversing the UList. More...
 
reverse_iterator rend ()
 Return reverse_iterator to end reverse traversing the UList. More...
 
const_reverse_iterator crbegin () const
 Return const_reverse_iterator to begin reverse traversing the UList. More...
 
const_reverse_iterator crend () const
 Return const_reverse_iterator to end reverse traversing the UList. More...
 
const_reverse_iterator rbegin () const
 Return const_reverse_iterator to begin reverse traversing the UList. More...
 
const_reverse_iterator rend () const
 Return const_reverse_iterator to end reverse traversing the UList. More...
 
label size () const
 Return the number of elements in the UList. More...
 
label max_size () const
 Return size of the largest possible UList. More...
 
bool empty () const
 Return true if the UList is empty (ie, size() is zero) More...
 
void swap (UList< T > &)
 Swap two ULists of the same type in constant time. More...
 
bool operator== (const UList< T > &) const
 Equality operation on ULists of the same type. More...
 
bool operator!= (const UList< T > &) const
 The opposite of the equality operation. Takes linear time. More...
 
bool operator< (const UList< T > &) const
 Compare two ULists lexicographically. Takes linear time. More...
 
bool operator> (const UList< T > &) const
 Compare two ULists lexicographically. Takes linear time. More...
 
bool operator<= (const UList< T > &) const
 Return true if !(a > b). Takes linear time. More...
 
bool operator>= (const UList< T > &) const
 Return true if !(a < b). Takes linear time. More...
 
const bool & operator[] (const label i) const
 

Additional Inherited Members

- Public Types inherited from IOstream
enum  streamAccess { OPENED , CLOSED }
 Enumeration for whether the stream open or closed. More...
 
enum  streamFormat { ASCII , BINARY }
 Enumeration for the format of data in the stream. More...
 
enum  compressionType { UNCOMPRESSED , COMPRESSED }
 Enumeration for the format of data in the stream. More...
 
- Public Types inherited from List< T >
typedef SubList< TsubList
 Declare type of subList. More...
 
- Public Types inherited from UList< T >
typedef T value_type
 Type of values the UList contains. More...
 
typedef Treference
 Type that can be used for storing into. More...
 
typedef const Tconst_reference
 Type that can be used for storing into. More...
 
typedef label difference_type
 The type that can represent the difference between any two. More...
 
typedef label size_type
 The type that can represent the size of a UList. More...
 
typedef Titerator
 Random access iterator for traversing UList. More...
 
typedef const Tconst_iterator
 Random access iterator for traversing UList. More...
 
typedef std::reverse_iterator< iteratorreverse_iterator
 Reverse iterator for reverse traversal of UList. More...
 
typedef std::reverse_iterator< const_iteratorconst_reverse_iterator
 Reverse iterator for reverse traversal of constant UList. More...
 
- Static Public Member Functions inherited from IOstream
static streamFormat formatEnum (const word &)
 Return stream format of given format name. More...
 
static compressionType compressionEnum (const word &)
 Return compression of given compression name. More...
 
static unsigned int defaultPrecision ()
 Return the default precision. More...
 
static unsigned int defaultPrecision (unsigned int p)
 Reset the default precision (and return old precision) More...
 
static unsigned int highPrecision ()
 Return a high precision for writing data that is. More...
 
static unsigned int fullPrecision ()
 Return a full precision for writing data that is *very*. More...
 
- Static Public Member Functions inherited from List< T >
static const List< T > & null ()
 Return a null List. More...
 
- Static Public Member Functions inherited from UList< T >
static const UList< T > & null ()
 Return a null UList. More...
 
- Static Public Attributes inherited from IOstream
static const versionNumber currentVersion
 Current version number. More...
 
static unsigned int precision_
 Default precision. More...
 
- Protected Member Functions inherited from IOstream
void setOpened ()
 Set stream opened. More...
 
void setClosed ()
 Set stream closed. More...
 
void setState (ios_base::iostate state)
 Set stream state. More...
 
void setGood ()
 Set stream to be good. More...
 
- Protected Member Functions inherited from List< T >
void size (const label)
 Override size to be inconsistent with allocated storage. More...
 
- Protected Attributes inherited from Ostream
unsigned short indentLevel_
 Current indent level. More...
 
- Protected Attributes inherited from IOstream
label lineNumber_
 
- Static Protected Attributes inherited from Ostream
static const unsigned short indentSize_ = 4
 Number of spaces per indent level. More...
 

Detailed Description

Output token stream.

Source files
See also
Foam::ITstream

Definition at line 52 of file OTstream.H.

Constructor & Destructor Documentation

◆ OTstream()

OTstream ( const string name,
const streamFormat  format = ASCII,
const versionNumber  version = currentVersion,
const bool  global = false 
)

Construct given name write format and IO version.

Definition at line 35 of file OTstream.C.

References IOstream::setGood(), and IOstream::setOpened().

Here is the call graph for this function:

◆ ~OTstream()

~OTstream ( )
virtual

Destructor.

Definition at line 53 of file OTstream.C.

Member Function Documentation

◆ name() [1/2]

virtual const fileName& name ( ) const
inlinevirtual

Return the name of the stream.

Reimplemented from IOstream.

Definition at line 86 of file OTstream.H.

Referenced by codeBlockEntry::execute(), functionEntry::insert(), and Foam::readConfigFile().

Here is the caller graph for this function:

◆ name() [2/2]

virtual fileName& name ( )
inlinevirtual

Return non-const access to the name of the stream.

Reimplemented from IOstream.

Definition at line 92 of file OTstream.H.

◆ flags() [1/2]

ios_base::fmtflags flags ( ) const
inlinevirtual

Return flags of output stream.

Implements IOstream.

Definition at line 98 of file OTstream.H.

◆ write() [1/15]

Foam::Ostream & write ( const token t)
virtual

Write token.

Reimplemented from Ostream.

Definition at line 59 of file OTstream.C.

◆ writeCompoundTag()

virtual Ostream& writeCompoundTag ( const word typeName)
inlinevirtual

No need to write the compound token tag for an OTstream.

Reimplemented from Ostream.

Definition at line 110 of file OTstream.H.

◆ write() [2/15]

◆ write() [3/15]

Foam::Ostream & write ( const char *  str)
virtual

Parse raw C-string and append tokens.

Implements Ostream.

Definition at line 103 of file OTstream.C.

References IOstream::bad(), Istream::eof(), token::good(), and ISstream::read().

Here is the call graph for this function:

◆ write() [4/15]

Foam::Ostream & write ( const word str)
virtual

Write word.

Implements Ostream.

Definition at line 117 of file OTstream.C.

◆ write() [5/15]

Foam::Ostream & write ( const string str)
virtual

Write string.

Implements Ostream.

Definition at line 124 of file OTstream.C.

◆ write() [6/15]

Foam::Ostream & write ( const keyType kt)
virtual

Write keyType.

Implements Ostream.

Definition at line 131 of file OTstream.C.

◆ write() [7/15]

Foam::Ostream & write ( const verbatimString vs)
virtual

Write verbatimString.

Implements Ostream.

Definition at line 138 of file OTstream.C.

◆ writeQuoted()

Foam::Ostream & writeQuoted ( const std::string &  str,
const bool  quoted = true 
)
virtual

Write std::string surrounded by quotes.

Optional write without quotes.

Implements Ostream.

Definition at line 145 of file OTstream.C.

◆ write() [8/15]

Foam::Ostream & write ( const int32_t  val)
virtual

Write int32_t.

Implements Ostream.

Definition at line 163 of file OTstream.C.

◆ write() [9/15]

Foam::Ostream & write ( const int64_t  val)
virtual

Write int64_t.

Implements Ostream.

Definition at line 170 of file OTstream.C.

◆ write() [10/15]

Foam::Ostream & write ( const uint32_t  val)
virtual

Write uint32_t.

Implements Ostream.

Definition at line 177 of file OTstream.C.

◆ write() [11/15]

Foam::Ostream & write ( const uint64_t  val)
virtual

Write uint64_t.

Implements Ostream.

Definition at line 184 of file OTstream.C.

◆ write() [12/15]

Foam::Ostream & write ( const floatScalar  val)
virtual

Write floatScalar.

Implements Ostream.

Definition at line 191 of file OTstream.C.

◆ write() [13/15]

Foam::Ostream & write ( const doubleScalar  val)
virtual

Write doubleScalar.

Implements Ostream.

Definition at line 198 of file OTstream.C.

◆ write() [14/15]

Foam::Ostream & write ( const longDoubleScalar  val)
virtual

Write longDoubleScalar.

Implements Ostream.

Definition at line 205 of file OTstream.C.

◆ write() [15/15]

Foam::Ostream & write ( const char *  data,
std::streamsize  count 
)
virtual

Write binary block.

Implements Ostream.

Definition at line 212 of file OTstream.C.

References NotImplemented.

◆ indent()

virtual void indent ( )
inlinevirtual

Add indentation characters.

Implements Ostream.

Definition at line 166 of file OTstream.H.

◆ flush()

virtual void flush ( )
inlinevirtual

Flush stream.

Implements Ostream.

Definition at line 173 of file OTstream.H.

◆ endl()

virtual void endl ( )
inlinevirtual

Add newline and flush stream.

Implements Ostream.

Definition at line 177 of file OTstream.H.

◆ width() [1/2]

virtual int width ( ) const
inlinevirtual

Get width of output field.

Implements Ostream.

Definition at line 181 of file OTstream.H.

◆ width() [2/2]

virtual int width ( const int  )
inlinevirtual

Set width of output field (and return old width)

Implements Ostream.

Definition at line 187 of file OTstream.H.

◆ precision() [1/2]

virtual int precision ( ) const
inlinevirtual

Get precision of output field.

Implements Ostream.

Definition at line 193 of file OTstream.H.

◆ precision() [2/2]

virtual int precision ( const int  )
inlinevirtual

Set precision of output field (and return old precision)

Implements Ostream.

Definition at line 199 of file OTstream.H.

◆ flags() [2/2]

ios_base::fmtflags flags ( const ios_base::fmtflags  )
inlinevirtual

Set flags of stream.

Implements IOstream.

Definition at line 208 of file OTstream.H.

◆ print()

void print ( Ostream os) const
virtual

Print description of IOstream to Ostream.

Reimplemented from IOstream.

Definition at line 219 of file OTstream.C.

References Foam::name(), and IOstream::print().

Here is the call graph for this function:

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