casa  $Rev:20696$
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Public Member Functions | Private Attributes
VLASourceFilter Class Reference

#include <VLASourceFilter.h>

Inheritance diagram for VLASourceFilter:
VLAFilter

List of all members.

Public Member Functions

 VLASourceFilter ()
 The default constructor creats a filter that does not filter anything.
 VLASourceFilter (const String &sourceName, const Int sourceQual=INT_MIN, const Bool keepblanks=False)
 Creates a filter that filters all records except those with a source name that matches (case insensitive) the specified source name.
 VLASourceFilter (const VLASourceFilter &other)
 The copy constructor uses copy semantics.
virtual ~VLASourceFilter ()
 The destructor is trivial.
VLASourceFilteroperator= (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 VLAFilterclone () const
 Return a pointer to a copy of the VLASourceFilter object upcast to a VLAFilter object.
virtual Bool ok () const
 Function which checks the internal data of this class for correct dimensionality and consistant values.

Private Attributes

String itsSource
Int itsQual
Bool itsKeepBlanks

Detailed Description

Intended use:

Public interface

 <h3>Review Status</h3><dl><dt>Date Reviewed:<dd>yyyy/mm/dd</dl> 

Prerequisite

Etymology

Synopsis

Example

Motivation

Template Type Argument Requirements (T)

Thrown Exceptions

To Do

Definition at line 82 of file VLASourceFilter.h.


Constructor & Destructor Documentation

The default constructor creats a filter that does not filter anything.

ie., the passThru() function always returns True;

VLASourceFilter::VLASourceFilter ( const String sourceName,
const Int  sourceQual = INT_MIN,
const Bool  keepblanks = False 
)

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.

The copy constructor uses copy semantics.

virtual VLASourceFilter::~VLASourceFilter ( ) [virtual]

The destructor is trivial.


Member Function Documentation

virtual VLAFilter* VLASourceFilter::clone ( ) const [virtual]

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.

Implements VLAFilter.

virtual Bool VLASourceFilter::ok ( ) const [virtual]

Function which checks the internal data of this class for correct dimensionality and consistant values.

Returns True if everything is fine otherwise returns False.

Reimplemented from VLAFilter.

VLASourceFilter& VLASourceFilter::operator= ( const VLASourceFilter other)

The assignment operator uses copy semantics.

virtual Bool VLASourceFilter::passThru ( const VLALogicalRecord record) const [virtual]

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

Implements VLAFilter.


Member Data Documentation

Definition at line 122 of file VLASourceFilter.h.

Int VLASourceFilter::itsQual [private]

Definition at line 121 of file VLASourceFilter.h.

Definition at line 120 of file VLASourceFilter.h.


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