#include <VLASubarrayFilter.h>

Inheritance diagram for VLASubarrayFilter:

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

Detailed Description

Intended use:

Public interface

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

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 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 Bool VLASubarrayFilter::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.

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

The assignment operator uses copy semantics.

virtual 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.