MetriVis Overview | Download | User Manual | Development
Reference Overview | Design Documentation | Reference Backend | Reference Frontend

metrivis::PipelineProcess Class Reference

Represents a single process in the processing pipeline. More...

#include <PipelineProcess.h>

Inheritance diagram for metrivis::PipelineProcess:

metrivis::SearchFetcher metrivis::SQL2JsonConverter metrivis::SQL2JsonFetcher metrivis::TimeLineFetcher metrivis::TimeLineVisualizer metrivis::XYPlotFetcher metrivis::XYPlotFilter metrivis::XYPlotVisualizer

Public Member Functions

 PipelineProcess ()
 Default constructor.
virtual ~PipelineProcess ()
 Deconstructor.
virtual void Execute ()=0
 Executes the PipelineProcess. Produces ouput data from input.
virtual void Reset ()
 Resets the pipeline process to it's original state.
void set_input_data (MultiTypePtr input_data)
 Assigns input data to this process.
const MultiTypePtr output_data () const
 Gets a handle to the output data.

Protected Attributes

MultiTypePtr input_data_
 Input data handle.
MultiTypePtr output_data_
 Output data handle.

Detailed Description

Represents a single process in the processing pipeline.

Constructor & Destructor Documentation

metrivis::PipelineProcess::PipelineProcess (  ) 

Default constructor.

Constructor.


Member Function Documentation

virtual void metrivis::PipelineProcess::Execute (  )  [pure virtual]

Executes the PipelineProcess. Produces ouput data from input.

Executes this process and evaluates this input data and creates output from it. Abstract function needs to be overloaded.

Implemented in metrivis::SearchFetcher, metrivis::SQL2JsonConverter, metrivis::SQL2JsonFetcher, metrivis::TimeLineFetcher, metrivis::TimeLineVisualizer, metrivis::XYPlotFetcher, metrivis::XYPlotFilter, and metrivis::XYPlotVisualizer.

void metrivis::PipelineProcess::Reset (  )  [virtual]

Resets the pipeline process to it's original state.

Frees resources. May take some time to execute, don't put it into speed critical sections. This is normally done after the execution of a pipeline. It automatically gets called from Pipeline::Reset.

See header file for more information.

Reimplemented in metrivis::SearchFetcher, metrivis::SQL2JsonFetcher, metrivis::TimeLineFetcher, metrivis::TimeLineVisualizer, metrivis::XYPlotFetcher, and metrivis::XYPlotVisualizer.

void metrivis::PipelineProcess::set_input_data ( MultiTypePtr  input_data  )  [inline]

Assigns input data to this process.

Parameters:
input_data,: The data to be processed in this process.
Input type needs to have a defined copy constructor.

const MultiTypePtr metrivis::PipelineProcess::output_data (  )  const [inline]

Gets a handle to the output data.

Returns:
Reference to the output data.


The documentation for this class was generated from the following files:
Generated on Fri Feb 29 16:47:20 2008 for MetriVis by  doxygen 1.5.3