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. More...

void	__dereference (bool auto_delete=true) const
	Remove the address of a reference to this object. More...

Detailed Description

Generator of functions that predict pulse phase.

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

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