class Pipe : public FilterBase

Pipe API

Inheritance:

Public Methods

virtual ~Pipe()

Filter destructor

virtual TSeries operator)(const TSeries& in)

The basic processing method.

FilterIO& operator)(const FilterIO& in)

The basic processing method.

virtual TSeries apply(const TSeries& in)

The basic processing method.

FilterIO& apply(const FilterIO& in)

The basic processing method.

virtual void dataCheck(const TSeries& in) const

Validate filter input.

void dataCheck(const FilterIO& in) const

Validate filter input.

virtual bool isDataValid(const TSeries& in) const

Validate filter input without throwing exceptions.

virtual void reset(void)

Reset the filter history.

virtual bool inUse(void) const

Tes if the filter is being used.

KeyChain& getInputKeys(void) const

Return a KeyChain with Keys for input TSeries. Currently unimplemented.

KeyChain& getOutputKeys(void) const

Return a KeyChain with Keys for output TSeries. Currently unimplemented.

virtual Time getStartTime(void) const

Start time.

virtual Time getCurrentTime(void) const

Start time.

Inherited from FilterBase:

Public Methods

virtual bool rootGetStartTime(Time& t) const throw()

virtual bool rootGetCurrentTime(Time& t) const throw()

virtual ~Pipe()

Filter destructor

virtual TSeries operator)(const TSeries& in)

Process the input, returning result in an output container. Synonym for apply() method.

Parameters:

in - TSeries being acted on.

FilterIO& operator)(const FilterIO& in)

Process the input, returning result in an output container. Synonym for apply() method.

Parameters:

in - TSeries being acted on.

virtual TSeries apply(const TSeries& in)

Process the input returning the output in an output container. Synonymous with operator() method.

Parameters:

in - The TSeries being acted on.

FilterIO& apply(const FilterIO& in)

Process the input returning the output in an output container. Synonymous with operator() method.

Parameters:

in - The TSeries being acted on.

virtual void dataCheck(const TSeries& in) const

Validate filter input. The input container is checked for completeness, continuity, consistency and other criteria specific to a given instance. Throws an appropriate exception on invalid input. For an exception-less version, see isDataValid().

Parameters:

in - TSeries to validate

void dataCheck(const FilterIO& in) const

Validate filter input. The input container is checked for completeness, continuity, consistency and other criteria specific to a given instance. Throws an appropriate exception on invalid input. For an exception-less version, see isDataValid().

Parameters:

in - TSeries to validate

virtual bool isDataValid(const TSeries& in) const

Validate filter input without throwing exceptions. The input container is checked for completeness, continuity, consistency and other criteria specific to a given instance. Does not throw an exception, so safe for use in root.

Parameters:

in - TSeries to validate

virtual void reset(void)

Reset the filter history.

virtual bool inUse(void) const

Test whether the filter is being used. A filter is defined as being in use if the filter has been applied to one or more time series since the filter was constructed or reset. The filter state generally reflects the application of the filters but need not.

Returns:

true if the filter is in use.

KeyChain& getInputKeys(void) const

Return a KeyChain for input TSeries. Use these keys to fill a FilterIO container with TSeries, optionally validates the container and contents with dataCheck(), and act on the input with apply().

KeyChain& getOutputKeys(void) const

Return a KeyChain for output TSeries. Use the keys on this chain to retrieve output TSeries from output FilterIO container.

virtual Time getStartTime(void) const

Get the time of the first sample processed after the most recent reset.

virtual Time getCurrentTime(void) const

Get the time of the expected next sample to be processed.

Direct child classes:

Window
Mixer
LineFilter
IIRFilter
FIRFilter
DecimateBy2

Author:

Lee Samuel Finn <LSF5@PSU.Edu>

Version:

alphabetic index hierarchy of classes

generated by doc++