VLASourceFilter Class Reference

#include <VLASourceFilter.h>

Inheritance diagram for VLASourceFilter:

Public Member Functions
	VLASourceFilter ()
	The default constructor creats a filter that does not filter anything. More...
	VLASourceFilter (const casacore::String &sourceName, const casacore::Int sourceQual=INT_MIN, const casacore::Bool keepblanks=false)
	Creates a filter that filters all records except those with a source name that matches (case insensitive) the specified source name. More...
	VLASourceFilter (const VLASourceFilter &other)
	The copy constructor uses copy semantics. More...
virtual	~VLASourceFilter ()
	The destructor is trivial. More...
VLASourceFilter &	operator= (const VLASourceFilter &other)
	The assignment operator uses copy semantics. More...
virtual casacore::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. More...
virtual VLAFilter *	clone () const
	Return a pointer to a copy of the VLASourceFilter object upcast to a VLAFilter object. More...
virtual casacore::Bool	ok () const
	casacore::Function which checks the internal data of this class for correct dimensionality and consistant values. More...
Public Member Functions inherited from VLAFilter
virtual	~VLAFilter ()
	A virtual destructor is necessary to ensure that the destructor of derived classes is used. More...

Private Attributes
casacore::String	itsSource
casacore::Int	itsQual
casacore::Bool	itsKeepBlanks

Detailed Description

Intended use:

Public interface

Review Status

Date Reviewed:

yyyy/mm/dd

Prerequisite

• SomeClass
• SomeOtherClass
• some concept

Etymology

Synopsis

Example

Motivation

Template Type Argument Requirements (T)

Thrown Exceptions

To Do

• add this feature
• fix this bug
• start discussion of this possible extension

Definition at line 82 of file VLASourceFilter.h.

Constructor & Destructor Documentation

VLASourceFilter::VLASourceFilter

(

)

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

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

VLASourceFilter::VLASourceFilter	(	const casacore::String &	sourceName,
		const casacore::Int	sourceQual = INT_MIN,
		const casacore::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.

VLASourceFilter::VLASourceFilter

(

const VLASourceFilter &

other

)

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 casacore::Bool VLASourceFilter::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.

Reimplemented from VLAFilter.

VLASourceFilter& VLASourceFilter::operator=

(

const VLASourceFilter &

other

)

The assignment operator uses copy semantics.

virtual casacore::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

casacore::Bool VLASourceFilter::itsKeepBlanks

private

Definition at line 122 of file VLASourceFilter.h.

casacore::Int VLASourceFilter::itsQual

private

Definition at line 121 of file VLASourceFilter.h.

casacore::String VLASourceFilter::itsSource

private

Definition at line 120 of file VLASourceFilter.h.

---

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

• casa/code/nrao/VLA/VLASourceFilter.h