AsciiFactory Class Reference

writes points of data to a plain-text file based on FactoryOptions. AsciiFactories allow for defining multiple columns of data to be streamed out to the text file. More...

#include <AsciiFactory.h>

Inheritance diagram for AsciiFactory:

Collaboration diagram for AsciiFactory:

Public Member Functions
	AsciiFactory ()
	AsciiFactory (const String &name)
bool	canRead (const FactoryParameters &file) override
FactoryOptions	defaultReadOptions (const FactoryParameters &file) const override
FactoryOptions	defaultWriteOptions (const FactoryParameters &file) const override
FactoryFeatures	factoryFeatures (const FactoryParameters &file, bool is_import) const override
Buffer< UUID >	filterModelsToExport (Buffer< UUID > models_to_check, const DesignObjectLookup *lookup, const FileFormat &export_format) const override
virtual String	getIcon (const File &file) override
virtual void	getSupportedFormats (Buffer< FileFormat > &formats, bool is_read) override
virtual void	getSupportedFormats (Buffer< FileFormat > &formats, DesignObjectLookup *lookup, const Buffer< UUID > &models) override
virtual void	getSupportedFormatsByModelType (Buffer< FileFormat > &formats, bool is_read, const String &model_type) override
virtual bool	isRecursiveWrite (const FactoryParameters &params) const
virtual bool	readFile (FactoryParameters &parameters) override
virtual bool	writeFile (FactoryParameters &parameters) override
virtual bool	writeToString (String &output, const FactoryParameters &parameters, uint04 max_line_count)
Public Member Functions inherited from IOFactory
virtual bool	canRead (const File &file)
virtual bool	canRead (const FileFormat &file)
virtual bool	canWrite (const FactoryParameters &file)
virtual bool	canWrite (const File &file)
virtual bool	canWrite (const FileFormat &file)
virtual bool	determineExtension (const File &file, String &extension)
String	factoryReadAppFeature () const
String	factoryWriteAppFeature () const
void	getSupportedFormats (Buffer< FileFormat > &formats)
virtual void	getSupportedFormats (Buffer< FileFormat > &formats, const File &file)
virtual void	getSupportedFormatsForExtension (Buffer< FileFormat > &formats, bool is_read, const String &extension)
	IOFactory (const String &factory_name)
virtual bool	isAutoEnabled () const
virtual bool	isFactoryEnabled (bool is_read) const
const String &	name () const
bool	readFileWithDefaultSettings (const File &file, DesignObjectLookup *lookup)
Buffer< Scene >	readScenesFromFile (const File &file)
void	throwIfNotEnabled (bool is_read)
virtual bool	updateFromFile (const FactoryParameters &file, const FactoryOptions &old_options)
bool	writeScenesToFile (const File &file, const Buffer< Scene > &scene)
virtual	~IOFactory ()

Static Public Member Functions
static DesignParameter	NoneParameter ()
static FileFormat	PointFormat ()
static ASCIIPointOptions	ReadPoints (FactoryParameters &parameters, Model &root, Buffer< DesignParameter > &params)
static void	WriteHeaders (const AsciiOptions &options, String &string, bool add_new_line=true)
Static Public Member Functions inherited from IOFactory
static void	EnableExtension (const String &extension, const String &read_password, const String &write_password)
static void	EnableFactory (const String &factory, const String &read_password, const String &write_password)
static void	EnableFactory (IOFactory *factory, const String &read_password, const String &write_password)

Detailed Description

writes points of data to a plain-text file based on FactoryOptions. AsciiFactories allow for defining multiple columns of data to be streamed out to the text file.

---

Constructor & Destructor Documentation

AsciiFactory() [1/2]

AsciiFactory

(

)

AsciiFactory() [2/2]

AsciiFactory

(

const String &

name

)

Member Function Documentation

canRead()

bool canRead ( const FactoryParameters & file )

overridevirtual

Reimplemented from IOFactory.

defaultReadOptions()

FactoryOptions defaultReadOptions ( const FactoryParameters & file ) const

overridevirtual

Reimplemented from IOFactory.

defaultWriteOptions()

FactoryOptions defaultWriteOptions ( const FactoryParameters & file ) const

overridevirtual

Reimplemented from IOFactory.

factoryFeatures()

FactoryFeatures factoryFeatures ( const FactoryParameters & file, bool is_import ) const

overridevirtual

Implements IOFactory.

filterModelsToExport()

Buffer< UUID > filterModelsToExport ( Buffer< UUID > models_to_check, const DesignObjectLookup * lookup, const FileFormat & export_format ) const

overridevirtual

Reimplemented from IOFactory.

getIcon()

virtual String getIcon ( const File & file )

overridevirtual

Reimplemented from IOFactory.

getSupportedFormats() [1/2]

virtual void getSupportedFormats ( Buffer< FileFormat > & formats, bool is_read )

overridevirtual

Implements IOFactory.

getSupportedFormats() [2/2]

virtual void getSupportedFormats ( Buffer< FileFormat > & formats, DesignObjectLookup * lookup, const Buffer< UUID > & models )

overridevirtual

Reimplemented from IOFactory.

getSupportedFormatsByModelType()

virtual void getSupportedFormatsByModelType ( Buffer< FileFormat > & formats, bool is_read, const String & model_type )

overridevirtual

Reimplemented from IOFactory.

isRecursiveWrite()

virtual bool isRecursiveWrite ( const FactoryParameters & params ) const

virtual

NoneParameter()

static DesignParameter NoneParameter ( )

static

PointFormat()

static FileFormat PointFormat ( )

static

readFile()

virtual bool readFile ( FactoryParameters & parameters )

overridevirtual

Implements IOFactory.

ReadPoints()

static ASCIIPointOptions ReadPoints ( FactoryParameters & parameters, Model & root, Buffer< DesignParameter > & params )

static

writeFile()

virtual bool writeFile ( FactoryParameters & parameters )

overridevirtual

Implements IOFactory.

WriteHeaders()

static void WriteHeaders ( const AsciiOptions & options, String & string, bool add_new_line = true )

static

writeToString()

virtual bool writeToString ( String & output, const FactoryParameters & parameters, uint04 max_line_count )

virtual

---

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

• IOFactory/Headers/AsciiFactory.h