Pulsar::Backend Class Reference

Stores information about the instrument backend. More...

#include <Backend.h>

Inheritance diagram for Pulsar::Backend:

Classes
class	Interface
	Text interface to Backend extension. More...

Public Member Functions
	Backend (const std::string &ext_name="Backend")
	Default constructor.
	Backend (const Backend &)
	Copy constructor.
const Backend &	operator= (const Backend &)
	Operator =.
Backend *	clone () const
	Clone method.
std::string	get_short_name () const
	Return an abbreviated name that can be typed relatively quickly.
TextInterface::Parser *	get_interface ()
	Return a text interfaces that can be used to access this instance.
std::string	get_name () const
	Return the name of the Backend.
void	set_name (const std::string &name)
	Set the name of the backend.
Signal::Hand	get_hand () const
	Get the hand of the backend.
void	set_hand (Signal::Hand)
	Set the hand of the backend.
Signal::Argument	get_argument () const
	Get the argument of the backend.
void	set_argument (Signal::Argument)
	Set the argument of the backend.
bool	get_downconversion_corrected () const
	True if backend has compensated for lower sideband downconversion.
void	set_downconversion_corrected (bool corrected=true)
	True if backend has compensated for lower sideband downconversion.
bool	get_corrected () const
	True if backend corrections were applied during calibration.
void	set_corrected (bool corrected=true)
	True if backend corrections were applied during calibration.
double	get_delay () const
	Get the delay.
void	set_delay (const double set_delay)
	Set the delay.
Public Member Functions inherited from Pulsar::Archive::Extension
	Extension (const char *name)
	Construct with a name.
virtual	~Extension ()
	Destructor.
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	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

Protected Attributes
std::string	name
	The name of the backend.
Signal::Hand	hand
	The backend handedness.
Signal::Argument	argument
	The backend argument.
bool	downconversion_corrected
	True if backend has compensated for lower sideband downconversion.
bool	corrected
	True if backend corrections were applied during calibration.
double	delay
	proportional delay from digitiser input
Protected Attributes inherited from Pulsar::Archive::Extension
std::string	extension_name
	Extension name - useful when debugging.

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

Detailed Description

Stores information about the instrument backend.

Derived classes must implement clone and get_name methods.

Member Function Documentation

clone()

Backend * Pulsar::Backend::clone ( ) const

inlinevirtual

Clone method.

Implements Pulsar::Archive::Extension.

Reimplemented in Pulsar::WidebandCorrelator, and WidebandCorrelator.

References Backend().

get_corrected()

bool Pulsar::Backend::get_corrected

(

)

const

True if backend corrections were applied during calibration.

Return true if backend has compensated for lower sideband downconversion.

References corrected.

Referenced by Pulsar::BackendCorrection::operator()(), Pulsar::TimerArchive::pack_extensions(), and Pulsar::FITSArchive::update_history().

get_downconversion_corrected()

bool Pulsar::Backend::get_downconversion_corrected

(

)

const

True if backend has compensated for lower sideband downconversion.

Return true if backend has compensated for lower sideband downconversion.

References downconversion_corrected.

Referenced by Pulsar::TimerArchive::pack_extensions(), Pulsar::TimerArchive::subint_load(), and Pulsar::FITSArchive::unload_file().

get_interface()

TextInterface::Parser * Pulsar::Backend::get_interface ( void )

virtual

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

Reimplemented from Pulsar::Archive::Extension.

Reimplemented in Pulsar::WidebandCorrelator, and WidebandCorrelator.

get_short_name()

std::string Pulsar::Backend::get_short_name ( ) const

inlinevirtual

Return an abbreviated name that can be typed relatively quickly.

Reimplemented from Pulsar::Archive::Extension.

set_corrected()

void Pulsar::Backend::set_corrected

(

bool

corrected = true

)

True if backend corrections were applied during calibration.

Set true if backend has compensated for lower sideband downconversion.

References corrected.

Referenced by Pulsar::BackendCorrection::operator()(), and Pulsar::TimerArchive::unpack_extensions().

set_downconversion_corrected()

void Pulsar::Backend::set_downconversion_corrected

(

bool

corrected = true

)

True if backend has compensated for lower sideband downconversion.

Set true if backend has compensated for lower sideband downconversion.

References downconversion_corrected.

Referenced by Pulsar::ASPArchive::load_extensions(), Pulsar::BackendCorrection::operator()(), Pulsar::TimerArchive::subint_load(), and Pulsar::TimerArchive::unpack_extensions().

---

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

• Backend.h
• Backend.C