Pulsar::Archive::Extension Class Reference

#include <ArchiveExtension.h>

Inheritance diagram for Pulsar::Archive::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.
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.
virtual bool	has_data () const
	Returns true if the Extension contains useful data.
virtual void	resize (unsigned nsubint, unsigned npol=0, unsigned nchan=0, unsigned nbin=0)
	Resize the Extension.
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

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 Attributes
std::string	extension_name
	Extension name - useful when debugging.

Additional Inherited Members
Protected Member Functions inherited from Reference::Able
Handle *	__reference (bool active) const
void	__dereference (bool auto_delete=true) const

Detailed Description

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

Member Function Documentation

clone()

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

pure virtual

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

Implemented in CoherentDedispersion, DigitiserCounts, DigitiserStatistics, FITSHdrExtension, FITSSUBHdrExtension, IntegrationOrder, Passband, Pulsar::AuxColdPlasma, Pulsar::Backend, Pulsar::BinaryPhaseOrder, Pulsar::BinLngAscOrder, Pulsar::BinLngPeriOrder, Pulsar::CalibrationInterpolatorExtension, Pulsar::CalibratorExtension, Pulsar::CalibratorStokes, Pulsar::CalInfoExtension, Pulsar::CoherentDedispersion, Pulsar::ConfigurableProjectionExtension, Pulsar::DigitiserCounts, Pulsar::DigitiserStatistics, Pulsar::dspReduction, Pulsar::ExampleExtension, Pulsar::FeedExtension, Pulsar::FITSHdrExtension, Pulsar::FITSSUBHdrExtension, Pulsar::FluxCalibratorExtension, Pulsar::IntegrationOrder, Pulsar::ITRFExtension, Pulsar::ObsDescription, Pulsar::ObsExtension, Pulsar::Passband, Pulsar::PeriastronOrder, Pulsar::PolnCalibratorExtension, Pulsar::Receiver, Pulsar::ScintPowerEstimator, Pulsar::TapeInfo, Pulsar::Telescope, Pulsar::TwoBitStats, Pulsar::WidebandCorrelator, and WidebandCorrelator.

References Extension().

frequency_append()

virtual void Pulsar::Archive::Extension::frequency_append ( Archive * to, const Archive * from )

inlinevirtual

Append data along frequency dimension, if applicable.

Reimplemented in DigitiserCounts, Pulsar::CalibratorExtension, Pulsar::CalibratorStokes, Pulsar::ConfigurableProjectionExtension, Pulsar::DigitiserCounts, Pulsar::FluxCalibratorExtension, and Pulsar::PolnCalibratorExtension.

References Pulsar::Archive::Archive().

Referenced by Pulsar::FrequencyAppend::combine().

get_interface()

virtual TextInterface::Parser * Pulsar::Archive::Extension::get_interface ( void )

inlinevirtual

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

Reimplemented in CoherentDedispersion, DigitiserCounts, DigitiserStatistics, FITSHdrExtension, FITSSUBHdrExtension, Passband, Pulsar::AuxColdPlasma, Pulsar::Backend, Pulsar::CalibrationInterpolatorExtension, Pulsar::CalibratorExtension, Pulsar::CalibratorStokes, Pulsar::CoherentDedispersion, Pulsar::ConfigurableProjectionExtension, Pulsar::DigitiserCounts, Pulsar::DigitiserStatistics, Pulsar::dspReduction, Pulsar::FeedExtension, Pulsar::FITSHdrExtension, Pulsar::FITSSUBHdrExtension, Pulsar::FluxCalibratorExtension, Pulsar::ITRFExtension, Pulsar::ObsExtension, Pulsar::Passband, Pulsar::PolnCalibratorExtension, Pulsar::Receiver, Pulsar::WidebandCorrelator, and WidebandCorrelator.

get_short_name()

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

virtual

Return an abbreviated name that can be typed relatively quickly.

Reimplemented in CoherentDedispersion, DigitiserStatistics, FITSHdrExtension, FITSSUBHdrExtension, IntegrationOrder, Passband, Pulsar::AuxColdPlasma, Pulsar::Backend, Pulsar::CalibrationInterpolatorExtension, Pulsar::CalibratorExtension, Pulsar::CalibratorStokes, Pulsar::CoherentDedispersion, Pulsar::ConfigurableProjectionExtension, Pulsar::DigitiserStatistics, Pulsar::dspReduction, Pulsar::FITSHdrExtension, Pulsar::FITSSUBHdrExtension, Pulsar::FluxCalibratorExtension, Pulsar::IntegrationOrder, Pulsar::ITRFExtension, Pulsar::ObsExtension, Pulsar::Passband, Pulsar::PolnCalibratorExtension, and Pulsar::Receiver.

References extension_name.

has_data()

virtual bool Pulsar::Archive::Extension::has_data ( ) const

inlinevirtual

Returns true if the Extension contains useful data.

Reimplemented in Passband, Pulsar::CalibrationInterpolatorExtension, and Pulsar::Passband.

resize()

virtual void Pulsar::Archive::Extension::resize ( unsigned nsubint, unsigned npol = 0, unsigned nchan = 0, unsigned nbin = 0 )

inlinevirtual

Resize the Extension.

Reimplemented in DigitiserCounts, DigitiserStatistics, IntegrationOrder, Pulsar::DigitiserCounts, Pulsar::DigitiserStatistics, and Pulsar::IntegrationOrder.

Referenced by Pulsar::Archive::resize(), and Pulsar::FluxCalibratorExtension::set_nreceptor().

---

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

• ArchiveExtension.h
• Archive.C
• Extension_factory.C