#include <fileoutput.h>

Inheritance diagram for FileOutput< TokenType, StorageType >:

Public Member Functions
	FileOutput ()

	~FileOutput ()

void	declareParameters ()

void	configure ()

void	createOutputStream ()

AlgorithmStatus	process ()

void	write (const TokenType &value)

Public Member Functions inherited from Algorithm
	Algorithm ()

virtual	~Algorithm ()

SinkBase &	input (const std::string &name)

SourceBase &	output (const std::string &name)

SinkBase &	input (int idx)

SourceBase &	output (int idx)

const InputMap &	inputs () const

const OutputMap &	outputs () const

std::vector< std::string >	inputNames () const

std::vector< std::string >	outputNames () const

virtual void	shouldStop (bool stop)

virtual bool	shouldStop () const

void	disconnectAll ()

AlgorithmStatus	acquireData ()

void	releaseData ()

virtual void	reset ()

Public Member Functions inherited from Configurable
virtual	~Configurable ()

const std::string &	name () const

void	setName (const std::string &name)

virtual void	setParameters (const ParameterMap &params)

virtual void	configure (const ParameterMap &params)

const ParameterMap &	defaultParameters () const

const Parameter &	parameter (const std::string &key) const

Protected Attributes
Sink< TokenType >	_data

std::ostream *	_stream

std::string	_filename

bool	_binary

Protected Attributes inherited from Algorithm
bool	_shouldStop

OutputMap	_outputs

InputMap	_inputs

int	nProcess

Protected Attributes inherited from Configurable
std::string	_name

ParameterMap	_params

ParameterMap	_defaultParams

Additional Inherited Members
Public Types inherited from Algorithm
typedef OrderedMap< SinkBase >	InputMap

typedef OrderedMap< SourceBase >	OutputMap

Public Attributes inherited from Algorithm
DescriptionMap	inputDescription

DescriptionMap	outputDescription

Public Attributes inherited from Configurable
DescriptionMap	parameterDescription

DescriptionMap	parameterRange

Static Public Attributes inherited from Algorithm
static const std::string	processingMode

Protected Member Functions inherited from Algorithm
void	declareInput (SinkBase &sink, const std::string &name, const std::string &desc)

void	declareInput (SinkBase &sink, int n, const std::string &name, const std::string &desc)

void	declareInput (SinkBase &sink, int acquireSize, int releaseSize, const std::string &name, const std::string &desc)

void	declareOutput (SourceBase &source, const std::string &name, const std::string &desc)

void	declareOutput (SourceBase &source, int n, const std::string &name, const std::string &desc)

void	declareOutput (SourceBase &source, int acquireSize, int releaseSize, const std::string &name, const std::string &desc)

Protected Member Functions inherited from Configurable
void	declareParameter (const std::string &name, const std::string &desc, const std::string &range, const Parameter &defaultValue)

Constructor & Destructor Documentation

◆ FileOutput()

FileOutput ( )

inline

References FileOutput< TokenType, StorageType >::_data, Algorithm::declareInput(), FileOutput< TokenType, StorageType >::declareParameters(), and Configurable::setName().

◆ ~FileOutput()

~FileOutput ( )

inline

References FileOutput< TokenType, StorageType >::_stream.

Member Function Documentation

◆ configure()

void configure ( )

inlinevirtual

This function will be automatically called after some parameters have been set. This is the place where you should write your specific code which needs to be called when configuring this object.

You can access the newly set parameters using the parameter() method.

Reimplemented from Configurable.

References FileOutput< TokenType, StorageType >::_binary, FileOutput< TokenType, StorageType >::_filename, Configurable::parameter(), and Parameter::toString().

◆ createOutputStream()

void createOutputStream ( )

inline

References FileOutput< TokenType, StorageType >::_binary, FileOutput< TokenType, StorageType >::_filename, and FileOutput< TokenType, StorageType >::_stream.

Referenced by FileOutput< TokenType, StorageType >::process().

◆ declareParameters()

void declareParameters ( )

inlinevirtual

Declare the parameters that this Configurable can accept. You have to implement this method in derived classes, even though you don't need any parameters. In that case, just define it as empty.

In this method you should only be calling the declareParameter method, once for each parameter, with optional default values.

Implements Configurable.

References Configurable::declareParameter().

Referenced by FileOutput< TokenType, StorageType >::FileOutput().