casa  5.7.0-16
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Private Member Functions | Private Attributes | List of all members
VLAFilterSet Class Reference

#include <VLAFilterSet.h>

Public Member Functions

 VLAFilterSet ()
 The default constructor creates a filter set that does not contan any filters. More...
 
 VLAFilterSet (const VLAFilterSet &other)
 The copy constructor uses copy semantics. More...
 
virtual ~VLAFilterSet ()
 The destructor is trivial. More...
 
VLAFilterSetoperator= (const VLAFilterSet &other)
 The assignment operator uses copy semantics. More...
 
void addFilter (const VLAFilter &filter)
 Adds the specified filter to the set. More...
 
void removeFilter (const casacore::uInt which)
 Adds the specified filter from the set. More...
 
casacore::uInt nelements () const
 Returns the number of filters in the set. More...
 
const VLAFilterfilter (const casacore::uInt which) const
 Returns a reference to the specified filter. More...
 
virtual casacore::Bool passThru (const VLALogicalRecord &record) const
 returns true if the supplied record meets the filter criteria for all the filters that are contained within in this filter set. More...
 
virtual casacore::Bool ok () const
 casacore::Function which checks the internal data of this class for correct dimensionality and consistant values. More...
 

Private Member Functions

void deleteAllFilters ()
 
void copyFilters (const VLAFilterSet &other)
 

Private Attributes

casacore::PtrBlock< VLAFilter * > itsFilters
 

Detailed Description

Intended use:

Public interface

Review Status

Date Reviewed:
yyyy/mm/dd

Prerequisite

Etymology

Synopsis

Example

Motivation

Template Type Argument Requirements (T)

Thrown Exceptions

To Do

Definition at line 80 of file VLAFilterSet.h.

Constructor & Destructor Documentation

VLAFilterSet::VLAFilterSet ( )

The default constructor creates a filter set that does not contan any filters.

Using the passThru function without any filters always returns true;

VLAFilterSet::VLAFilterSet ( const VLAFilterSet other)

The copy constructor uses copy semantics.

virtual VLAFilterSet::~VLAFilterSet ( )
virtual

The destructor is trivial.

Member Function Documentation

void VLAFilterSet::addFilter ( const VLAFilter filter)

Adds the specified filter to the set.

void VLAFilterSet::copyFilters ( const VLAFilterSet other)
private
void VLAFilterSet::deleteAllFilters ( )
private
const VLAFilter& VLAFilterSet::filter ( const casacore::uInt  which) const

Returns a reference to the specified filter.

casacore::uInt VLAFilterSet::nelements ( ) const
inline

Returns the number of filters in the set.

Definition at line 129 of file VLAFilterSet.h.

References itsFilters, and casacore::PtrBlock< T >::nelements().

virtual casacore::Bool VLAFilterSet::ok ( ) const
virtual

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

Returns true if everything is fine otherwise returns false.

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

The assignment operator uses copy semantics.

virtual casacore::Bool VLAFilterSet::passThru ( const VLALogicalRecord record) const
virtual

returns true if the supplied record meets the filter criteria for all the filters that are contained within in this filter set.

Also returns true if there are no filters in the set.

void VLAFilterSet::removeFilter ( const casacore::uInt  which)

Adds the specified filter from the set.

Throws an exception if which is not less than the value returned by nelements().

Member Data Documentation

casacore::PtrBlock<VLAFilter*> VLAFilterSet::itsFilters
private

Definition at line 126 of file VLAFilterSet.h.

Referenced by nelements().


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