ensightGeoFile Class Reference

Specialized Ensight output with extra geometry file header. More...

Inheritance diagram for ensightGeoFile:
Collaboration diagram for ensightGeoFile:

Public Member Functions

 ensightGeoFile (const fileName &pathname, IOstream::streamFormat format=IOstream::BINARY)
 Construct from pathname. More...
 
 ~ensightGeoFile ()
 Destructor. More...
 
virtual OstreamwriteKeyword (const string &key)
 write keyword with trailing newline More...
 
- Public Member Functions inherited from ensightFile
 ensightFile (const fileName &pathname, IOstream::streamFormat format=IOstream::BINARY)
 Construct from pathname. More...
 
 ~ensightFile ()
 Destructor. More...
 
virtual Ostreamwrite (const char *buf, std::streamsize count)
 binary write More...
 
OstreamwriteBinaryHeader ()
 write "C Binary" for binary files (eg, geometry/measured) More...
 
OstreamwriteUndef ()
 write undef value More...
 
Ostreamwrite (const string &value)
 write string as "%80s" or as binary More...
 
Ostreamwrite (const label value)
 write integer as "%10d" or as binary More...
 
Ostreamwrite (const label value, const label fieldWidth)
 write integer with specified width or as binary More...
 
Ostreamwrite (const scalar value)
 write float as "%12.5e" or as binary More...
 
void newline ()
 Add carriage return to ascii stream. More...
 
- Public Member Functions inherited from OFstream
 ClassName ("OFstream")
 
 OFstream (const fileName &pathname, streamFormat format=ASCII, versionNumber version=currentVersion, compressionType compression=UNCOMPRESSED)
 Construct from pathname. More...
 
 ~OFstream ()
 Destructor. More...
 
const fileNamename () const
 Return the name of the stream. More...
 
fileNamename ()
 Return non-const access to the name of the stream. More...
 
virtual ostream & stdStream ()
 Access to underlying std::ostream. More...
 
virtual const ostream & stdStream () const
 Const access to underlying std::ostream. More...
 
void print (Ostream &) const
 Print description of IOstream to Ostream. More...
 
- Public Member Functions inherited from OSstream
 OSstream (ostream &os, const string &name, streamFormat format=ASCII, versionNumber version=currentVersion, compressionType compression=UNCOMPRESSED)
 Set stream status. More...
 
virtual ios_base::fmtflags flags () const
 Return flags of output stream. More...
 
virtual Ostreamwrite (const token &)
 Write next token to stream. More...
 
virtual Ostreamwrite (const char)
 Write character. More...
 
virtual Ostreamwrite (const char *)
 Write character string. More...
 
virtual Ostreamwrite (const word &)
 Write word. More...
 
virtual OstreamwriteQuoted (const std::string &, const bool quoted=true)
 Write std::string surrounded by quotes. More...
 
virtual Ostreamwrite (const floatScalar)
 Write floatScalar. More...
 
virtual Ostreamwrite (const doubleScalar)
 Write doubleScalar. More...
 
virtual void indent ()
 Add indentation characters. More...
 
virtual ios_base::fmtflags flags (const ios_base::fmtflags flags)
 Set flags of output stream. 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...
 
- Public Member Functions inherited from Ostream
 Ostream (streamFormat format=ASCII, versionNumber version=currentVersion, compressionType compression=UNCOMPRESSED)
 Set stream status. More...
 
virtual ~Ostream ()
 Destructor. More...
 
virtual Ostreamwrite (const keyType &)
 Write keyType. More...
 
unsigned short indentLevel () const
 Return indent level. More...
 
unsigned short & indentLevel ()
 Access to indent level. 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 (streamFormat format, versionNumber version, compressionType compression=UNCOMPRESSED)
 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...
 
label lineNumber () const
 Return current stream line number. More...
 
label & lineNumber ()
 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...
 
virtual ios::fmtflags flags (const ios::fmtflags f)=0
 Set flags of stream. More...
 
ios::fmtflags setf (const ios::fmtflags f)
 Set flags of stream. More...
 
ios::fmtflags setf (const ios::fmtflags f, const ios::fmtflags mask)
 Set flags of given field of stream. More...
 
void unsetf (const ios::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...
 

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...
 
- Static Public Member Functions inherited from ensightFile
static bool allowUndef ()
 Return setting for whether 'undef' values are allowed in results. More...
 
static string mask ()
 The '*' mask appropriate for subDir. More...
 
static string subDir (const label)
 Consistent zero-padded numbers for subdirectories. More...
 
static void subDirWidth (const label)
 Set width of subDir and mask. Default width is 8 digits. More...
 
static label subDirWidth ()
 Return current width of subDir and mask. More...
 
static bool allowUndef (bool)
 
static scalar undefValue (const scalar)
 Assign the value to represent undef in the results. 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 Public Attributes inherited from IOstream
static const versionNumber originalVersion
 Original version number. More...
 
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::iostate state)
 Set stream state. More...
 
void setGood ()
 Set stream to be good. 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...
 
static const unsigned short entryIndentation_ = 16
 Indentation of the entry from the start of the keyword. More...
 

Detailed Description

Specialized Ensight output with extra geometry file header.

Definition at line 45 of file ensightGeoFile.H.

Constructor & Destructor Documentation

ensightGeoFile ( const fileName pathname,
IOstream::streamFormat  format = IOstream::BINARY 
)

Construct from pathname.

Definition at line 31 of file ensightGeoFile.C.

References write().

Here is the call graph for this function:

Destructor.

Definition at line 47 of file ensightGeoFile.C.

Member Function Documentation

Foam::Ostream & writeKeyword ( const string key)
virtual

write keyword with trailing newline

Reimplemented from ensightFile.

Definition at line 53 of file ensightGeoFile.C.

References write().

Referenced by ensightPartFaces::writeConnectivity(), and ensightPart::writeGeometry().

Here is the call graph for this function:

Here is the caller graph for this function:


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