class FilterBase

Filter API

Inheritance:

Public Methods

virtual	~FilterBase () Filter destructor
virtual FilterBase*	clone (void) const Clone the filter.
virtual FilterIO&	operator) (const FilterIO& in) The basic processing method.
virtual FilterIO&	apply (const FilterIO& in) The basic processing method.
virtual void	dataCheck (const FilterIO& in) const Validate filter input.
virtual void	reset (void) Reset the filter to a pristine state.
virtual KeyChain&	getInputKeys (void) const Return a KeyChain with Keys for input TSeries. Currently unimplemented.
virtual KeyChain&	getOutputKeys (void) const Return a KeyChain with Keys for output TSeries. Currently unimplemented.
virtual Time	getStartTime (void) const Get the moment of the first sample processed.
virtual bool	rootGetStartTime (Time& t) const throw() Get the moment of the first sample processed. Root-safe.
virtual Time	getCurrentTime (void) const Get the moment of the next expected sample.
virtual bool	rootGetCurrentTime (Time& t) const throw() Get the moment of the next expected sample. Root-safe.
virtual bool	isDataValid (const FilterIO& in) const Validate filter input without throwing exceptions.
virtual bool	inUse (void) const Returns true if filter is ``in use

virtual ~FilterBase()

Filter destructor

virtual FilterBase* clone(void) const

Create an identical filter and return a pointer.

Returns:

Pointer to the cloned filter.

virtual FilterIO& operator)(const FilterIO& in)

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

Parameters:

in - Container holding the TSeries being acted on.

virtual FilterIO& apply(const FilterIO& in)

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

Parameters:

in - Container holding the TSeries being acted on.

virtual 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. Assumed to throw only exceptions derived from standard c++ exception class. For an exception-less version, see isDataValid().

Parameters:

in - Container holding input to validate

virtual void reset(void)

Reset filter to a pristine state. Following application of this method object should be indistinguishable from a new instance generated from default constructor.

virtual 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().

virtual 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 moment of the first sample processed. Throws an exception if the filter has not yet been used. Assumed to throw only exceptions derived from standard c++ exception class. For a root-safe method see bool getStartTime().

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

Get the moment of the first sample processed. Returns false if filter has not yet been used. Root-safe.

Parameters:

t - start time if returned value is true.

virtual Time getCurrentTime(void) const

Get the moment of the next expected sample. Throws an exception if the filter has not yet been used. Assumed to throw only exceptions derived from standard c++ exception class. For a root-safe method see bool getCurrentTime().

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

Get the moment of the next expected sample. Returns false if the filter has not yet been used. Root-safe version of getCurrentTime()

virtual bool isDataValid(const FilterIO& 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 - Container holding the input to validate

virtual bool inUse(void) const

Returns true if filter is ``in use.'' A filter is ``in use'' if it has acted on input since it was created or last reset. Returns true if filter is ``in use.''

Direct child classes:

Pipe

Author:

Lee Samuel Finn <LSF5@PSU.Edu>

Version:

alphabetic index hierarchy of classes

Please send questions and comments to zweizig_j@ligo.caltech.edu

generated by doc++