VLASubarrayFilter Class Reference

#include <VLASubarrayFilter.h>

Inheritance diagram for VLASubarrayFilter:

Public Member Functions
	VLASubarrayFilter ()
	The default constructor creats a filter that does not filter anything. More...
	VLASubarrayFilter (const casacore::uInt subArray)
	Creates a filter that filters all records except those with a subarray number that matches the specified value. More...
	VLASubarrayFilter (const VLASubarrayFilter &other)
	The copy constructor uses copy semantics. More...
virtual	~VLASubarrayFilter ()
	The destructor is trivial. More...
VLASubarrayFilter &	operator= (const VLASubarrayFilter &other)
	The assignment operator uses copy semantics. More...
virtual casacore::Bool	passThru (const VLALogicalRecord &record) const
	returns true if the supplied record has an subarray id that matches the subarray id specified in the constructor. More...
virtual VLAFilter *	clone () const
	Return a pointer to a copy of the VLASubarrayFilter 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::uInt	itsArray

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 80 of file VLASubarrayFilter.h.

Constructor & Destructor Documentation

VLASubarrayFilter::VLASubarrayFilter

(

)

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

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

VLASubarrayFilter::VLASubarrayFilter

(

const casacore::uInt

subArray

)

Creates a filter that filters all records except those with a subarray number that matches the specified value.

The specified value must be less than 28 otherwise an exception is thrown (in Debug Mode)

VLASubarrayFilter::VLASubarrayFilter

(

const VLASubarrayFilter &

other

)

The copy constructor uses copy semantics.

virtual VLASubarrayFilter::~VLASubarrayFilter ( )

virtual

The destructor is trivial.

Member Function Documentation

virtual VLAFilter* VLASubarrayFilter::clone ( ) const

virtual

Return a pointer to a copy of the VLASubarrayFilter 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 VLASubarrayFilter::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.

VLASubarrayFilter& VLASubarrayFilter::operator=

(

const VLASubarrayFilter &

other

)

The assignment operator uses copy semantics.

virtual casacore::Bool VLASubarrayFilter::passThru ( const VLALogicalRecord &  record ) const

virtual

returns true if the supplied record has an subarray id that matches the subarray id specified in the constructor.

Implements VLAFilter.

Member Data Documentation

casacore::uInt VLASubarrayFilter::itsArray

private

Definition at line 117 of file VLASubarrayFilter.h.

---

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

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