Pulsar::Database::Criteria Class Reference

Describes Database matching criteria. More...

#include <Database.h>

Inheritance diagram for Pulsar::Database::Criteria:

Public Member Functions
void	set_sequence (Sequence s)
	The sequence of matching calibrator and pulsar observations.
Sequence	get_sequence () const
	Criteria ()
	Default constructor.
void	no_data ()
	Called when no observation parameters are to be matched.
bool	match (const Entry *entry) const
	Return true if entry matches within the criteria.
Public Member Functions inherited from Reference::Able
	Able (const Able &)
Able &	operator= (const Able &)
unsigned	get_reference_count () const
Public Member Functions inherited from Reference::HeapTracked
	HeapTracked (const HeapTracked &)
HeapTracked &	operator= (const HeapTracked &)
bool	__is_on_heap () const

Public Attributes
Reference::To< StaticEntry >	entry
	The parameters to match.
double	minutes_apart
double	deg_apart
bool	check_receiver
bool	check_instrument
bool	check_frequency
bool	check_bandwidth
bool	check_obs_type
bool	check_time
bool	check_coordinates
bool	check_frequency_array

match results
These attributes are set by the match method
std::string	match_report
	log of the attributes compared and the result of the comparison
unsigned	match_count
	count of the number of match conditions that tested positive
double	diff_minutes
	time between calibrator and requested epoch (in minutes)
double	diff_degrees
	distance between calibrator and requested position (in degrees)
Sequence	sequence
	The sequence of matching calibrator and pulsar observations.
const Entry *	best (const Entry *a, const Entry *b) const
	Return the best of two entries.
static Criteria	closest (const Criteria &a, const Criteria &b)
	Return the criteria that came closest to matching.
template<typename T, typename U, typename Predicate>
void	compare (const std::string &name, const T &want, const U &have, Predicate equal) const
	log of the attributes compared and the result of the comparison
template<typename T>
void	compare (const std::string &name, const T &want, const T &have) const
	log of the attributes compared and the result of the comparison
bool	compare_times (const MJD &want, const MJD &have) const
	log of the attributes compared and the result of the comparison
bool	bracketed_time (const MJD &want, const std::pair< MJD, MJD > &have) const
	log of the attributes compared and the result of the comparison
bool	compare_coordinates (const sky_coord &want, const sky_coord &have) const
	log of the attributes compared and the result of the comparison

Additional Inherited Members
Static Public Member Functions inherited from Reference::Able
static size_t	get_instance_count ()
Static Public Member Functions inherited from Reference::HeapTracked
static void *	operator new (size_t size, void *ptr=0)
static void	operator delete (void *location, void *ptr)
static void	operator delete (void *location)
static size_t	get_heap_queue_size ()
Protected Member Functions inherited from Reference::Able
Handle *	__reference (bool active) const
void	__dereference (bool auto_delete=true) const

Detailed Description

Describes Database matching criteria.

Member Function Documentation

match()

bool Database::Criteria::match

(

const Entry *

entry

)

const

Return true if entry matches within the criteria.

returns true if this matches observation parameters

References bracketed_time(), Signal::Calibrator, compare(), compare_coordinates(), compare_times(), diff_degrees, diff_minutes, entry, Pulsar::ChannelSubsetMatch::get_reason(), Pulsar::ChannelSubsetMatch::match(), match_count, match_report, Pulsar::Database::match_verbose, and Pulsar::Calibrator::verbose.

---

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

• Database.h
• Database.C