Write set in raw tabulated format. More...

Inheritance diagram for rawSetWriter:

Collaboration diagram for rawSetWriter:

Public Member Functions
	TypeName ("raw")
	Runtime type information. More...

	rawSetWriter (const IOstream::streamFormat writeFormat, const IOstream::compressionType writeCompression)
	Construct given write options. More...

	rawSetWriter (const dictionary &dict)
	Construct from dictionary. More...

	rawSetWriter (const rawSetWriter &writer)
	Construct copy. More...

virtual autoPtr< setWriter >	clone () const
	Construct and return a clone. More...

virtual	~rawSetWriter ()
	Destructor. More...

virtual void	write (const fileName &outputDir, const fileName &setName, const coordSet &set, const wordList &valueSetNames #define TypeValueSetsConstArg(Type, nullArg)) const
	Write a coordSet and associated data. More...

virtual void	write (const fileName &outputDir, const fileName &setName, const coordSet &set, const wordList &valueSetNames #define TypeValueSetsConstArg(Type, nullArg)) const=0
	Inherit base class write methods. More...

virtual void	write (const fileName &outputDir, const fileName &setName, const coordSet &set, const wordList &valueSetNames #define TypeValueSetsConstArg(Type, nullArg)) const
	Inherit base class write methods. More...

template<class ... Args>
void	write (const fileName &outputDir, const fileName &setName, const coordSet &set, const Args &... args) const
	Inherit base class write methods. More...

Public Member Functions inherited from setWriter
	TypeName ("setWriter")
	Runtime type information. More...

	declareRunTimeSelectionTable (autoPtr, setWriter, word,(const IOstream::streamFormat writeFormat, const IOstream::compressionType writeCompression),(writeFormat, writeCompression))

	declareRunTimeSelectionTable (autoPtr, setWriter, dict,(const dictionary &dict),(dict))

	setWriter (const IOstream::streamFormat writeFormat, const IOstream::compressionType writeCompression)
	Construct given write options. More...

	setWriter (const dictionary &dict)
	Construct from dictionary. More...

	setWriter (const setWriter &writer)
	Construct copy. More...

virtual	~setWriter ()=0
	Destructor. More...

template<class ... Args>
void	write (const fileName &outputDir, const fileName &setName, const coordSet &set, const Args &... args) const
	Write fields for a single surface to file. For use in code where. More...

template<class Type >
Foam::Ostream &	writeValue (const Type &value, Ostream &os, const bool align) const

Protected Member Functions
virtual void	writeSegmentSeparator (Ostream &os) const
	Write a segment separator. More...

Protected Member Functions inherited from setWriter
virtual void	writeValueSeparator (Ostream &os) const
	Write a value separator. More...

virtual void	writeCoordSeparator (Ostream &os) const
	Write a coordinate separator. More...

const List< string > &	delimiters () const
	Possible delimiters that need quoting. More...

Ostream &	writeWord (const word &w, Ostream &os, const bool align=false, const unsigned long alignPad=0) const
	Write a word. More...

template<class Type >
Ostream &	writeValue (const Type &value, Ostream &os, const bool align=false) const
	Write a value. More...

void	writeTableHeader (const coordSet &set, const wordList &valueSetNames, #define TypeValueSetsConstArg(Type, nullArg) Ostream &os, const bool align=false, const unsigned long alignPad=0) const
	Write multi-column table header. More...

void	writeTable (const coordSet &set, #define TypeValueSetsConstArg(Type, nullArg) Ostream &os, const bool align=false) const
	Write multi-column table of data. More...

Additional Inherited Members
Static Public Member Functions inherited from setWriter
template<class Types , class Type >
static void	appendTypeValueSet (UPtrList< const Field< Types >> &valueSets, const Field< Type > &valueSet)
	Helper for variadic write. More...

template<class Type >
static void	appendTypeValueSet (UPtrList< const Field< Type >> &valueSets, const Field< Type > &valueSet)
	Helper for variadic write. More...

static void	unpackTypeValueSets (wordList &valueSetNames #define TypeValueSetsNonConstArg(Type, nullArg))
	Helper for variadic write. More...

template<class Type , class ... Args>
static void	unpackTypeValueSets (wordList &valueSetNames #define TypeValueSetsNonConstArg(Type, nullArg) FOR_ALL_FIELD_TYPES(TypeValueSetsNonConstArg), const word &valueSetName, const Field< Type > &valueSet, Args &... args)
	Helper for variadic write. More...

template<class Type , class ... Args>
static void	unpackTypeValueSets (wordList &valueSetNames #define TypeValueSetsNonConstArg(Type, nullArg) FOR_ALL_FIELD_TYPES(TypeValueSetsNonConstArg), const wordList &valueSetNamesPart, const UPtrList< const Field< Type >> &valueSetsPart, Args &... args)
	Helper for variadic write. More...

template<class Type , class ... Args>
static void	unpackTypeValueSets (wordList &valueSetNames #define TypeValueSetsNonConstArg(Type, nullArg) FOR_ALL_FIELD_TYPES(TypeValueSetsNonConstArg), const wordList &valueSetNamesPart, const PtrList< Field< Type >> &valueSetsPart, Args &... args)
	Helper for variadic write. More...

static autoPtr< setWriter >	New (const word &writeType, const IOstream::streamFormat writeFormat=IOstream::ASCII, const IOstream::compressionType writeCompression=IOstream::UNCOMPRESSED)
	Select given write options. More...

static autoPtr< setWriter >	New (const word &writeType, const dictionary &dict)
	Select given a dictionary. More...

Static Protected Member Functions inherited from setWriter
static unsigned long	columnWidth (Ostream &os)
	Width of columns in tabulated output. More...

Protected Attributes inherited from setWriter
IOstream::streamFormat	writeFormat_
	Write format. More...

IOstream::compressionType	writeCompression_
	Write compression. More...

autoPtr< List< string > >	delimiters_
	Possible delimiters that need quoting. Constructed on demand from. More...

Detailed Description

Write set in raw tabulated format.

Source files

Definition at line 48 of file rawSetWriter.H.

Constructor & Destructor Documentation

◆ rawSetWriter() [1/3]

rawSetWriter	(	const IOstream::streamFormat	writeFormat,
		const IOstream::compressionType	writeCompression
	)

Construct given write options.

Definition at line 56 of file rawSetWriter.C.

Referenced by rawSetWriter::clone().

Here is the caller graph for this function:

◆ rawSetWriter() [2/3]

rawSetWriter ( const dictionary & dict )

Construct from dictionary.

Definition at line 67 of file rawSetWriter.C.

◆ rawSetWriter() [3/3]

rawSetWriter ( const rawSetWriter & writer )

Construct copy.

Definition at line 74 of file rawSetWriter.C.

◆ ~rawSetWriter()

~rawSetWriter ( )

virtual

Destructor.

Definition at line 83 of file rawSetWriter.C.

Member Function Documentation

◆ writeSegmentSeparator()

void writeSegmentSeparator ( Ostream & os ) const

protectedvirtual

Write a segment separator.

Reimplemented from setWriter.

Definition at line 45 of file rawSetWriter.C.

References Foam::nl.

◆ TypeName()

TypeName ( "raw" )

Runtime type information.

◆ clone()

virtual autoPtr<setWriter> clone ( ) const

inlinevirtual

Construct and return a clone.

Implements setWriter.

Definition at line 90 of file rawSetWriter.H.

References rawSetWriter::rawSetWriter().

Here is the call graph for this function:

◆ write() [1/4]

void write	(	const fileName &	outputDir,
		const fileName &	setName,
		const coordSet &	set,
		const wordList &valueSetNames #define	TypeValueSetsConstArgType, nullArg
	)		const

virtual

Write a coordSet and associated data.

Implements setWriter.

Definition at line 89 of file rawSetWriter.C.

References IOstream::ASCII, IOstream::currentVersion, Foam::FOR_ALL_FIELD_TYPES(), Foam::identityMap(), Foam::isDir(), Foam::mkDir(), Foam::nl, coordSet::segments(), coordSet::size(), OStringStream::str(), and TypeValueSetsParameter.

Referenced by rawSurfaceWriter::write().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ write() [2/4]

virtual void write

Inherit base class write methods.

◆ write() [3/4]

virtual void write

inline

Inherit base class write methods.

Definition at line 369 of file setWriter.H.

◆ write() [4/4]

void write ( class ... Args )

inline

Inherit base class write methods.

Definition at line 413 of file setWriter.H.

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

src/sampling/sampledSet/writers/raw/rawSetWriter.H
src/sampling/sampledSet/writers/raw/rawSetWriter.C

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ rawSetWriter() [1/3]

◆ rawSetWriter() [2/3]

◆ rawSetWriter() [3/3]

◆ ~rawSetWriter()

Member Function Documentation

◆ writeSegmentSeparator()

◆ TypeName()

◆ clone()

◆ write() [1/4]

◆ write() [2/4]

◆ write() [3/4]

◆ write() [4/4]