Pulsar::Parameters Class Reference

Storage of pulsar parameters used to create a Predictor. More...

#include <Parameters.h>

Inheritance diagram for Pulsar::Parameters:

Classes
class	Lookup
	Looks for pulsar parameters in various places. More...

Public Member Functions
virtual Parameters *	clone () const =0
	Return a new, copy constructed instance of self.
virtual bool	equals (const Parameters *that) const =0
	Return true if *this == *that.
virtual void	load (FILE *)=0
	Load from an open stream.
virtual void	unload (FILE *) const =0
	Unload to an open stream.
void	load (const std::string &filename)
	Load from the named file.
void	unload (const std::string &filename) const
	Unload to the named file.
virtual std::string	get_name () const
	Return the pulsar name.
virtual std::string	get_value (const std::string &keyword) const
	Retrieve a string from the text.
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 void	children (std::vector< Reference::To< Parameters > > &)
	Factory helper creates a vector of pointers to derived class instances.
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	verbose = 0
	Verbosity flag.

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

Storage of pulsar parameters used to create a Predictor.

This pure virtual base class defines the interface to pulsar parameters

Member Function Documentation

clone()

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

pure virtual

Return a new, copy constructed instance of self.

Implemented in Pulsar::TextParameters, and TextParameters.

equals()

virtual bool Pulsar::Parameters::equals ( const Parameters * that ) const

pure virtual

Return true if *this == *that.

Implemented in Pulsar::TextParameters, and TextParameters.

get_name()

std::string Pulsar::Parameters::get_name ( ) const

virtual

Return the pulsar name.

Reimplemented in Pulsar::TextParameters, and TextParameters.

Referenced by Tempo::fit().

get_value()

std::string Pulsar::Parameters::get_value ( const std::string & keyword ) const

virtual

Retrieve a string from the text.

Reimplemented in Pulsar::TextParameters, and TextParameters.

load()

virtual void Pulsar::Parameters::load ( FILE * )

pure virtual

Load from an open stream.

Implemented in Pulsar::TextParameters, and TextParameters.

Referenced by Tempo::fit(), and load().

unload()

virtual void Pulsar::Parameters::unload ( FILE * ) const

pure virtual

Unload to an open stream.

Implemented in Pulsar::TextParameters, and TextParameters.

Referenced by Tempo::fit(), and unload().

---

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

• Parameters.h
• Parameters_children.C
• Parameters.C
• psrephem.C