The CalGainRow class is a row of a CalGainTable. More...

#include <CalGainRow.h>

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

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

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

void	setStartValidTime (ArrayTime startValidTime)
	Set startValidTime with the specified ArrayTime. More...

ArrayTime	getEndValidTime () const
	===> Attribute endValidTime More...

void	setEndValidTime (ArrayTime endValidTime)
	Set endValidTime with the specified ArrayTime. More...

float	getGain () const
	===> Attribute gain More...

void	setGain (float gain)
	Set gain with the specified float. More...

bool	getGainValid () const
	===> Attribute gainValid More...

void	setGainValid (bool gainValid)
	Set gainValid with the specified bool. More...

float	getFit () const
	===> Attribute fit More...

void	setFit (float fit)
	Set fit with the specified float. More...

float	getFitWeight () const
	===> Attribute fitWeight More...

void	setFitWeight (float fitWeight)
	Set fitWeight with the specified float. More...

bool	getTotalGainValid () const
	===> Attribute totalGainValid More...

void	setTotalGainValid (bool totalGainValid)
	Set totalGainValid with the specified bool. More...

float	getTotalFit () const
	===> Attribute totalFit More...

void	setTotalFit (float totalFit)
	Set totalFit with the specified float. More...

float	getTotalFitWeight () const
	===> Attribute totalFitWeight More...

void	setTotalFitWeight (float totalFitWeight)
	Set totalFitWeight with the specified float. More...

void	setCalDataId (Tag calDataId)
	Set calDataId with the specified Tag. More...

Tag	getCalReductionId () const
	===> Attribute calReductionId More...

void	setCalReductionId (Tag calReductionId)
	Set calReductionId with the specified Tag. More...

Links CalReductionRow	getCalReductionUsingCalReductionId ()
	calReductionId pointer to the row in the CalReduction table having CalReduction.calReductionId == calReductionId More...

CalDataRow *	getCalDataUsingCalDataId ()
	calDataId pointer to the row in the CalData table having CalData.calDataId == calDataId More...

bool	compareNoAutoInc (Tag calDataId, Tag calReductionId, ArrayTime startValidTime, ArrayTime endValidTime, float gain, bool gainValid, float fit, float fitWeight, bool totalGainValid, float totalFit, float totalFitWeight)
	Compare each mandatory attribute except the autoincrementable one of this CalGainRow with the corresponding parameters and return true if there is a match and false otherwise. More...

bool	compareRequiredValue (ArrayTime startValidTime, ArrayTime endValidTime, float gain, bool gainValid, float fit, float fitWeight, bool totalGainValid, float totalFit, float totalFitWeight)
	Compare each mandatory value (i.e. More...

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

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

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

void	setFromIDL (asdmIDL::CalGainRowIDL x)
	Fill the values of this row from the IDL struct CalGainRowIDL. 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

Extrinsic 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...

	CalGainRow (CalGainTable &table)
	Create a CalGainRow. More...

	CalGainRow (CalGainTable &table, CalGainRow *row)
	Create a CalGainRow using a copy constructor mechanism. More...

void	calDataIdFromBin (EndianIStream &eis)

void	calReductionIdFromBin (EndianIStream &eis)

void	startValidTimeFromBin (EndianIStream &eis)

void	endValidTimeFromBin (EndianIStream &eis)

void	gainFromBin (EndianIStream &eis)

void	gainValidFromBin (EndianIStream &eis)

void	fitFromBin (EndianIStream &eis)

void	fitWeightFromBin (EndianIStream &eis)

void	totalGainValidFromBin (EndianIStream &eis)

void	totalFitFromBin (EndianIStream &eis)

void	totalFitWeightFromBin (EndianIStream &eis)

void	calDataIdFromText (const std::string &s)

void	calReductionIdFromText (const std::string &s)

void	startValidTimeFromText (const std::string &s)

void	endValidTimeFromText (const std::string &s)

void	gainFromText (const std::string &s)

void	gainValidFromText (const std::string &s)

void	fitFromText (const std::string &s)

void	fitWeightFromText (const std::string &s)

void	totalGainValidFromText (const std::string &s)

void	totalFitFromText (const std::string &s)

void	totalFitWeightFromText (const std::string &s)

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

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

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

ArrayTime	endValidTime
	===> Attribute endValidTime More...

float	gain
	===> Attribute gain More...

bool	gainValid
	===> Attribute gainValid More...

float	fit
	===> Attribute fit More...

float	fitWeight
	===> Attribute fitWeight More...

bool	totalGainValid
	===> Attribute totalGainValid More...

float	totalFit
	===> Attribute totalFit More...

float	totalFitWeight
	===> Attribute totalFitWeight More...

Tag	calReductionId
	===> Attribute calReductionId More...

Links *binary deserialization material from an EndianIStream std::map< std::string, CalGainAttributeFromBin >	fromBinMethods

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

Friends
class	asdm::CalGainTable

class	asdm::RowTransformer< CalGainRow >

Detailed Description

The CalGainRow class is a row of a CalGainTable.

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

Definition at line 114 of file CalGainRow.h.

Constructor & Destructor Documentation

virtual asdm::CalGainRow::~CalGainRow ( )

virtual

friend class asdm::TableStreamReader<CalGainTable, CalGainRow>;

asdm::CalGainRow::CalGainRow ( CalGainTable & table )

private

Create a CalGainRow.

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::CalGainRow::CalGainRow	(	CalGainTable &	table,
		CalGainRow *	row
	)

private

Create a CalGainRow using a copy constructor mechanism.

Given a CalGainRow row and a CalGainTable table, the method creates a new CalGainRow 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::CalGainRow::calDataIdFromBin ( EndianIStream & eis )

private

void asdm::CalGainRow::calDataIdFromText ( const std::string & s )

private

void asdm::CalGainRow::calReductionIdFromBin ( EndianIStream & eis )

private

void asdm::CalGainRow::calReductionIdFromText ( const std::string & s )

private

bool asdm::CalGainRow::compareNoAutoInc	(	Tag	calDataId,
		Tag	calReductionId,
		ArrayTime	startValidTime,
		ArrayTime	endValidTime,
		float	gain,
		bool	gainValid,
		float	fit,
		float	fitWeight,
		bool	totalGainValid,
		float	totalFit,
		float	totalFitWeight
	)

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

Parameters

calDataId
calReductionId
startValidTime
endValidTime
gain
gainValid
fit
fitWeight
totalGainValid
totalFit
totalFitWeight

bool asdm::CalGainRow::compareRequiredValue	(	ArrayTime	startValidTime,
		ArrayTime	endValidTime,
		float	gain,
		bool	gainValid,
		float	fit,
		float	fitWeight,
		bool	totalGainValid,
		float	totalFit,
		float	totalFitWeight
	)

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

startValidTime
endValidTime
gain
gainValid
fit
fitWeight
totalGainValid
totalFit
totalFitWeight

void asdm::CalGainRow::endValidTimeFromBin ( EndianIStream & eis )

private

void asdm::CalGainRow::endValidTimeFromText ( const std::string & s )

private

bool asdm::CalGainRow::equalByRequiredValue ( CalGainRow * 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 CalGainRow whose required attributes of the value part will be compared with those of this.

Returns: a boolean.

void asdm::CalGainRow::fitFromBin ( EndianIStream & eis )

private

void asdm::CalGainRow::fitFromText ( const std::string & s )

private

void asdm::CalGainRow::fitWeightFromBin ( EndianIStream & eis )

private

void asdm::CalGainRow::fitWeightFromText ( const std::string & s )

private

void asdm::CalGainRow::gainFromBin ( EndianIStream & eis )

private

void asdm::CalGainRow::gainFromText ( const std::string & s )

private

void asdm::CalGainRow::gainValidFromBin ( EndianIStream & eis )

private

void asdm::CalGainRow::gainValidFromText ( const std::string & s )

private

CalDataRow* asdm::CalGainRow::getCalDataUsingCalDataId ( )

calDataId pointer to the row in the CalData table having CalData.calDataId == calDataId

Returns: a CalDataRow*

Tag asdm::CalGainRow::getCalReductionId ( ) const

===> Attribute calReductionId

Get calReductionId.

Returns: calReductionId as Tag

Links* CalReductionRow* asdm::CalGainRow::getCalReductionUsingCalReductionId ( )

calReductionId pointer to the row in the CalReduction table having CalReduction.calReductionId == calReductionId

Returns: a CalReductionRow*

ArrayTime asdm::CalGainRow::getEndValidTime ( ) const

===> Attribute endValidTime

Get endValidTime.

Returns: endValidTime as ArrayTime

float asdm::CalGainRow::getFit ( ) const

===> Attribute fit

Get fit.

Returns: fit as float

float asdm::CalGainRow::getFitWeight ( ) const

===> Attribute fitWeight

Get fitWeight.

Returns: fitWeight as float

float asdm::CalGainRow::getGain ( ) const

===> Attribute gain

Get gain.

Returns: gain as float

bool asdm::CalGainRow::getGainValid ( ) const

===> Attribute gainValid

Get gainValid.

Returns: gainValid as bool

CalGainTable& asdm::CalGainRow::getTable ( ) const

Return the table to which this row belongs.

float asdm::CalGainRow::getTotalFit ( ) const

===> Attribute totalFit

Get totalFit.

Returns: totalFit as float

float asdm::CalGainRow::getTotalFitWeight ( ) const

===> Attribute totalFitWeight

Get totalFitWeight.

Returns: totalFitWeight as float

bool asdm::CalGainRow::getTotalGainValid ( ) const

===> Attribute totalGainValid

Get totalGainValid.

Returns: totalGainValid as bool

bool asdm::CalGainRow::isAdded ( ) const

Has this row been added to its table ?

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

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

private

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

void asdm::CalGainRow::setCalDataId ( Tag calDataId )

Set calDataId with the specified Tag.

Parameters

calDataId The Tag value to which calDataId 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::CalGainRow::setCalReductionId ( Tag calReductionId )

Set calReductionId with the specified Tag.

Parameters

calReductionId The Tag value to which calReductionId 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::CalGainRow::setEndValidTime ( ArrayTime endValidTime )

Set endValidTime with the specified ArrayTime.

Parameters

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

void asdm::CalGainRow::setFit ( float fit )

Set fit with the specified float.

Parameters

fit	The float value to which fit is to be set.

void asdm::CalGainRow::setFitWeight ( float fitWeight )

Set fitWeight with the specified float.

Parameters

fitWeight The float value to which fitWeight is to be set.

void asdm::CalGainRow::setFromIDL ( asdmIDL::CalGainRowIDL x )

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

Parameters

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

Exceptions

ConversionException

void asdm::CalGainRow::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::CalGainRow::setGain ( float gain )

Set gain with the specified float.

Parameters

gain	The float value to which gain is to be set.

void asdm::CalGainRow::setGainValid ( bool gainValid )

Set gainValid with the specified bool.

Parameters

gainValid The bool value to which gainValid is to be set.

void asdm::CalGainRow::setStartValidTime ( ArrayTime startValidTime )

Set startValidTime with the specified ArrayTime.

Parameters

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

void asdm::CalGainRow::setTotalFit ( float totalFit )

Set totalFit with the specified float.

Parameters

totalFit The float value to which totalFit is to be set.

void asdm::CalGainRow::setTotalFitWeight ( float totalFitWeight )

Set totalFitWeight with the specified float.

Parameters

totalFitWeight The float value to which totalFitWeight is to be set.

void asdm::CalGainRow::setTotalGainValid ( bool totalGainValid )

Set totalGainValid with the specified bool.

Parameters

totalGainValid The bool value to which totalGainValid is to be set.

void asdm::CalGainRow::startValidTimeFromBin ( EndianIStream & eis )

private

void asdm::CalGainRow::startValidTimeFromText ( const std::string & s )

private

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

private

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

Parameters

eoss	the EndianOSStream to be written to

asdmIDL::CalGainRowIDL* asdm::CalGainRow::toIDL ( ) const

Return this row in the form of an IDL struct.

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

void asdm::CalGainRow::toIDL ( asdmIDL::CalGainRowIDL & x ) const

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

Parameters

x	a reference to the CalGainRowIDL struct to be set.

void asdm::CalGainRow::totalFitFromBin ( EndianIStream & eis )

private

void asdm::CalGainRow::totalFitFromText ( const std::string & s )

private

void asdm::CalGainRow::totalFitWeightFromBin ( EndianIStream & eis )

private

void asdm::CalGainRow::totalFitWeightFromText ( const std::string & s )

private

void asdm::CalGainRow::totalGainValidFromBin ( EndianIStream & eis )

private

void asdm::CalGainRow::totalGainValidFromText ( const std::string & s )

private

std::string asdm::CalGainRow::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::CalGainTable

friend

Definition at line 115 of file CalGainRow.h.

friend class asdm::RowTransformer< CalGainRow >

friend

Definition at line 116 of file CalGainRow.h.

Member Data Documentation

Extrinsic Table asdm::CalGainRow::Attributes

Definition at line 139 of file CalGainRow.h.

Extrinsic Table asdm::CalGainRow::Attributes

Definition at line 413 of file CalGainRow.h.

Tag asdm::CalGainRow::calReductionId

private

===> Attribute calReductionId

Definition at line 825 of file CalGainRow.h.

ArrayTime asdm::CalGainRow::endValidTime

private

===> Attribute endValidTime

Definition at line 722 of file CalGainRow.h.

float asdm::CalGainRow::fit

private

===> Attribute fit

Definition at line 755 of file CalGainRow.h.

float asdm::CalGainRow::fitWeight

private

===> Attribute fitWeight

Definition at line 766 of file CalGainRow.h.

Links* binary deserialization material from an EndianIStream std::map<std::string, CalGainAttributeFromBin> asdm::CalGainRow::fromBinMethods

private

Definition at line 854 of file CalGainRow.h.

* text deserialization material std::map<std::string, CalGainAttributeFromText> asdm::CalGainRow::fromTextMethods

private

Definition at line 873 of file CalGainRow.h.

float asdm::CalGainRow::gain

private

===> Attribute gain

Definition at line 733 of file CalGainRow.h.

bool asdm::CalGainRow::gainValid

private

===> Attribute gainValid

Definition at line 744 of file CalGainRow.h.

bool asdm::CalGainRow::hasBeenAdded

private

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

Definition at line 667 of file CalGainRow.h.

CalGainTable& asdm::CalGainRow::table

private

The table to which this row belongs.

Definition at line 663 of file CalGainRow.h.

float asdm::CalGainRow::totalFit

private

===> Attribute totalFit

Definition at line 788 of file CalGainRow.h.

float asdm::CalGainRow::totalFitWeight

private

===> Attribute totalFitWeight

Definition at line 799 of file CalGainRow.h.

bool asdm::CalGainRow::totalGainValid

private

===> Attribute totalGainValid

Definition at line 777 of file CalGainRow.h.

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

casa/code/alma/ASDM/CalGainRow.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