Write set in csv format. More...

Inheritance diagram for csvSetWriter:

Collaboration diagram for csvSetWriter:

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

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

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

virtual	~csvSetWriter ()
	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...

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

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	writeValueSeparator (Ostream &os) const
	Write a value separator. More...

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

Protected Member Functions inherited from setWriter
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 csv format.

Source files

Definition at line 48 of file csvSetWriter.H.

Constructor & Destructor Documentation

◆ csvSetWriter() [1/2]

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

Construct given write options.

Definition at line 58 of file csvSetWriter.C.

Referenced by csvSetWriter::writeSegmentSeparator().

Here is the caller graph for this function:

◆ csvSetWriter() [2/2]

csvSetWriter ( const dictionary & dict )

Construct from dictionary.

Definition at line 68 of file csvSetWriter.C.

◆ ~csvSetWriter()

~csvSetWriter ( )

virtual

Destructor.

Definition at line 77 of file csvSetWriter.C.

References csvSetWriter::write().

Here is the call graph for this function:

Member Function Documentation

◆ writeValueSeparator()

void writeValueSeparator ( Ostream & os ) const

protectedvirtual

Write a value separator.

Reimplemented from setWriter.

Definition at line 45 of file csvSetWriter.C.

◆ writeSegmentSeparator()

void writeSegmentSeparator ( Ostream & os ) const

protectedvirtual

Write a segment separator.

Reimplemented from setWriter.

Definition at line 51 of file csvSetWriter.C.

References csvSetWriter::csvSetWriter().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "csv" )

Runtime type information.

◆ write()

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