OBJstream Class Reference

OFstream which keeps track of vertices. More...

Inheritance diagram for OBJstream:
Collaboration diagram for OBJstream:

Public Member Functions

 ClassName ("OBJstream")
 
 OBJstream (const fileName &filePath, streamFormat format=ASCII, versionNumber version=currentVersion, compressionType compression=UNCOMPRESSED)
 Construct from filePath. More...
 
 ~OBJstream ()
 Destructor. More...
 
label nVertices () const
 Return the number of vertices written. More...
 
virtual Ostreamwrite (const char)
 Write character. More...
 
virtual Ostreamwrite (const char *)
 Write character string. More...
 
virtual Ostreamwrite (const word &)
 Write word. More...
 
virtual Ostreamwrite (const string &)
 Write string with double quotes. More...
 
virtual OstreamwriteQuoted (const std::string &, const bool quoted=true)
 Write std::string surrounded by quotes. More...
 
Ostreamwrite (const point &)
 Write point. More...
 
Ostreamwrite (const point &, const vector &)
 Write point and vector normal ('vn') More...
 
Ostreamwrite (const edge &, const UList< point > &)
 Write edge as points with line. More...
 
Ostreamwrite (const linePointRef &)
 Write line. More...
 
Ostreamwrite (const linePointRef &, const vector &n0, const vector &n1)
 Write line with points and vector normals ('vn') More...
 
Ostreamwrite (const triPointRef &, const bool lines=true)
 Write triangle as points with lines or filled polygon. More...
 
Ostreamwrite (const face &, const UList< point > &, const bool lines=true)
 Write face as points with lines or filled polygon. More...
 
Ostreamwrite (const faceList &, const pointField &, const bool lines=true)
 Write patch as points and faces with lines or filled polygons. More...
 
virtual Ostreamwrite (const char)=0
 Inherit write from Ostream. More...
 
virtual Ostreamwrite (const char *)=0
 Inherit write from Ostream. More...
 
virtual Ostreamwrite (const word &)=0
 Inherit write from Ostream. More...
 
virtual Ostreamwrite (const string &)=0
 Inherit write from Ostream. More...
 
virtual Ostreamwrite (const verbatimString &)=0
 Inherit write from Ostream. More...
 
virtual Ostreamwrite (const int32_t)=0
 Inherit write from Ostream. More...
 
virtual Ostreamwrite (const int64_t)=0
 Inherit write from Ostream. More...
 
virtual Ostreamwrite (const uint32_t)=0
 Inherit write from Ostream. More...
 
virtual Ostreamwrite (const uint64_t)=0
 Inherit write from Ostream. More...
 
virtual Ostreamwrite (const floatScalar)=0
 Inherit write from Ostream. More...
 
virtual Ostreamwrite (const doubleScalar)=0
 Inherit write from Ostream. More...
 
virtual Ostreamwrite (const longDoubleScalar)=0
 Inherit write from Ostream. More...
 
virtual Ostreamwrite (const char *, std::streamsize)=0
 Inherit write from Ostream. More...
 
- Public Member Functions inherited from OFstream
 ClassName ("OFstream")
 
 OFstream (const fileName &filePath, streamFormat format=ASCII, versionNumber version=currentVersion, compressionType compression=UNCOMPRESSED, const bool append=false)
 Construct from filePath. 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...
 
 OSstream (const OSstream &)=default
 Copy construct. More...
 
virtual ios_base::fmtflags flags () const
 Return flags of output stream. More...
 
virtual Ostreamwrite (const verbatimString &)
 Write verbatimString with #{ }#. 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 int32_t. More...
 
virtual Ostreamwrite (const uint64_t)
 Write int64_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 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...
 
void operator= (const OSstream &)=delete
 Disallow default bitwise assignment. 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...
 
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...
 
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...
 

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 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 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 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

OFstream which keeps track of vertices.

Source files

Definition at line 53 of file OBJstream.H.

Constructor & Destructor Documentation

◆ OBJstream()

OBJstream ( const fileName filePath,
streamFormat  format = ASCII,
versionNumber  version = currentVersion,
compressionType  compression = UNCOMPRESSED 
)

Construct from filePath.

Definition at line 59 of file OBJstream.C.

◆ ~OBJstream()

~OBJstream ( )

Destructor.

Definition at line 75 of file OBJstream.C.

Member Function Documentation

◆ ClassName()

ClassName ( "OBJstream"  )

◆ nVertices()

label nVertices ( ) const
inline

Return the number of vertices written.

Definition at line 95 of file OBJstream.H.

◆ write() [1/25]

◆ write() [2/25]

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

Write character string.

Reimplemented from OSstream.

Definition at line 88 of file OBJstream.C.

References p.

◆ write() [3/25]

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

Write word.

Reimplemented from OSstream.

Definition at line 98 of file OBJstream.C.

References Foam::vtkWriteOps::write().

Here is the call graph for this function:

◆ write() [4/25]

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

Write string with double quotes.

Reimplemented from OSstream.

Definition at line 105 of file OBJstream.C.

References token::BEGIN_STRING, Foam::constant::universal::c, token::END_STRING, token::NL, and OSstream::write().

Here is the call graph for this function:

◆ writeQuoted()

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

Write std::string surrounded by quotes.

Optional write without quotes.

Reimplemented from OSstream.

Definition at line 148 of file OBJstream.C.

References token::BEGIN_STRING, Foam::constant::universal::c, token::END_STRING, token::NL, OSstream::write(), and Foam::vtkWriteOps::write().

Here is the call graph for this function:

◆ write() [5/25]

Foam::Ostream & write ( const point pt)

Write point.

Definition at line 208 of file OBJstream.C.

References Foam::nl, Foam::vtkWriteOps::write(), Vector< Cmpt >::x(), Vector< Cmpt >::y(), and Vector< Cmpt >::z().

Here is the call graph for this function:

◆ write() [6/25]

Foam::Ostream & write ( const point pt,
const vector n 
)

Write point and vector normal ('vn')

Definition at line 216 of file OBJstream.C.

References n, Foam::nl, OSstream::write(), and Foam::vtkWriteOps::write().

Here is the call graph for this function:

◆ write() [7/25]

Foam::Ostream & write ( const edge e,
const UList< point > &  points 
)

Write edge as points with line.

Definition at line 225 of file OBJstream.C.

References Foam::e, Foam::nl, points, and Foam::vtkWriteOps::write().

Here is the call graph for this function:

◆ write() [8/25]

Foam::Ostream & write ( const linePointRef ln)

Write line.

Definition at line 234 of file OBJstream.C.

References Foam::ln(), Foam::nl, and Foam::vtkWriteOps::write().

Here is the call graph for this function:

◆ write() [9/25]

Foam::Ostream & write ( const linePointRef ln,
const vector n0,
const vector n1 
)

Write line with points and vector normals ('vn')

Definition at line 243 of file OBJstream.C.

References Foam::ln(), Foam::nl, and Foam::vtkWriteOps::write().

Here is the call graph for this function:

◆ write() [10/25]

Foam::Ostream & write ( const triPointRef f,
const bool  lines = true 
)

Write triangle as points with lines or filled polygon.

Definition at line 257 of file OBJstream.C.

References f(), and Foam::vtkWriteOps::write().

Here is the call graph for this function:

◆ write() [11/25]

Foam::Ostream & write ( const face f,
const UList< point > &  points,
const bool  lines = true 
)

Write face as points with lines or filled polygon.

Definition at line 289 of file OBJstream.C.

References f(), forAll, points, and Foam::vtkWriteOps::write().

Here is the call graph for this function:

◆ write() [12/25]

Foam::Ostream & write ( const faceList fcs,
const pointField points,
const bool  lines = true 
)

Write patch as points and faces with lines or filled polygons.

Definition at line 323 of file OBJstream.C.

References Foam::e, PrimitivePatch< FaceList, PointField >::edges(), f(), forAll, PrimitivePatch< FaceList, PointField >::localFaces(), PrimitivePatch< FaceList, PointField >::localPoints(), Foam::nl, points, List< T >::size(), and Foam::vtkWriteOps::write().

Here is the call graph for this function:

◆ write() [13/25]

virtual Ostream& write

Inherit write from Ostream.

◆ write() [14/25]

virtual Ostream& write

Inherit write from Ostream.

◆ write() [15/25]

virtual Ostream& write

Inherit write from Ostream.

◆ write() [16/25]

virtual Ostream& write

Inherit write from Ostream.

◆ write() [17/25]

virtual Ostream& write

Inherit write from Ostream.

◆ write() [18/25]

virtual Ostream& write

Inherit write from Ostream.

◆ write() [19/25]

virtual Ostream& write

Inherit write from Ostream.

◆ write() [20/25]

virtual Ostream& write

Inherit write from Ostream.

◆ write() [21/25]

virtual Ostream& write

Inherit write from Ostream.

◆ write() [22/25]

virtual Ostream& write

Inherit write from Ostream.

◆ write() [23/25]

virtual Ostream& write

Inherit write from Ostream.

◆ write() [24/25]

virtual Ostream& write

Inherit write from Ostream.

◆ write() [25/25]

virtual Ostream& write

Inherit write from Ostream.


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