sdmbin::SwitchCyclesList Class Reference

Definition of the root of the tree hierarchy. More...

#include <SwitchCyclesList.h>

Inheritance diagram for sdmbin::SwitchCyclesList:

Public Member Functions
vector< Tag >	getSwitchCyclesList ()
	Accessor on the array of SwitchCycle identifiers.
vector< Tag >	getSwitchCyclesList (BasebandName basebandName)
	Accessor on the array of SwitchCycle identifiers given a named baseband.
vector< int >	getNumBin ()
	Accessor on the number of steps for the SwitchCycles for every of the dataDesription in the list in configDescription.
vector< int >	getNumBin (BasebandName basebandName)
	Accessor on the number of steps for the SwitchCycles given a named basebaband.
	SwitchCyclesList (const SwitchCyclesList &)
	Copy constructor.
virtual	~SwitchCyclesList ()
Protected Member Functions
	SwitchCyclesList ()
	SwitchCyclesList (ASDM *const datasetPtr, vector< Tag > v_switchCycleId)
	Class to define the root of the tree hierarchy.
	SwitchCyclesList (ASDM *const datasetPtr, vector< vector< Tag > > vv_switchCycleId)
	Class to define the root of the tree hierarchy.
	SwitchCyclesList (ASDM *const datasetPtr, vector< vector< int > > vv_switchCycleId)
	Class to define the root of the tree hierarchy.
virtual void	mapScToBaseband ()=0
	SwitchCyclesList defines the abstract base type of a hierarchy.
Protected Attributes
map< BasebandName, vector< Tag > >	m_bn_v_scId_
map< BasebandName, vector< int > >	m_bn_v_numBin_
vector< vector< int > >	vv_numBin_
vector< int >	v_numBin_
ASDM *	datasetPtr_
vector< vector< Tag > >	vv_switchCycleId_
vector< Tag >	v_switchCycleId_

Detailed Description

Definition of the root of the tree hierarchy.

Definition at line 16 of file SwitchCyclesList.h.

Constructor & Destructor Documentation

sdmbin::SwitchCyclesList::SwitchCyclesList ( const SwitchCyclesList & )

Copy constructor.

virtual sdmbin::SwitchCyclesList::~SwitchCyclesList ( ) [virtual]

sdmbin::SwitchCyclesList::SwitchCyclesList ( ) [protected]

sdmbin::SwitchCyclesList::SwitchCyclesList	(	ASDM *const	datasetPtr,
		vector< Tag >	v_switchCycleId
	)			`[protected]`

Class to define the root of the tree hierarchy.

Precondition:: The asdm dataset to work with is known.

Parameters:

	datasetPtr	A pointer on an ASDM dataset
	v_switchCycleId	An array of switchCycleId identifiers, one per DataDescription.

Postcondition:: The number of steps in switch cycles for every spectral window is known

sdmbin::SwitchCyclesList::SwitchCyclesList	(	ASDM *const	datasetPtr,
		vector< vector< Tag > >	vv_switchCycleId
	)			`[protected]`

Class to define the root of the tree hierarchy.

Precondition:: The asdm dataset to work with is known.

Parameters:

	datasetPtr	A pointer on an ASDM dataset
	vv_switchCycleId	An array of switchCycleId identifiers, one vector per baseband.

Postcondition:: The number of steps in switch cycles known for every baseband

sdmbin::SwitchCyclesList::SwitchCyclesList	(	ASDM *const	datasetPtr,
		vector< vector< int > >	vv_switchCycleId
	)			`[protected]`

Class to define the root of the tree hierarchy.

Precondition:: The asdm dataset to work with is known.

Parameters:

	datasetPtr	A pointer on an ASDM dataset
	v_switchCycleId	An array of switchCycleId identifiers, one per baseband.

Postcondition:: The number of steps in switch cycles known for every baseband

Note:: Use the alternate constructor, SwitchCyclesList(ASDM* datasetPtr, vector<vector<Tag> > vv_switchCycleId), in the more conventional case ,the SwitchCycle identifiers being expressed using the asdm type Tag.

Member Function Documentation

vector<int> sdmbin::SwitchCyclesList::getNumBin ( BasebandName basebandName )

Accessor on the number of steps for the SwitchCycles given a named basebaband.

Parameters:

basebandName

baseband name

vector<int> sdmbin::SwitchCyclesList::getNumBin ( )

Accessor on the number of steps for the SwitchCycles for every of the dataDesription in the list in configDescription.

Parameters:

basebandName

baseband name

vector<Tag> sdmbin::SwitchCyclesList::getSwitchCyclesList ( BasebandName basebandName )

Accessor on the array of SwitchCycle identifiers given a named baseband.

Returns:: A vector of SwitchCycle identifiers of asdm type Tag. Its size corresponds to the number of spectral windows in that baseband which has been used for the configuration setup.

vector<Tag> sdmbin::SwitchCyclesList::getSwitchCyclesList ( )

Accessor on the array of SwitchCycle identifiers.

Returns:: A flat vector of SwitchCycle identifiers of asdm type Tag. Its size corresponds to the number of dataDescriptions used for the setup of the configuration.

virtual void sdmbin::SwitchCyclesList::mapScToBaseband ( ) [protected, pure virtual]

SwitchCyclesList defines the abstract base type of a hierarchy.

Note:

there are various possible levels of constraints for the number of bins. For example, from the highest to the lowest constraint:

With a nutating sub-reflector the number of bins must be the same in all the spectral windows, whatever the baseband.
With frequency-switch observing modes, the number of bins may require to be unique on a baseband basis.
With dedispersion for pulsar observations the number of bins may be solely spectral-window based.

mapScToBaseband(), implemented in the derived class DataDescriptionSets, maps vectors to baseband names to support this, the baseband names being attributes in the definition of the spectral windows.

Implemented in sdmbin::DataDescriptionsSet.