Controls a series of reporting modules that are run after all of the file-specific analysis modules are run. More...

#include <TskReportPipeline.h>

Inheritance diagram for TskReportPipeline:

Public Member Functions
virtual TskPluginModule *	createPluginModule ()
	Create a module for the given pipeline type. More...

virtual void	run (const uint64_t fileId)
	Run a file analysis pipeline on a file with the given ID. More...

virtual void	run (TskFile *file)
	Run a file analysis pipeline on the given file object. More...

virtual void	run ()
	Run a reporting / post-analysis pipeline. More...

Public Member Functions inherited from TskPipeline
void	initialize (const std::string &pipelineConfig)
	Parses the XML config file. More...

bool	isEmpty () const

void	logModuleExecutionTimes () const
	Logs the recorded execution times of the modules in the pipeline.

	TskPipeline ()
	Default constructor.

void	validate (const std::string &pipelineConfig)
	Validate a Pipeline based on the given XML configuration string. More...

	~TskPipeline ()
	Destructor.

Additional Inherited Members
Static Public Attributes inherited from TskPipeline
static const std::string	MODULE_ARGS_ATTR = "arguments"
	attribute for module arguments in XML config file

static const std::string	MODULE_ELEMENT = "MODULE"
	module element in XML config file

static const std::string	MODULE_EXECUTABLE_TYPE = "executable"
	value of MODULE_TYPE_ATTR for executable modules

static const std::string	MODULE_LOCATION_ATTR = "location"
	attribute for module location in XML config file

static const std::string	MODULE_ORDER_ATTR = "order"
	attribute for module order in XML config file

static const std::string	MODULE_OUTPUT_ATTR = "output"
	attribute for module output in XML config file

static const std::string	MODULE_PLUGIN_TYPE = "plugin"
	value of MODULE_TYPE_ATTR for library modules

static const std::string	MODULE_TYPE_ATTR = "type"
	attribute for module type in XML config file

Protected Member Functions inherited from TskPipeline
bool	excludeFile (const TskFile *)
	Determine whether a particular file should be processed. More...

void	updateModuleExecutionTime (int moduleId, const Poco::Timespan::TimeDiff &executionTime)
	Updates the recorded execution time of a module in the pipeline. More...

Protected Attributes inherited from TskPipeline
bool	m_hasExeModule
	True if any module is an executable module.

std::vector< TskModule * >	m_modules
	Collection of modules in the pipeline.

Detailed Description

Controls a series of reporting modules that are run after all of the file-specific analysis modules are run.

The reporting pipeline can contain one or more TskModule modules.

Member Function Documentation

virtual TskPluginModule* TskReportPipeline::createPluginModule ( )

inlinevirtual

Create a module for the given pipeline type.

Implements TskPipeline.

virtual void TskReportPipeline::run ( const uint64_t fileId)

inlinevirtual

Run a file analysis pipeline on a file with the given ID.

Parameters

fileId Id of file to run pipeilne on.

Exceptions

exceptions on errors

Implements TskPipeline.

virtual void TskReportPipeline::run ( TskFile * file)

inlinevirtual

Run a file analysis pipeline on the given file object.

Parameters

file	TskFile object to run pipeilne on.

Exceptions

exceptions on errors

Implements TskPipeline.

void TskReportPipeline::run ( )

virtual

Run a reporting / post-analysis pipeline.

Exceptions

exceptions on errors

Implements TskPipeline.

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