Pulsar::PeriastronOrder Class Reference

#include <PeriastronOrder.h>

Inheritance diagram for Pulsar::PeriastronOrder:

Public Member Functions
	PeriastronOrder ()
	Default constructor.
	~PeriastronOrder ()
	Destructor.
	PeriastronOrder (const PeriastronOrder &extension)
	Copy constructor.
const PeriastronOrder &	operator= (const PeriastronOrder &extension)
	Operator =.
IntegrationOrder *	clone () const
	Clone method.
void	organise (Archive *, unsigned)
	Re-order the Integrations into the desired state.
void	append (Archive *, const Archive *)
	Add two Archive instances that have the same IntegrationOrder.
void	combine (Archive *, unsigned)
Public Member Functions inherited from Pulsar::IntegrationOrder
	IntegrationOrder (const char *name)
	Default constructor.
	IntegrationOrder (const IntegrationOrder &extension)
	Copy constructor.
const IntegrationOrder &	operator= (const IntegrationOrder &extension)
	Operator =.
virtual	~IntegrationOrder ()
	Destructor.
std::string	get_IndexState () const
	Return a string describing the type of indexing used.
std::string	get_Unit () const
	Return a string describing the units of this state.
unsigned	size () const
	Return the size of the index array.
void	resize (unsigned nsubint, unsigned npol=0, unsigned nchan=0, unsigned nbin=0)
	Change the size of the index array.
void	erase (unsigned i)
	Erase the specified index.
void	set_Index (unsigned subint, double i)
	Set the custom index value associated with an Integration.
double	get_Index (unsigned subint) const
	Get the custom index value associated with an Integration.
std::string	get_short_name () const
	Return a short name.
Public Member Functions inherited from Pulsar::Archive::Extension
	Extension (const char *name)
	Construct with a name.
virtual	~Extension ()
	Destructor.
virtual TextInterface::Parser *	get_interface ()
	Return a text interface that can be used to access this instance.
std::string	get_extension_name () const
	Return the name of the Extension.
virtual bool	has_data () const
	Returns true if the Extension contains useful data.
virtual void	frequency_append (Archive *to, const Archive *from)
	Append data along frequency dimension, if applicable.
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

Additional Inherited Members
Static Public Member Functions inherited from Pulsar::Archive::Extension
static Extension *	factory (const std::string &name)
	Derived type factory.
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
Protected Attributes inherited from Pulsar::IntegrationOrder
std::string	IndexState
	An index state identifier string.
std::string	Unit
	The units (if any) of this state.
std::vector< double >	indices
	Storage for the actual Integration indices.
Protected Attributes inherited from Pulsar::Archive::Extension
std::string	extension_name
	Extension name - useful when debugging.

Detailed Description

This PeriastronOrder class provides a means for developers to re-index the way Integrations are stored. It is a virtual base class that must be inherited by developers who wish to define a new way to index the Integrations in their Archive

Member Function Documentation

append()

void Pulsar::PeriastronOrder::append ( Archive * , const Archive *  )

virtual

Add two Archive instances that have the same IntegrationOrder.

Implements Pulsar::IntegrationOrder.

clone()

Pulsar::IntegrationOrder * Pulsar::PeriastronOrder::clone ( ) const

virtual

Clone method.

Implements Pulsar::IntegrationOrder.

References PeriastronOrder().

combine()

void Pulsar::PeriastronOrder::combine ( Archive * , unsigned  )

virtual

Scrunch together this many consecutive Integrations in an Archive with this IntegrationOrder

Implements Pulsar::IntegrationOrder.

References Pulsar::Archive::clone(), Pulsar::Integration::Expert::combine(), Pulsar::Integration::expert(), Pulsar::IntegrationManager::get_Integration(), Pulsar::IntegrationManager::get_nsubint(), Pulsar::IntegrationOrder::indices, Pulsar::IntegrationManager::new_Integration(), Pulsar::Archive::resize(), and Pulsar::IntegrationManager::verbose.

organise()

void Pulsar::PeriastronOrder::organise ( Archive * , unsigned  )

virtual

Re-order the Integrations into the desired state.

Implements Pulsar::IntegrationOrder.

References Pulsar::Archive::clone(), Pulsar::Integration::Expert::combine(), Pulsar::Integration::Expert::copy(), Pulsar::Integration::expert(), Pulsar::Integration::get_centre_frequency(), Pulsar::Archive::get_ephemeris(), Pulsar::Integration::get_epoch(), Pulsar::IntegrationManager::get_Integration(), Pulsar::IntegrationManager::get_nsubint(), Pulsar::Archive::get_telescope(), Pulsar::IntegrationOrder::indices, Pulsar::Archive::resize(), Pulsar::IntegrationOrder::set_Index(), and Pulsar::Integration::zero().

---

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

• PeriastronOrder.h
• PeriastronOrder.C