VLATimeFilter Class Reference

#include <VLATimeFilter.h>

Inheritance diagram for VLATimeFilter:

Public Member Functions
	VLATimeFilter ()
	The default constructor creats a filter that does not filter anything. More...
	VLATimeFilter (const casacore::MVEpoch &startTime, const casacore::MVEpoch &stopTime)
	Creates a filter that filters all records except those with a observation time that is between the specified start and end times. More...
	VLATimeFilter (const VLATimeFilter &other)
	The copy constructor uses copy semantics. More...
virtual	~VLATimeFilter ()
	The destructor is trivial. More...
VLATimeFilter &	operator= (const VLATimeFilter &other)
	The assignment operator uses copy semantics. More...
void	startTime (const casacore::MVEpoch &startTime)
	Reset the start time. More...
void	stopTime (const casacore::MVEpoch &startTime)
	Reset the stop time. More...
virtual casacore::Bool	passThru (const VLALogicalRecord &record) const
	returns true if the supplied record has an observation time that is between the specified start and end times. More...
virtual VLAFilter *	clone () const
	Return a pointer to a copy of the VLATimeFilter 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::MVEpoch	itsStart
casacore::MVEpoch	itsStop

Detailed Description

Intended use:

Public interface

Review Status

Date Reviewed:

yyyy/mm/dd

Prerequisite

• SomeClass
• SomeOtherClass
• some concept

Etymology

Synopsis

Note the start and stop times are the values at the center if the integration.

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 83 of file VLATimeFilter.h.

Constructor & Destructor Documentation

VLATimeFilter::VLATimeFilter

(

)

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

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

VLATimeFilter::VLATimeFilter	(	const casacore::MVEpoch &	startTime,
		const casacore::MVEpoch &	stopTime
	)

Creates a filter that filters all records except those with a observation time that is between the specified start and end times.

The reference frame is always assumed to be TAI.

VLATimeFilter::VLATimeFilter

(

const VLATimeFilter &

other

)

The copy constructor uses copy semantics.

virtual VLATimeFilter::~VLATimeFilter ( )

virtual

The destructor is trivial.

Member Function Documentation

virtual VLAFilter* VLATimeFilter::clone ( ) const

virtual

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

VLATimeFilter& VLATimeFilter::operator=

(

const VLATimeFilter &

other

)

The assignment operator uses copy semantics.

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

virtual

returns true if the supplied record has an observation time that is between the specified start and end times.

Implements VLAFilter.

void VLATimeFilter::startTime

(

const casacore::MVEpoch &

startTime

)

Reset the start time.

void VLATimeFilter::stopTime

(

const casacore::MVEpoch &

startTime

)

Reset the stop time.

Member Data Documentation

casacore::MVEpoch VLATimeFilter::itsStart

private

Definition at line 126 of file VLATimeFilter.h.

casacore::MVEpoch VLATimeFilter::itsStop

private

Definition at line 127 of file VLATimeFilter.h.

---

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

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