Tempo2::Generator Class Reference

Generates a Tempo2::Predictor. More...

#include <T2Generator.h>

Inheritance diagram for Tempo2::Generator:

Public Member Functions
	Generator (const Pulsar::Parameters *parameters=0)
	Default constructor.
	~Generator ()
	Destructor.
Generator *	clone () const
	Return a new, copy constructed instance of self.
void	set_parameters (const Pulsar::Parameters *)
	Set the parameters used to generate the predictor.
void	set_time_span (const MJD &start, const MJD &finish)
	Set the range of epochs over which to generate.
void	set_time_ncoeff (unsigned ncoeff)
	Set the number of time coefficients.
void	set_frequency_span (long double low, long double high)
	Set the range of frequencies over which to generate.
void	set_frequency_ncoeff (unsigned ncoeff)
	Set the number of frequency coefficients.
void	set_site (const std::string &)
	Set the site at which the signal is observed.
void	set_segment_length (long double days)
	Set the length of each polynomial segment in days.
Pulsar::Predictor *	generate () const
	Return a new Predictor instance.
Public Member Functions inherited from Reference::Able
	Able ()
	Default constructor.
	Able (const Able &)
	Copy constructor.
Able &	operator= (const Able &)
	Assignment operator.
virtual	~Able ()
	Destructor.
unsigned	get_reference_count () const
	Returns the number of references there are to this.
Public Member Functions inherited from Reference::HeapTracked
	HeapTracked ()
	Default constructor.
	HeapTracked (const HeapTracked &)
	Copy constructor.
HeapTracked &	operator= (const HeapTracked &)
	Assignment operator.
virtual	~HeapTracked ()
	Destructor.
bool	__is_on_heap () const
	Return true if this instance is found in heap addresses.

Static Public Member Functions
static std::vector< std::string > &	get_keywords ()
	Return a list of keywords that are specific to tempo2.
static Configuration::Parameter< std::string > &	get_keyword_filename ()
	Name of file containing list of Tempo2 keywords.
Static Public Member Functions inherited from Pulsar::Generator
static Generator *	get_default ()
	Return a pointer to a new Generator of the default derived type.
static Generator *	factory (const Parameters *)
	Return a pointer to a new Generator that can best handle the parameters.
Static Public Member Functions inherited from Reference::Able
static size_t	get_instance_count ()
	Returns the current number instances in existence.
Static Public Member Functions inherited from Reference::HeapTracked
static void *	operator new (size_t size, void *ptr=0)
	Records the addresses of new instances allocated on the heap.
static void	operator delete (void *location, void *ptr)
	Placement delete overload to match the placement new overload.
static void	operator delete (void *location)
	Regular delete overload.
static size_t	get_heap_queue_size ()
	Return the number of heap addresses awaiting processing.

Static Public Attributes
static bool	print_time = false
	Print the time required to generate the predictor.

Additional Inherited Members
Protected Member Functions inherited from Reference::Able
Handle *	__reference (bool active) const
	Add the address of a reference to this object.
void	__dereference (bool auto_delete=true) const
	Remove the address of a reference to this object.
Static Protected Member Functions inherited from Pulsar::Generator
static Configuration::Parameter< Generator * > &	get_default_generator ()
	Default generator of new predictors.

Detailed Description

Generates a Tempo2::Predictor.

Member Function Documentation

clone()

Tempo2::Generator * Tempo2::Generator::clone ( ) const

virtual

Return a new, copy constructed instance of self.

Implements Pulsar::Generator.

References Generator().

generate()

Pulsar::Predictor * Tempo2::Generator::generate ( ) const

virtual

Return a new Predictor instance.

Return a new, copy constructed instance of self.

Implements Pulsar::Generator.

References print_time, Reference::To< Type, active >::release(), SystemCall::run(), and Pulsar::Predictor::verbose.

set_frequency_span()

void Tempo2::Generator::set_frequency_span ( long double low, long double high )

virtual

Set the range of frequencies over which to generate.

Implements Pulsar::Generator.

set_parameters()

void Tempo2::Generator::set_parameters ( const Pulsar::Parameters * p )

virtual

Set the parameters used to generate the predictor.

Implements Pulsar::Generator.

References Pulsar::Parameters::Lookup::get_param(), set_frequency_ncoeff(), set_segment_length(), set_time_ncoeff(), and Pulsar::Predictor::verbose.

Referenced by Generator().

set_site()

void Tempo2::Generator::set_site ( const std::string & site )

virtual

Set the site at which the signal is observed.

Implements Pulsar::Generator.

set_time_span()

void Tempo2::Generator::set_time_span ( const MJD & start, const MJD & finish )

virtual

Set the range of epochs over which to generate.

Implements Pulsar::Generator.

---

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

• T2Generator.h
• T2Generator.C