casa  $Rev:20696$
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Public Member Functions | Private Attributes
VLATimeFilter Class Reference

#include <VLATimeFilter.h>

Inheritance diagram for VLATimeFilter:
VLAFilter

List of all members.

Public Member Functions

 VLATimeFilter ()
 The default constructor creats a filter that does not filter anything.
 VLATimeFilter (const MVEpoch &startTime, const MVEpoch &stopTime)
 Creates a filter that filters all records except those with a observation time that is between the specified start and end times.
 VLATimeFilter (const VLATimeFilter &other)
 The copy constructor uses copy semantics.
virtual ~VLATimeFilter ()
 The destructor is trivial.
VLATimeFilteroperator= (const VLATimeFilter &other)
 The assignment operator uses copy semantics.
void startTime (const MVEpoch &startTime)
 Reset the start time.
void stopTime (const MVEpoch &startTime)
 Reset the stop time.
virtual 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.
virtual VLAFilterclone () const
 Return a pointer to a copy of the VLATimeFilter 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

MVEpoch itsStart
MVEpoch itsStop

Detailed Description

Intended use:

Public interface

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

Prerequisite

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

Definition at line 83 of file VLATimeFilter.h.


Constructor & Destructor Documentation

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

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

VLATimeFilter::VLATimeFilter ( const MVEpoch &  startTime,
const 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.

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

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

The assignment operator uses copy semantics.

virtual 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 MVEpoch &  startTime)

Reset the start time.

void VLATimeFilter::stopTime ( const MVEpoch &  startTime)

Reset the stop time.


Member Data Documentation

MVEpoch VLATimeFilter::itsStart [private]

Definition at line 126 of file VLATimeFilter.h.

MVEpoch VLATimeFilter::itsStop [private]

Definition at line 127 of file VLATimeFilter.h.


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