Generates boilerplate header and source files for a new IOFactory subclass, enabling file format read/write support in the NDEVR IO system. More...

Collaboration diagram for IOFactoryBuilder:

[legend]

Public Member Functions
String	className () const
	Returns the computed class name for the factory.
bool	createFactory () const
	Generates all factory files (header and source).
void	createModuleHeader (File &file) const
	Creates the factory header file on disk.
void	createModuleSource (File &file) const
	Creates the factory source file on disk.
String	headerPath () const
	Returns the relative header path for the factory class.
String	ioFactoryHeaderString () const
	Generates the IOFactory header file content as a string.
String	ioFactorySourceString () const
	Generates the IOFactory source file content as a string.

Public Attributes
BoilerMaker	boiler_maker
	Boilerplate template generator.
String	class_name
	The derived class name (computed lazily).
String	factory_name
	The human-readable factory name.
LogPtr	log
	Log for status messages.
bool	override = false
	Whether to overwrite existing files.
String	project_name
	The module project that owns the factory.
File	source_directory
	The directory where generated source files are placed.

Detailed Description

Generates boilerplate header and source files for a new IOFactory subclass, enabling file format read/write support in the NDEVR IO system.

Definition at line 10 of file IOFactoryBuilder.h.

Member Function Documentation

◆ className()

String IOFactoryBuilder::className ( ) const

Returns the computed class name for the factory.

Returns: The class name string.

◆ createFactory()

bool IOFactoryBuilder::createFactory ( ) const

Generates all factory files (header and source).

Returns: True on success.

◆ createModuleHeader()

void IOFactoryBuilder::createModuleHeader ( File & file ) const

Creates the factory header file on disk.

Parameters

[in] file The output file to write to.

◆ createModuleSource()

void IOFactoryBuilder::createModuleSource ( File & file ) const

Creates the factory source file on disk.

Parameters

[in] file The output file to write to.

◆ headerPath()

String IOFactoryBuilder::headerPath ( ) const

Returns the relative header path for the factory class.

Returns: The header file path string.

◆ ioFactoryHeaderString()

String IOFactoryBuilder::ioFactoryHeaderString ( ) const

Generates the IOFactory header file content as a string.

Returns: The header source code.

◆ ioFactorySourceString()

String IOFactoryBuilder::ioFactorySourceString ( ) const

Generates the IOFactory source file content as a string.

Returns: The source code.

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

Developer/Headers/IOFactoryBuilder.h

Public Member Functions

Public Attributes