Pulsar::Integration::Extension Class Reference

#include <IntegrationExtension.h>

Inheritance diagram for Pulsar::Integration::Extension:

Classes
class	Interface
	Convenience class implements TextInterface::To<T>::get_interface_name. More...

Public Member Functions
	Extension (const char *name)
	Construct with a name.
virtual	~Extension ()
	Destructor.
virtual Extension *	clone () const =0
	Return a new copy-constructed instance identical to this instance.
virtual TextInterface::Parser *	get_interface ()
	Return a text interface that can be used to access this instance.
virtual void	integrate (const Integration *subint)
	Integrate information from another Integration.
virtual void	update (const Integration *subint)
	Update information based on the provided Integration.
std::string	get_extension_name () const
	Return the name of the Extension.
virtual std::string	get_short_name () const
	Return an abbreviated name that can be typed relatively quickly.
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

Static Public Member Functions
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
const Archive *	get_parent (const Integration *subint) const
	Provide Extension derived classes with access to parent Archive.
Protected Member Functions inherited from Reference::Able
Handle *	__reference (bool active) const
void	__dereference (bool auto_delete=true) const

Protected Attributes
std::string	extension_name
	Extension name - useful when debugging.

Detailed Description

Integration-derived classes may provide access to additional informaton through Extension-derived objects.

Member Function Documentation

clone()

virtual Extension * Pulsar::Integration::Extension::clone ( ) const

pure virtual

Return a new copy-constructed instance identical to this instance.

Implemented in AuxColdPlasmaMeasures, Pointing, Pulsar::AuxColdPlasmaMeasures, Pulsar::Dedisperse, Pulsar::DeFaraday, Pulsar::Pointing, Pulsar::SpectralKurtosis, and SpectralKurtosis.

References Extension().

get_interface()

virtual TextInterface::Parser * Pulsar::Integration::Extension::get_interface ( )

inlinevirtual

Return a text interface that can be used to access this instance.

Reimplemented in AuxColdPlasmaMeasures, Pointing, Pulsar::AuxColdPlasmaMeasures, Pulsar::Pointing, Pulsar::SpectralKurtosis, and SpectralKurtosis.

get_short_name()

string Pulsar::Integration::Extension::get_short_name ( ) const

virtual

Return an abbreviated name that can be typed relatively quickly.

Reimplemented in AuxColdPlasmaMeasures, Pointing, Pulsar::AuxColdPlasmaMeasures, Pulsar::Pointing, Pulsar::SpectralKurtosis, and SpectralKurtosis.

References extension_name.

integrate()

virtual void Pulsar::Integration::Extension::integrate ( const Integration * subint )

inlinevirtual

Integrate information from another Integration.

Reimplemented in Pulsar::Pointing, Pulsar::SpectralKurtosis, and SpectralKurtosis.

References Pulsar::Integration::Integration().

Referenced by Pulsar::TimeIntegrate::transform().

update()

virtual void Pulsar::Integration::Extension::update ( const Integration * subint )

inlinevirtual

Update information based on the provided Integration.

Reimplemented in Pulsar::Pointing, Pulsar::SpectralKurtosis, and SpectralKurtosis.

References Pulsar::Integration::Integration().

Referenced by Pulsar::TimeIntegrate::transform().

---

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

• IntegrationExtension.h
• Integration.C
• Extension_factory.C