casa  5.7.0-16
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Private Member Functions | Private Attributes | Friends | List of all members
asdmbinaries::SDMDataSubset Class Reference

SDMDataObject:: More...

#include <SDMDataObject.h>

Public Member Functions

 SDMDataSubset (SDMDataObject *owner=0)
 
 SDMDataSubset (SDMDataObject *owner, unsigned long long time, unsigned long long interval, const std::vector< float > &autoData)
 
 SDMDataSubset (const SDMDataSubset &sdmDataSubset)
 
SDMDataSubsetoperator= (const SDMDataSubset &sdmDataSubset)
 
virtual ~SDMDataSubset ()
 
const SDMDataObjectowner () const
 
unsigned int integrationNum () const
 
unsigned int subintegrationNum () const
 
std::string projectPath () const
 Returns the project path of this SDMDataSubset. More...
 
unsigned long long time () const
 Returns the midpoint of : More...
 
unsigned long long interval () const
 Returns the duration of the subscan in the case of total power data. More...
 
std::string toString (unsigned int N=10) const
 Returns a description of this SDMDataSubset. More...
 
void binAttachToXML (const std::string &name, std::ostringstream &oss)
 
void tpBinAttachToXML (std::ostringstream &oss)
 
void corrBinAttachToXML (std::ostringstream &oss)
 
void toXML (std::ostringstream &oss) const
 
std::string toXML ()
 Returns an XML representation of this SDMDataSubset. More...
 
unsigned long int actualDurations (const ACTUALDURATIONSTYPE *&ptr) const
 Set ptr to the adress of the array of ActualDurations and returns the number of actualDurations. More...
 
uint64_t actualDurationsPosition () const
 Returns the position (0-based, relative to the beginning of the file) of this part when it has been read in a file. More...
 
unsigned long int actualTimes (const ACTUALTIMESTYPE *&ptr) const
 Set ptr to the adress of the array of ActualTimes and returns the number of ActualTimes. More...
 
uint64_t actualTimesPosition () const
 Returns the position (0-based, relative to the beginning of the file) of this part when it has been read in a file. More...
 
unsigned long int autoData (const AUTODATATYPE *&ptr) const
 Set ptr to the adress of the array of AutoData and returns the number of AutoData. More...
 
uint64_t autoDataPosition () const
 Returns the position (0-based, relative to the beginning of the file) of this part when it has been read in a file. More...
 
unsigned long int crossData (const SHORTCROSSDATATYPE *&ptr) const
 Set ptr to the adress of the array of short int CrossData and returns the number of short int CrossData. More...
 
unsigned long int crossData (const INTCROSSDATATYPE *&ptr) const
 Set ptr to the adress of the array of int CrossData and Returns the number of long int CrossData. More...
 
unsigned long int crossData (const FLOATCROSSDATATYPE *&ptr) const
 Set ptr to the adress of the array of float CrossData and Returns the number of long int CrossData. More...
 
uint64_t crossDataPosition () const
 Returns the position (0-based, relative to the beginning of the file) of this part when it has been read in a file. More...
 
PrimitiveDataTypeMod::PrimitiveDataType crossDataType () const
 Return the type of cross data values. More...
 
void crossDataType (PrimitiveDataTypeMod::PrimitiveDataType value)
 
unsigned long int flags (const FLAGSTYPE *&ptr) const
 Set ptr to the adress of the array of flags and returns the number of flags. More...
 
uint64_t flagsPosition () const
 Returns the position (0-based, relative to the beginning of the file) of this part when it has been read in a file. More...
 
unsigned long int zeroLags (const ZEROLAGSTYPE *&ptr) const
 Set ptr to the adress of the array of ZeroLags and returns the number of ZeroLags. More...
 
uint64_t zeroLagsPosition () const
 Returns the position (0-based, relative to the beginning of the file) of this part when it has been read in a file. More...
 
bool aborted () const
 Returns true if and only if this corresponds to an aborted [sub]integration. More...
 
unsigned long long abortTime () const
 Returns the time when the [sub]integration has been declared aborted. More...
 
std::string abortReason () const
 Returns the reason why the [sub]integration was aborted. More...
 

Private Member Functions

std::string xsiType () const
 

Private Attributes

SDMDataObjectowner_
 
unsigned int integrationNum_
 
unsigned int subintegrationNum_
 
CorrelationModeMod::CorrelationMode ref_
 
unsigned long long time_
 
unsigned long long interval_
 
std::string dataStruct_
 
std::string flagsREF_
 
std::string actualTimesREF_
 
std::string actualDurationsREF_
 
std::string zeroLagsREF_
 
std::string crossDataREF_
 
PrimitiveDataTypeMod::PrimitiveDataType crossDataType_
 
std::string autoDataREF_
 
const ACTUALTIMESTYPEactualTimes_
 
unsigned long int nActualTimes_
 
uint64_t actualTimesPosition_
 
const ACTUALDURATIONSTYPEactualDurations_
 
unsigned long int nActualDurations_
 
uint64_t actualDurationsPosition_
 
const ZEROLAGSTYPEzeroLags_
 
unsigned long int nZeroLags_
 
uint64_t zeroLagsPosition_
 
const FLAGSTYPEflags_
 
unsigned long int nFlags_
 
uint64_t flagsPosition_
 
const INTCROSSDATATYPElongCrossData_
 
const SHORTCROSSDATATYPEshortCrossData_
 
const FLOATCROSSDATATYPEfloatCrossData_
 
unsigned long int nCrossData_
 
uint64_t crossDataPosition_
 
const AUTODATATYPEautoData_
 
unsigned long int nAutoData_
 
uint64_t autoDataPosition_
 
bool aborted_
 
unsigned long long int abortTime_
 
std::string abortReason_
 

Friends

class SDMDataObject
 
class SDMDataObjectReader
 
class SDMDataObjectStreamReader
 
class SDMDataObjectWriter
 
class CorrSubsetHeaderParser
 
class TPSubsetHeaderParser
 

Detailed Description

SDMDataObject::

SDMDataSubset:: declarations An SDMDataSubset is a class to represent the binary data stored during :

Definition at line 1268 of file SDMDataObject.h.

Constructor & Destructor Documentation

asdmbinaries::SDMDataSubset::SDMDataSubset ( SDMDataObject owner = 0)
asdmbinaries::SDMDataSubset::SDMDataSubset ( SDMDataObject owner,
unsigned long long  time,
unsigned long long  interval,
const std::vector< float > &  autoData 
)
asdmbinaries::SDMDataSubset::SDMDataSubset ( const SDMDataSubset sdmDataSubset)
virtual asdmbinaries::SDMDataSubset::~SDMDataSubset ( )
virtual

Member Function Documentation

bool asdmbinaries::SDMDataSubset::aborted ( ) const

Returns true if and only if this corresponds to an aborted [sub]integration.

Returns
a bool.
std::string asdmbinaries::SDMDataSubset::abortReason ( ) const

Returns the reason why the [sub]integration was aborted.

Returns
a string.
Note
Of course, the returned value is not meaningful if aborted() returns false.
unsigned long long asdmbinaries::SDMDataSubset::abortTime ( ) const

Returns the time when the [sub]integration has been declared aborted.

Returns
an unsigned long long.
Note
Of course, the returned value is not meaningful if aborted() returns false.
unsigned long int asdmbinaries::SDMDataSubset::actualDurations ( const ACTUALDURATIONSTYPE *&  ptr) const

Set ptr to the adress of the array of ActualDurations and returns the number of actualDurations.

Parameters
ptra reference to a pointer on long long.
Returns
the number of ActualDurations.
uint64_t asdmbinaries::SDMDataSubset::actualDurationsPosition ( ) const

Returns the position (0-based, relative to the beginning of the file) of this part when it has been read in a file.

Has no meaning otherwise.

unsigned long int asdmbinaries::SDMDataSubset::actualTimes ( const ACTUALTIMESTYPE *&  ptr) const

Set ptr to the adress of the array of ActualTimes and returns the number of ActualTimes.

Parameters
ptra reference to a pointer on long long.
Returns
the number of ActualTimes.
uint64_t asdmbinaries::SDMDataSubset::actualTimesPosition ( ) const

Returns the position (0-based, relative to the beginning of the file) of this part when it has been read in a file.

Has no meaning otherwise.

unsigned long int asdmbinaries::SDMDataSubset::autoData ( const AUTODATATYPE *&  ptr) const

Set ptr to the adress of the array of AutoData and returns the number of AutoData.

Parameters
ptra reference to a pointer on float.
Returns
the number of AutoData.
uint64_t asdmbinaries::SDMDataSubset::autoDataPosition ( ) const

Returns the position (0-based, relative to the beginning of the file) of this part when it has been read in a file.

Has no meaning otherwise.

void asdmbinaries::SDMDataSubset::binAttachToXML ( const std::string &  name,
std::ostringstream &  oss 
)
void asdmbinaries::SDMDataSubset::corrBinAttachToXML ( std::ostringstream &  oss)
unsigned long int asdmbinaries::SDMDataSubset::crossData ( const SHORTCROSSDATATYPE *&  ptr) const

Set ptr to the adress of the array of short int CrossData and returns the number of short int CrossData.

Parameters
ptra reference to a pointer on short int.
Returns
the number of short int CrossData values.
unsigned long int asdmbinaries::SDMDataSubset::crossData ( const INTCROSSDATATYPE *&  ptr) const

Set ptr to the adress of the array of int CrossData and Returns the number of long int CrossData.

Parameters
ptra reference to a pointer on long int.
Returns
the number of long int CrossData values.
unsigned long int asdmbinaries::SDMDataSubset::crossData ( const FLOATCROSSDATATYPE *&  ptr) const

Set ptr to the adress of the array of float CrossData and Returns the number of long int CrossData.

Parameters
ptra reference to a pointer on float.
Returns
the number of float CrossData values.
uint64_t asdmbinaries::SDMDataSubset::crossDataPosition ( ) const

Returns the position (0-based, relative to the beginning of the file) of this part when it has been read in a file.

Has no meaning otherwise.

PrimitiveDataTypeMod::PrimitiveDataType asdmbinaries::SDMDataSubset::crossDataType ( ) const

Return the type of cross data values.

Returns
a value of the enumeration PrimitiveDataTypeMod::PrimitiveDataType.
void asdmbinaries::SDMDataSubset::crossDataType ( PrimitiveDataTypeMod::PrimitiveDataType  value)
unsigned long int asdmbinaries::SDMDataSubset::flags ( const FLAGSTYPE *&  ptr) const

Set ptr to the adress of the array of flags and returns the number of flags.

Parameters
ptra reference to a pointer on unsigned long int.
Returns
the number of flags.
uint64_t asdmbinaries::SDMDataSubset::flagsPosition ( ) const

Returns the position (0-based, relative to the beginning of the file) of this part when it has been read in a file.

Has no meaning otherwise.

unsigned int asdmbinaries::SDMDataSubset::integrationNum ( ) const
unsigned long long asdmbinaries::SDMDataSubset::interval ( ) const

Returns the duration of the subscan in the case of total power data.

Note
not relevant in the case of correlator data.
SDMDataSubset& asdmbinaries::SDMDataSubset::operator= ( const SDMDataSubset sdmDataSubset)
const SDMDataObject* asdmbinaries::SDMDataSubset::owner ( ) const
std::string asdmbinaries::SDMDataSubset::projectPath ( ) const

Returns the project path of this SDMDataSubset.

the project path is a string of the form :

  • /<execblock-number>/<scan-number>/<subscan-number>/<integration-number> in the case of correlator data.
  • /<execblock-number>/<scan-number>/<subscan-number> in the case of total power data.
unsigned int asdmbinaries::SDMDataSubset::subintegrationNum ( ) const
unsigned long long asdmbinaries::SDMDataSubset::time ( ) const

Returns the midpoint of :

  • the integration in the case of correlator data.
  • the subscan in the case of total power data.
std::string asdmbinaries::SDMDataSubset::toString ( unsigned int  N = 10) const

Returns a description of this SDMDataSubset.

void asdmbinaries::SDMDataSubset::toXML ( std::ostringstream &  oss) const
std::string asdmbinaries::SDMDataSubset::toXML ( )

Returns an XML representation of this SDMDataSubset.

void asdmbinaries::SDMDataSubset::tpBinAttachToXML ( std::ostringstream &  oss)
std::string asdmbinaries::SDMDataSubset::xsiType ( ) const
private
unsigned long int asdmbinaries::SDMDataSubset::zeroLags ( const ZEROLAGSTYPE *&  ptr) const

Set ptr to the adress of the array of ZeroLags and returns the number of ZeroLags.

Parameters
ptra reference to a pointer on float.
Returns
the number of autoData.
uint64_t asdmbinaries::SDMDataSubset::zeroLagsPosition ( ) const

Returns the position (0-based, relative to the beginning of the file) of this part when it has been read in a file.

Has no meaning otherwise.

Friends And Related Function Documentation

friend class CorrSubsetHeaderParser
friend

Definition at line 1273 of file SDMDataObject.h.

friend class SDMDataObject
friend

Definition at line 1269 of file SDMDataObject.h.

friend class SDMDataObjectReader
friend

Definition at line 1270 of file SDMDataObject.h.

friend class SDMDataObjectStreamReader
friend

Definition at line 1271 of file SDMDataObject.h.

friend class SDMDataObjectWriter
friend

Definition at line 1272 of file SDMDataObject.h.

friend class TPSubsetHeaderParser
friend

Definition at line 1274 of file SDMDataObject.h.

Member Data Documentation

bool asdmbinaries::SDMDataSubset::aborted_
private

Definition at line 1545 of file SDMDataObject.h.

std::string asdmbinaries::SDMDataSubset::abortReason_
private

Definition at line 1547 of file SDMDataObject.h.

unsigned long long int asdmbinaries::SDMDataSubset::abortTime_
private

Definition at line 1546 of file SDMDataObject.h.

const ACTUALDURATIONSTYPE* asdmbinaries::SDMDataSubset::actualDurations_
private

Definition at line 1525 of file SDMDataObject.h.

uint64_t asdmbinaries::SDMDataSubset::actualDurationsPosition_
private

Definition at line 1527 of file SDMDataObject.h.

std::string asdmbinaries::SDMDataSubset::actualDurationsREF_
private

Definition at line 1516 of file SDMDataObject.h.

const ACTUALTIMESTYPE* asdmbinaries::SDMDataSubset::actualTimes_
private

Definition at line 1522 of file SDMDataObject.h.

uint64_t asdmbinaries::SDMDataSubset::actualTimesPosition_
private

Definition at line 1524 of file SDMDataObject.h.

std::string asdmbinaries::SDMDataSubset::actualTimesREF_
private

Definition at line 1515 of file SDMDataObject.h.

const AUTODATATYPE* asdmbinaries::SDMDataSubset::autoData_
private

Definition at line 1539 of file SDMDataObject.h.

uint64_t asdmbinaries::SDMDataSubset::autoDataPosition_
private

Definition at line 1541 of file SDMDataObject.h.

std::string asdmbinaries::SDMDataSubset::autoDataREF_
private

Definition at line 1520 of file SDMDataObject.h.

uint64_t asdmbinaries::SDMDataSubset::crossDataPosition_
private

Definition at line 1538 of file SDMDataObject.h.

std::string asdmbinaries::SDMDataSubset::crossDataREF_
private

Definition at line 1518 of file SDMDataObject.h.

PrimitiveDataTypeMod::PrimitiveDataType asdmbinaries::SDMDataSubset::crossDataType_
private

Definition at line 1519 of file SDMDataObject.h.

std::string asdmbinaries::SDMDataSubset::dataStruct_
private

Definition at line 1513 of file SDMDataObject.h.

const FLAGSTYPE* asdmbinaries::SDMDataSubset::flags_
private

Definition at line 1531 of file SDMDataObject.h.

uint64_t asdmbinaries::SDMDataSubset::flagsPosition_
private

Definition at line 1533 of file SDMDataObject.h.

std::string asdmbinaries::SDMDataSubset::flagsREF_
private

Definition at line 1514 of file SDMDataObject.h.

const FLOATCROSSDATATYPE* asdmbinaries::SDMDataSubset::floatCrossData_
private

Definition at line 1536 of file SDMDataObject.h.

unsigned int asdmbinaries::SDMDataSubset::integrationNum_
private

Definition at line 1508 of file SDMDataObject.h.

unsigned long long asdmbinaries::SDMDataSubset::interval_
private

Definition at line 1512 of file SDMDataObject.h.

const INTCROSSDATATYPE* asdmbinaries::SDMDataSubset::longCrossData_
private

Definition at line 1534 of file SDMDataObject.h.

unsigned long int asdmbinaries::SDMDataSubset::nActualDurations_
private

Definition at line 1526 of file SDMDataObject.h.

unsigned long int asdmbinaries::SDMDataSubset::nActualTimes_
private

Definition at line 1523 of file SDMDataObject.h.

unsigned long int asdmbinaries::SDMDataSubset::nAutoData_
private

Definition at line 1540 of file SDMDataObject.h.

unsigned long int asdmbinaries::SDMDataSubset::nCrossData_
private

Definition at line 1537 of file SDMDataObject.h.

unsigned long int asdmbinaries::SDMDataSubset::nFlags_
private

Definition at line 1532 of file SDMDataObject.h.

unsigned long int asdmbinaries::SDMDataSubset::nZeroLags_
private

Definition at line 1529 of file SDMDataObject.h.

SDMDataObject* asdmbinaries::SDMDataSubset::owner_
private

Definition at line 1507 of file SDMDataObject.h.

CorrelationModeMod::CorrelationMode asdmbinaries::SDMDataSubset::ref_
private

Definition at line 1510 of file SDMDataObject.h.

const SHORTCROSSDATATYPE* asdmbinaries::SDMDataSubset::shortCrossData_
private

Definition at line 1535 of file SDMDataObject.h.

unsigned int asdmbinaries::SDMDataSubset::subintegrationNum_
private

Definition at line 1509 of file SDMDataObject.h.

unsigned long long asdmbinaries::SDMDataSubset::time_
private

Definition at line 1511 of file SDMDataObject.h.

const ZEROLAGSTYPE* asdmbinaries::SDMDataSubset::zeroLags_
private

Definition at line 1528 of file SDMDataObject.h.

uint64_t asdmbinaries::SDMDataSubset::zeroLagsPosition_
private

Definition at line 1530 of file SDMDataObject.h.

std::string asdmbinaries::SDMDataSubset::zeroLagsREF_
private

Definition at line 1517 of file SDMDataObject.h.


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