VLASourceFilter.h

Classes

VLASourceFilter -- (full description)

class VLASourceFilter: public VLAFilter

Interface

Public Members
VLASourceFilter()
VLASourceFilter(const String& sourceName, const Int sourceQual=INT_MIN)
VLASourceFilter(const VLASourceFilter& other)
virtual ~VLASourceFilter()
VLASourceFilter& operator=(const VLASourceFilter& other)
virtual Bool passThru(const VLALogicalRecord& record) const
virtual VLAFilter* clone() const
virtual Bool ok() const

Description

Review Status

Date Reviewed:
yyyy/mm/dd

Prerequisite

Etymology

Synopsis

Example

Motivation

Template Type Argument Requirements (T)

Thrown Exceptions

To Do

Member Description

VLASourceFilter()

The default constructor creats a filter that does not filter anything. ie., the passThru() function always returns True;

VLASourceFilter(const String& sourceName, const Int sourceQual=INT_MIN)

Creates a filter that filters all records except those with a source name that matches (case insensitive) the specified source name. If a qualifier is specified (and is not the magic value of INT_MIN), then the qualifier also has to match.

VLASourceFilter(const VLASourceFilter& other)

The copy constructor uses copy semantics.

virtual ~VLASourceFilter()

The destructor is trivial

VLASourceFilter& operator=(const VLASourceFilter& other)

The assignment operator uses copy semantics.

virtual Bool passThru(const VLALogicalRecord& record) const

returns True if the supplied record has an observing id that matches (case insensitive) the source name specified in the constructor.

virtual VLAFilter* clone() const

Return a pointer to a copy of the VLASourceFilter object upcast to a VLAFilter object. The class that uses this function is responsible for deleting the pointer. This is used to implement a virtual copy constructor.

virtual Bool ok() const

Function which checks the internal data of this class for correct dimensionality and consistant values. Returns True if everything is fine otherwise returns False.