Pulsar::Generator Class Reference

Generator of functions that predict pulse phase. More...

#include <Generator.h>

Inheritance diagram for Pulsar::Generator:

Classes
class	Interpreter
	Interprets configuration strings into the default generator. More...

Public Member Functions
virtual Generator *	clone () const =0
	Return a new, copy constructed instance of self.
virtual void	set_parameters (const Parameters *)=0
	Set the parameters used to generate the predictor.
virtual void	set_time_span (const MJD &start, const MJD &finish)=0
	Set the range of epochs over which to generate.
virtual void	set_frequency_span (long double low, long double high)=0
	Set the range of frequencies over which to generate.
virtual void	set_site (const std::string &)=0
	Set the site at which the signal is observed.
virtual Predictor *	generate () const =0
	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 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 Protected Member Functions
static Configuration::Parameter< Generator * > &	get_default_generator ()
	Default generator of new predictors.

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.

Detailed Description

Generator of functions that predict pulse phase.

This pure virtual base class defines the interface to pulse phase predictor generators

Member Function Documentation

clone()

virtual Generator * Pulsar::Generator::clone ( ) const

pure virtual

Return a new, copy constructed instance of self.

Implemented in Tempo2::Generator, and Tempo::Predict.

Referenced by get_default().

generate()

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

pure virtual

Return a new Predictor instance.

Implemented in Tempo2::Generator, and Tempo::Predict.

set_frequency_span()

virtual void Pulsar::Generator::set_frequency_span ( long double low, long double high )

pure virtual

Set the range of frequencies over which to generate.

Implemented in Tempo2::Generator, and Tempo::Predict.

set_parameters()

virtual void Pulsar::Generator::set_parameters ( const Parameters * )

pure virtual

Set the parameters used to generate the predictor.

Implemented in Tempo2::Generator, and Tempo::Predict.

set_site()

virtual void Pulsar::Generator::set_site ( const std::string & )

pure virtual

Set the site at which the signal is observed.

Implemented in Tempo2::Generator, and Tempo::Predict.

set_time_span()

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

pure virtual

Set the range of epochs over which to generate.

Implemented in Tempo2::Generator, and Tempo::Predict.

---

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

• Generator.h
• Generator_default.C
• Generator_factory.C