The PulsarRow class is a row of a PulsarTable. More...

#include <PulsarRow.h>

Public Member Functions
virtual	~PulsarRow ()
	friend class asdm::TableStreamReader<PulsarTable, PulsarRow>; More...

PulsarTable &	getTable () const
	Return the table to which this row belongs. More...

bool	isAdded () const
	Has this row been added to its table ? More...

ArrayTime	getRefTime () const
	===> Attribute refTime More...

void	setRefTime (ArrayTime refTime)
	Set refTime with the specified ArrayTime. More...

Frequency	getRefPulseFreq () const
	===> Attribute refPulseFreq More...

void	setRefPulseFreq (Frequency refPulseFreq)
	Set refPulseFreq with the specified Frequency. More...

double	getRefPhase () const
	===> Attribute refPhase More...

void	setRefPhase (double refPhase)
	Set refPhase with the specified double. More...

int	getNumBin () const
	===> Attribute numBin More...

void	setNumBin (int numBin)
	Set numBin with the specified int. More...

bool	isNumPolyExists () const
	===> Attribute numPoly, which is optional More...

int	getNumPoly () const
	Get numPoly, which is optional. More...

void	setNumPoly (int numPoly)
	Set numPoly with the specified int. More...

void	clearNumPoly ()
	Mark numPoly, which is an optional field, as non-existent. More...

bool	isPhasePolyExists () const
	===> Attribute phasePoly, which is optional More...

std::vector< double >	getPhasePoly () const
	Get phasePoly, which is optional. More...

void	setPhasePoly (std::vector< double > phasePoly)
	Set phasePoly with the specified std::vector<double >. More...

void	clearPhasePoly ()
	Mark phasePoly, which is an optional field, as non-existent. More...

bool	isTimeSpanExists () const
	===> Attribute timeSpan, which is optional More...

Interval	getTimeSpan () const
	Get timeSpan, which is optional. More...

void	setTimeSpan (Interval timeSpan)
	Set timeSpan with the specified Interval. More...

void	clearTimeSpan ()
	Mark timeSpan, which is an optional field, as non-existent. More...

bool	isStartPhaseBinExists () const
	===> Attribute startPhaseBin, which is optional More...

std::vector< float >	getStartPhaseBin () const
	Get startPhaseBin, which is optional. More...

void	setStartPhaseBin (std::vector< float > startPhaseBin)
	Set startPhaseBin with the specified std::vector<float >. More...

void	clearStartPhaseBin ()
	Mark startPhaseBin, which is an optional field, as non-existent. More...

bool	isEndPhaseBinExists () const
	===> Attribute endPhaseBin, which is optional More...

std::vector< float >	getEndPhaseBin () const
	Get endPhaseBin, which is optional. More...

void	setEndPhaseBin (std::vector< float > endPhaseBin)
	Set endPhaseBin with the specified std::vector<float >. More...

void	clearEndPhaseBin ()
	Mark endPhaseBin, which is an optional field, as non-existent. More...

bool	isDispersionMeasureExists () const
	===> Attribute dispersionMeasure, which is optional More...

double	getDispersionMeasure () const
	Get dispersionMeasure, which is optional. More...

void	setDispersionMeasure (double dispersionMeasure)
	Set dispersionMeasure with the specified double. More...

void	clearDispersionMeasure ()
	Mark dispersionMeasure, which is an optional field, as non-existent. More...

bool	isRefFrequencyExists () const
	===> Attribute refFrequency, which is optional More...

Frequency	getRefFrequency () const
	Get refFrequency, which is optional. More...

void	setRefFrequency (Frequency refFrequency)
	Set refFrequency with the specified Frequency. More...

void	clearRefFrequency ()
	Mark refFrequency, which is an optional field, as non-existent. More...

Extrinsic Table Attributes Links *bool	compareNoAutoInc (ArrayTime refTime, Frequency refPulseFreq, double refPhase, int numBin)
	Compare each mandatory attribute except the autoincrementable one of this PulsarRow with the corresponding parameters and return true if there is a match and false otherwise. More...

bool	compareRequiredValue (ArrayTime refTime, Frequency refPulseFreq, double refPhase, int numBin)
	Compare each mandatory value (i.e. More...

bool	equalByRequiredValue (PulsarRow *x)
	Return true if all required attributes of the value part are equal to their homologues in x and false otherwise. More...

asdmIDL::PulsarRowIDL *	toIDL () const
	Return this row in the form of an IDL struct. More...

void	toIDL (asdmIDL::PulsarRowIDL &x) const
	Define the content of a PulsarRowIDL struct from the values found in this row. More...

void	setFromIDL (asdmIDL::PulsarRowIDL x)
	Fill the values of this row from the IDL struct PulsarRowIDL. More...

std::string	toXML () const
	Return this row in the form of an XML string. More...

void	setFromXML (std::string rowDoc)
	Fill the values of this row from an XML string that was produced by the toXML() method. More...

Public Attributes
Intrinsic Table	Attributes

Private Member Functions
void	isAdded (bool added)
	This method is used by the Table class when this row is added to the table. More...

	PulsarRow (PulsarTable &table)
	Create a PulsarRow. More...

	PulsarRow (PulsarTable &table, PulsarRow *row)
	Create a PulsarRow using a copy constructor mechanism. More...

void	setPulsarId (Tag pulsarId)
	Set pulsarId with the specified Tag value. More...

void	pulsarIdFromBin (EndianIStream &eis)

void	refTimeFromBin (EndianIStream &eis)

void	refPulseFreqFromBin (EndianIStream &eis)

void	refPhaseFromBin (EndianIStream &eis)

void	numBinFromBin (EndianIStream &eis)

void	numPolyFromBin (EndianIStream &eis)

void	phasePolyFromBin (EndianIStream &eis)

void	timeSpanFromBin (EndianIStream &eis)

void	startPhaseBinFromBin (EndianIStream &eis)

void	endPhaseBinFromBin (EndianIStream &eis)

void	dispersionMeasureFromBin (EndianIStream &eis)

void	refFrequencyFromBin (EndianIStream &eis)

void	pulsarIdFromText (const std::string &s)

void	refTimeFromText (const std::string &s)

void	refPulseFreqFromText (const std::string &s)

void	refPhaseFromText (const std::string &s)

void	numBinFromText (const std::string &s)

void	numPolyFromText (const std::string &s)

void	phasePolyFromText (const std::string &s)

void	timeSpanFromText (const std::string &s)

void	startPhaseBinFromText (const std::string &s)

void	endPhaseBinFromText (const std::string &s)

void	dispersionMeasureFromText (const std::string &s)

void	refFrequencyFromText (const std::string &s)

void	toBin (EndianOSStream &eoss)
	Serialize this into a stream of bytes written to an EndianOSStream. More...

Private Attributes
PulsarTable &	table
	The table to which this row belongs. More...

bool	hasBeenAdded
	Whether this row has been added to the table or not. More...

ArrayTime	refTime
	===> Attribute refTime More...

Frequency	refPulseFreq
	===> Attribute refPulseFreq More...

double	refPhase
	===> Attribute refPhase More...

int	numBin
	===> Attribute numBin More...

bool	numPolyExists
	===> Attribute numPoly, which is optional More...

int	numPoly

bool	phasePolyExists
	===> Attribute phasePoly, which is optional More...

std::vector< double >	phasePoly

bool	timeSpanExists
	===> Attribute timeSpan, which is optional More...

Interval	timeSpan

bool	startPhaseBinExists
	===> Attribute startPhaseBin, which is optional More...

std::vector< float >	startPhaseBin

bool	endPhaseBinExists
	===> Attribute endPhaseBin, which is optional More...

std::vector< float >	endPhaseBin

bool	dispersionMeasureExists
	===> Attribute dispersionMeasure, which is optional More...

double	dispersionMeasure

bool	refFrequencyExists
	===> Attribute refFrequency, which is optional More...

Frequency	refFrequency

Extrinsic Table Attributes Links *binary deserialization material from an EndianIStream std::map< std::string, PulsarAttributeFromBin >	fromBinMethods

*text deserialization material std::map< std::string, PulsarAttributeFromText >	fromTextMethods

Friends
class	asdm::PulsarTable

class	asdm::RowTransformer< PulsarRow >

Detailed Description

The PulsarRow class is a row of a PulsarTable.

Generated from model's revision "-1", branch ""

Definition at line 122 of file PulsarRow.h.

Constructor & Destructor Documentation

virtual asdm::PulsarRow::~PulsarRow ( )

virtual

friend class asdm::TableStreamReader<PulsarTable, PulsarRow>;

asdm::PulsarRow::PulsarRow ( PulsarTable & table )

private

Create a PulsarRow.

This constructor is private because only the table can create rows. All rows know the table to which they belong.

Parameters

table The table to which this row belongs.

asdm::PulsarRow::PulsarRow	(	PulsarTable &	table,
		PulsarRow *	row
	)

private

Create a PulsarRow using a copy constructor mechanism.

Given a PulsarRow row and a PulsarTable table, the method creates a new PulsarRow owned by table. Each attribute of the created row is a copy (deep) of the corresponding attribute of row. The method does not add the created row to its table, its simply parents it to table, a call to the add method has to be done in order to get the row added (very likely after having modified some of its attributes). If row is null then the method returns a row with default values for its attributes.

This constructor is private because only the table can create rows. All rows know the table to which they belong.

Parameters

table	The table to which this row belongs.
row	The row which is to be copied.

Member Function Documentation

void asdm::PulsarRow::clearDispersionMeasure ( )

Mark dispersionMeasure, which is an optional field, as non-existent.

void asdm::PulsarRow::clearEndPhaseBin ( )

Mark endPhaseBin, which is an optional field, as non-existent.

void asdm::PulsarRow::clearNumPoly ( )

Mark numPoly, which is an optional field, as non-existent.

void asdm::PulsarRow::clearPhasePoly ( )

Mark phasePoly, which is an optional field, as non-existent.

void asdm::PulsarRow::clearRefFrequency ( )

Mark refFrequency, which is an optional field, as non-existent.

void asdm::PulsarRow::clearStartPhaseBin ( )

Mark startPhaseBin, which is an optional field, as non-existent.

void asdm::PulsarRow::clearTimeSpan ( )

Mark timeSpan, which is an optional field, as non-existent.

Extrinsic Table Attributes Links* bool asdm::PulsarRow::compareNoAutoInc	(	ArrayTime	refTime,
		Frequency	refPulseFreq,
		double	refPhase,
		int	numBin
	)

Compare each mandatory attribute except the autoincrementable one of this PulsarRow with the corresponding parameters and return true if there is a match and false otherwise.

Parameters

refTime
refPulseFreq
refPhase
numBin

bool asdm::PulsarRow::compareRequiredValue	(	ArrayTime	refTime,
		Frequency	refPulseFreq,
		double	refPhase,
		int	numBin
	)

Compare each mandatory value (i.e.

not in the key) attribute with the corresponding parameters and return true if there is a match and false otherwise.

Parameters

refTime
refPulseFreq
refPhase
numBin

void asdm::PulsarRow::dispersionMeasureFromBin ( EndianIStream & eis )

private

void asdm::PulsarRow::dispersionMeasureFromText ( const std::string & s )

private

void asdm::PulsarRow::endPhaseBinFromBin ( EndianIStream & eis )

private

void asdm::PulsarRow::endPhaseBinFromText ( const std::string & s )

private

bool asdm::PulsarRow::equalByRequiredValue ( PulsarRow * x )

Return true if all required attributes of the value part are equal to their homologues in x and false otherwise.

Parameters

x	a pointer on the PulsarRow whose required attributes of the value part will be compared with those of this.

Returns: a boolean.

double asdm::PulsarRow::getDispersionMeasure ( ) const

Get dispersionMeasure, which is optional.

Returns: dispersionMeasure as double

Exceptions

IllegalAccessException If dispersionMeasure does not exist.

std::vector<float > asdm::PulsarRow::getEndPhaseBin ( ) const

Get endPhaseBin, which is optional.

Returns: endPhaseBin as std::vector<float >

Exceptions

IllegalAccessException If endPhaseBin does not exist.

int asdm::PulsarRow::getNumBin ( ) const

===> Attribute numBin

Get numBin.

Returns: numBin as int

int asdm::PulsarRow::getNumPoly ( ) const

Get numPoly, which is optional.

Returns: numPoly as int

Exceptions

IllegalAccessException If numPoly does not exist.

std::vector<double > asdm::PulsarRow::getPhasePoly ( ) const

Get phasePoly, which is optional.

Returns: phasePoly as std::vector<double >

Exceptions

IllegalAccessException If phasePoly does not exist.

Frequency asdm::PulsarRow::getRefFrequency ( ) const

Get refFrequency, which is optional.

Returns: refFrequency as Frequency

Exceptions

IllegalAccessException If refFrequency does not exist.

double asdm::PulsarRow::getRefPhase ( ) const

===> Attribute refPhase

Get refPhase.

Returns: refPhase as double

Frequency asdm::PulsarRow::getRefPulseFreq ( ) const

===> Attribute refPulseFreq

Get refPulseFreq.

Returns: refPulseFreq as Frequency

ArrayTime asdm::PulsarRow::getRefTime ( ) const

===> Attribute refTime

Get refTime.

Returns: refTime as ArrayTime

std::vector<float > asdm::PulsarRow::getStartPhaseBin ( ) const

Get startPhaseBin, which is optional.

Returns: startPhaseBin as std::vector<float >

Exceptions

IllegalAccessException If startPhaseBin does not exist.

PulsarTable& asdm::PulsarRow::getTable ( ) const

Return the table to which this row belongs.

Interval asdm::PulsarRow::getTimeSpan ( ) const

Get timeSpan, which is optional.

Returns: timeSpan as Interval

Exceptions

IllegalAccessException If timeSpan does not exist.

bool asdm::PulsarRow::isAdded ( ) const

Has this row been added to its table ?

Returns: true if and only if it has been added.

void asdm::PulsarRow::isAdded ( bool added )

private

This method is used by the Table class when this row is added to the table.

bool asdm::PulsarRow::isDispersionMeasureExists ( ) const

===> Attribute dispersionMeasure, which is optional

The attribute dispersionMeasure is optional. Return true if this attribute exists.

Returns: true if and only if the dispersionMeasure attribute exists.

bool asdm::PulsarRow::isEndPhaseBinExists ( ) const

===> Attribute endPhaseBin, which is optional

The attribute endPhaseBin is optional. Return true if this attribute exists.

Returns: true if and only if the endPhaseBin attribute exists.

bool asdm::PulsarRow::isNumPolyExists ( ) const

===> Attribute numPoly, which is optional

The attribute numPoly is optional. Return true if this attribute exists.

Returns: true if and only if the numPoly attribute exists.

bool asdm::PulsarRow::isPhasePolyExists ( ) const

===> Attribute phasePoly, which is optional

The attribute phasePoly is optional. Return true if this attribute exists.

Returns: true if and only if the phasePoly attribute exists.

bool asdm::PulsarRow::isRefFrequencyExists ( ) const

===> Attribute refFrequency, which is optional

The attribute refFrequency is optional. Return true if this attribute exists.

Returns: true if and only if the refFrequency attribute exists.

bool asdm::PulsarRow::isStartPhaseBinExists ( ) const

===> Attribute startPhaseBin, which is optional

The attribute startPhaseBin is optional. Return true if this attribute exists.

Returns: true if and only if the startPhaseBin attribute exists.

bool asdm::PulsarRow::isTimeSpanExists ( ) const

===> Attribute timeSpan, which is optional

The attribute timeSpan is optional. Return true if this attribute exists.

Returns: true if and only if the timeSpan attribute exists.

void asdm::PulsarRow::numBinFromBin ( EndianIStream & eis )

private

void asdm::PulsarRow::numBinFromText ( const std::string & s )

private

void asdm::PulsarRow::numPolyFromBin ( EndianIStream & eis )

private

void asdm::PulsarRow::numPolyFromText ( const std::string & s )

private

void asdm::PulsarRow::phasePolyFromBin ( EndianIStream & eis )

private

void asdm::PulsarRow::phasePolyFromText ( const std::string & s )

private

void asdm::PulsarRow::pulsarIdFromBin ( EndianIStream & eis )

private

void asdm::PulsarRow::pulsarIdFromText ( const std::string & s )

private

void asdm::PulsarRow::refFrequencyFromBin ( EndianIStream & eis )

private

void asdm::PulsarRow::refFrequencyFromText ( const std::string & s )

private

void asdm::PulsarRow::refPhaseFromBin ( EndianIStream & eis )

private

void asdm::PulsarRow::refPhaseFromText ( const std::string & s )

private

void asdm::PulsarRow::refPulseFreqFromBin ( EndianIStream & eis )

private

void asdm::PulsarRow::refPulseFreqFromText ( const std::string & s )

private

void asdm::PulsarRow::refTimeFromBin ( EndianIStream & eis )

private

void asdm::PulsarRow::refTimeFromText ( const std::string & s )

private

void asdm::PulsarRow::setDispersionMeasure ( double dispersionMeasure )

Set dispersionMeasure with the specified double.

Parameters

dispersionMeasure The double value to which dispersionMeasure is to be set.

void asdm::PulsarRow::setEndPhaseBin ( std::vector< float > endPhaseBin )

Set endPhaseBin with the specified std::vector<float >.

Parameters

endPhaseBin The std::vector<float > value to which endPhaseBin is to be set.

void asdm::PulsarRow::setFromIDL ( asdmIDL::PulsarRowIDL x )

Fill the values of this row from the IDL struct PulsarRowIDL.

Parameters

x	The IDL struct containing the values used to fill this row.

Exceptions

ConversionException

void asdm::PulsarRow::setFromXML ( std::string rowDoc )

Fill the values of this row from an XML string that was produced by the toXML() method.

Parameters

rowDoc the XML string being used to set the values of this row.

Exceptions

ConversionException

void asdm::PulsarRow::setNumBin ( int numBin )

Set numBin with the specified int.

Parameters

numBin The int value to which numBin is to be set.

void asdm::PulsarRow::setNumPoly ( int numPoly )

Set numPoly with the specified int.

Parameters

numPoly The int value to which numPoly is to be set.

void asdm::PulsarRow::setPhasePoly ( std::vector< double > phasePoly )

Set phasePoly with the specified std::vector<double >.

Parameters

phasePoly The std::vector<double > value to which phasePoly is to be set.

void asdm::PulsarRow::setPulsarId ( Tag pulsarId )

private

Set pulsarId with the specified Tag value.

Parameters

pulsarId The Tag value to which pulsarId is to be set.

Exceptions

IllegalAccessException If an attempt is made to change this field after is has been added to the table.

void asdm::PulsarRow::setRefFrequency ( Frequency refFrequency )

Set refFrequency with the specified Frequency.

Parameters

refFrequency The Frequency value to which refFrequency is to be set.

void asdm::PulsarRow::setRefPhase ( double refPhase )

Set refPhase with the specified double.

Parameters

refPhase The double value to which refPhase is to be set.

void asdm::PulsarRow::setRefPulseFreq ( Frequency refPulseFreq )

Set refPulseFreq with the specified Frequency.

Parameters

refPulseFreq The Frequency value to which refPulseFreq is to be set.

void asdm::PulsarRow::setRefTime ( ArrayTime refTime )

Set refTime with the specified ArrayTime.

Parameters

refTime The ArrayTime value to which refTime is to be set.

void asdm::PulsarRow::setStartPhaseBin ( std::vector< float > startPhaseBin )

Set startPhaseBin with the specified std::vector<float >.

Parameters

startPhaseBin The std::vector<float > value to which startPhaseBin is to be set.

void asdm::PulsarRow::setTimeSpan ( Interval timeSpan )

Set timeSpan with the specified Interval.

Parameters

timeSpan The Interval value to which timeSpan is to be set.

void asdm::PulsarRow::startPhaseBinFromBin ( EndianIStream & eis )

private

void asdm::PulsarRow::startPhaseBinFromText ( const std::string & s )

private

void asdm::PulsarRow::timeSpanFromBin ( EndianIStream & eis )

private

void asdm::PulsarRow::timeSpanFromText ( const std::string & s )

private

void asdm::PulsarRow::toBin ( EndianOSStream & eoss )

private

Serialize this into a stream of bytes written to an EndianOSStream.

Parameters

eoss	the EndianOSStream to be written to

asdmIDL::PulsarRowIDL* asdm::PulsarRow::toIDL ( ) const

Return this row in the form of an IDL struct.

Returns: The values of this row as a PulsarRowIDL struct.

void asdm::PulsarRow::toIDL ( asdmIDL::PulsarRowIDL & x ) const

Define the content of a PulsarRowIDL struct from the values found in this row.

Parameters

x	a reference to the PulsarRowIDL struct to be set.

std::string asdm::PulsarRow::toXML ( ) const

Return this row in the form of an XML string.

Returns: The values of this row as an XML string.

Friends And Related Function Documentation

friend class asdm::PulsarTable

friend

Definition at line 123 of file PulsarRow.h.

friend class asdm::RowTransformer< PulsarRow >

friend

Definition at line 124 of file PulsarRow.h.

Member Data Documentation

Intrinsic Table asdm::PulsarRow::Attributes

Definition at line 147 of file PulsarRow.h.

double asdm::PulsarRow::dispersionMeasure

private

Definition at line 893 of file PulsarRow.h.

bool asdm::PulsarRow::dispersionMeasureExists

private

===> Attribute dispersionMeasure, which is optional

Definition at line 890 of file PulsarRow.h.

std::vector<float > asdm::PulsarRow::endPhaseBin

private

Definition at line 880 of file PulsarRow.h.

bool asdm::PulsarRow::endPhaseBinExists

private

===> Attribute endPhaseBin, which is optional

Definition at line 877 of file PulsarRow.h.

Extrinsic Table Attributes Links* binary deserialization material from an EndianIStream std::map<std::string, PulsarAttributeFromBin> asdm::PulsarRow::fromBinMethods

private

Definition at line 925 of file PulsarRow.h.

* text deserialization material std::map<std::string, PulsarAttributeFromText> asdm::PulsarRow::fromTextMethods

private

Definition at line 945 of file PulsarRow.h.

bool asdm::PulsarRow::hasBeenAdded

private

Whether this row has been added to the table or not.

Definition at line 715 of file PulsarRow.h.

int asdm::PulsarRow::numBin

private

===> Attribute numBin

Definition at line 815 of file PulsarRow.h.

int asdm::PulsarRow::numPoly

private

Definition at line 828 of file PulsarRow.h.

bool asdm::PulsarRow::numPolyExists

private

===> Attribute numPoly, which is optional

Definition at line 825 of file PulsarRow.h.

std::vector<double > asdm::PulsarRow::phasePoly

private

Definition at line 841 of file PulsarRow.h.

bool asdm::PulsarRow::phasePolyExists

private

===> Attribute phasePoly, which is optional

Definition at line 838 of file PulsarRow.h.

Frequency asdm::PulsarRow::refFrequency

private

Definition at line 906 of file PulsarRow.h.

bool asdm::PulsarRow::refFrequencyExists

private

===> Attribute refFrequency, which is optional

Definition at line 903 of file PulsarRow.h.

double asdm::PulsarRow::refPhase

private

===> Attribute refPhase

Definition at line 804 of file PulsarRow.h.

Frequency asdm::PulsarRow::refPulseFreq

private

===> Attribute refPulseFreq

Definition at line 793 of file PulsarRow.h.

ArrayTime asdm::PulsarRow::refTime

private

===> Attribute refTime

Definition at line 782 of file PulsarRow.h.

std::vector<float > asdm::PulsarRow::startPhaseBin

private

Definition at line 867 of file PulsarRow.h.

bool asdm::PulsarRow::startPhaseBinExists

private

===> Attribute startPhaseBin, which is optional

Definition at line 864 of file PulsarRow.h.

PulsarTable& asdm::PulsarRow::table

private

The table to which this row belongs.

Definition at line 711 of file PulsarRow.h.

Interval asdm::PulsarRow::timeSpan

private

Definition at line 854 of file PulsarRow.h.

bool asdm::PulsarRow::timeSpanExists

private

===> Attribute timeSpan, which is optional

Definition at line 851 of file PulsarRow.h.

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

casa/code/alma/ASDM/PulsarRow.h

Public Member Functions

Public Attributes

Private Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation