casa  5.7.0-16
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
sdmbin::SwitchCyclesList Class Referenceabstract

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

#include <SwitchCyclesList.h>

Inheritance diagram for sdmbin::SwitchCyclesList:
sdmbin::DataDescriptionsSet sdmbin::BaselinesSet

Public Member Functions

std::vector< asdm::TaggetSwitchCyclesList ()
 Accessor on the array of SwitchCycle identifiers. More...
 
std::vector< asdm::TaggetSwitchCyclesList (BasebandNameMod::BasebandName basebandName)
 Accessor on the array of SwitchCycle identifiers given a named baseband. More...
 
std::vector< int > getNumBin ()
 Accessor on the number of steps for the SwitchCycles for every of the dataDesription in the list in configDescription. More...
 
std::vector< int > getNumBin (BasebandNameMod::BasebandName basebandName)
 Accessor on the number of steps for the SwitchCycles given a named basebaband. More...
 
 SwitchCyclesList (const SwitchCyclesList &)
 Copy constructor. More...
 
virtual ~SwitchCyclesList ()
 

Protected Member Functions

 SwitchCyclesList ()
 
 SwitchCyclesList (asdm::ASDM *const datasetPtr, std::vector< asdm::Tag > v_switchCycleId)
 Class to define the root of the tree hierarchy. More...
 
 SwitchCyclesList (asdm::ASDM *const datasetPtr, std::vector< std::vector< asdm::Tag > > vv_switchCycleId)
 Class to define the root of the tree hierarchy. More...
 
 SwitchCyclesList (asdm::ASDM *const datasetPtr, std::vector< std::vector< int > > vv_switchCycleId)
 Class to define the root of the tree hierarchy. More...
 
virtual void mapScToBaseband ()=0
 SwitchCyclesList defines the abstract base type of a hierarchy. More...
 

Protected Attributes

std::map
< BasebandNameMod::BasebandName,
std::vector< asdm::Tag > > 
m_bn_v_scId_
 
std::map
< BasebandNameMod::BasebandName,
std::vector< int > > 
m_bn_v_numBin_
 
std::vector< std::vector< int > > vv_numBin_
 
std::vector< int > v_numBin_
 
asdm::ASDMdatasetPtr_
 
std::vector< std::vector
< asdm::Tag > > 
vv_switchCycleId_
 
std::vector< asdm::Tagv_switchCycleId_
 

Detailed Description

Definition of the root of the tree hierarchy.

Definition at line 13 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::ASDM *const  datasetPtr,
std::vector< asdm::Tag v_switchCycleId 
)
protected

Class to define the root of the tree hierarchy.

Precondition
The asdm dataset to work with is known.
Parameters
datasetPtrA pointer on an ASDM dataset
v_switchCycleIdAn 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::ASDM *const  datasetPtr,
std::vector< std::vector< asdm::Tag > >  vv_switchCycleId 
)
protected

Class to define the root of the tree hierarchy.

Precondition
The asdm dataset to work with is known.
Parameters
datasetPtrA pointer on an ASDM dataset
vv_switchCycleIdAn array of switchCycleId identifiers, one vector per baseband.
Postcondition
The number of steps in switch cycles known for every baseband
sdmbin::SwitchCyclesList::SwitchCyclesList ( asdm::ASDM *const  datasetPtr,
std::vector< std::vector< int > >  vv_switchCycleId 
)
protected

Class to define the root of the tree hierarchy.

Precondition
The asdm dataset to work with is known.
Parameters
datasetPtrA pointer on an ASDM dataset
v_switchCycleIdAn 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

std::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
basebandNamebaseband name
std::vector<int> sdmbin::SwitchCyclesList::getNumBin ( BasebandNameMod::BasebandName  basebandName)

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

Parameters
basebandNamebaseband name
std::vector<asdm::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.
std::vector<asdm::Tag> sdmbin::SwitchCyclesList::getSwitchCyclesList ( BasebandNameMod::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.
virtual void sdmbin::SwitchCyclesList::mapScToBaseband ( )
protectedpure 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:
  1. With a nutating sub-reflector the number of bins must be the same in all the spectral windows, whatever the baseband.
  2. With frequency-switch observing modes, the number of bins may require to be unique on a baseband basis.
  3. 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.

Member Data Documentation

asdm::ASDM* sdmbin::SwitchCyclesList::datasetPtr_
protected

Definition at line 55 of file SwitchCyclesList.h.

std::map<BasebandNameMod::BasebandName,std::vector<int> > sdmbin::SwitchCyclesList::m_bn_v_numBin_
protected

Definition at line 52 of file SwitchCyclesList.h.

std::map<BasebandNameMod::BasebandName,std::vector<asdm::Tag> > sdmbin::SwitchCyclesList::m_bn_v_scId_
protected

Definition at line 51 of file SwitchCyclesList.h.

std::vector<int> sdmbin::SwitchCyclesList::v_numBin_
protected

Definition at line 54 of file SwitchCyclesList.h.

Referenced by sdmbin::DataDescriptionsSet::numBin().

std::vector<asdm::Tag> sdmbin::SwitchCyclesList::v_switchCycleId_
protected

Definition at line 100 of file SwitchCyclesList.h.

std::vector<std::vector<int> > sdmbin::SwitchCyclesList::vv_numBin_
protected

Definition at line 53 of file SwitchCyclesList.h.

std::vector<std::vector<asdm::Tag> > sdmbin::SwitchCyclesList::vv_switchCycleId_
protected

Definition at line 99 of file SwitchCyclesList.h.


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