asdm::FreqOffsetRow Class Reference

The FreqOffsetRow class is a row of a FreqOffsetTable. More...

#include <FreqOffsetRow.h>

Public Member Functions
virtual	~FreqOffsetRow ()
	friend class asdm::TableStreamReader<FreqOffsetTable, FreqOffsetRow>;
FreqOffsetTable &	getTable () const
	Return the table to which this row belongs.
bool	isAdded () const
	Has this row been added to its table ?
void	setTimeInterval (ArrayTimeInterval timeInterval)
	Set timeInterval with the specified ArrayTimeInterval.
Frequency	getOffset () const
	===> Attribute offset
void	setOffset (Frequency offset)
	Set offset with the specified Frequency.
void	setAntennaId (Tag antennaId)
	Set antennaId with the specified Tag.
int	getFeedId () const
	===> Attribute feedId
void	setFeedId (int feedId)
	Set feedId with the specified int.
Tag	getSpectralWindowId () const
	===> Attribute spectralWindowId
void	setSpectralWindowId (Tag spectralWindowId)
	Set spectralWindowId with the specified Tag.
Links AntennaRow	getAntennaUsingAntennaId ()
	antennaId pointer to the row in the Antenna table having Antenna.antennaId == antennaId
SpectralWindowRow *	getSpectralWindowUsingSpectralWindowId ()
	spectralWindowId pointer to the row in the SpectralWindow table having SpectralWindow.spectralWindowId == spectralWindowId
vector< FeedRow * >	getFeeds ()
	===> Slice link from a row of FreqOffset table to a collection of row of Feed table.
bool	compareNoAutoInc (Tag antennaId, Tag spectralWindowId, ArrayTimeInterval timeInterval, int feedId, Frequency offset)
	Compare each mandatory attribute except the autoincrementable one of this FreqOffsetRow with the corresponding parameters and return true if there is a match and false otherwise.
bool	compareRequiredValue (Frequency offset)
	Compare each mandatory value (i.e.
bool	equalByRequiredValue (FreqOffsetRow *x)
	Return true if all required attributes of the value part are equal to their homologues in x and false otherwise.
asdmIDL::FreqOffsetRowIDL *	toIDL () const
	Return this row in the form of an IDL struct.
void	toIDL (asdmIDL::FreqOffsetRowIDL &x) const
	Define the content of a FreqOffsetRowIDL struct from the values found in this row.
void	setFromIDL (asdmIDL::FreqOffsetRowIDL x)
	Fill the values of this row from the IDL struct FreqOffsetRowIDL.
std::string	toXML () const
	Return this row in the form of an XML string.
void	setFromXML (std::string rowDoc)
	Fill the values of this row from an XML string that was produced by the toXML() method.
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.
	FreqOffsetRow (FreqOffsetTable &table)
	Create a FreqOffsetRow.
	FreqOffsetRow (FreqOffsetTable &table, FreqOffsetRow &row)
	Create a FreqOffsetRow using a copy constructor mechanism.
void	antennaIdFromBin (EndianIStream &eis)
void	spectralWindowIdFromBin (EndianIStream &eis)
void	timeIntervalFromBin (EndianIStream &eis)
void	feedIdFromBin (EndianIStream &eis)
void	offsetFromBin (EndianIStream &eis)
void	antennaIdFromText (const string &s)
void	spectralWindowIdFromText (const string &s)
void	timeIntervalFromText (const string &s)
void	feedIdFromText (const string &s)
void	offsetFromText (const string &s)
void	toBin (EndianOSStream &eoss)
	Serialize this into a stream of bytes written to an EndianOSStream.
Private Attributes
FreqOffsetTable &	table
	The table to which this row belongs.
bool	hasBeenAdded
	Whether this row has been added to the table or not.
Frequency	offset
	===> Attribute offset
int	feedId
	===> Attribute feedId
Tag	spectralWindowId
	===> Attribute spectralWindowId
Links *binary deserialization material from an EndianIStream std::map< std::string, FreqOffsetAttributeFromBin >	fromBinMethods
*text deserialization material std::map< std::string, FreqOffsetAttributeFromText >	fromTextMethods
Friends
class	asdm::FreqOffsetTable
class	asdm::RowTransformer< FreqOffsetRow >

Detailed Description

The FreqOffsetRow class is a row of a FreqOffsetTable.

Generated from model's revision "1.64", branch "HEAD"

Definition at line 107 of file FreqOffsetRow.h.

Constructor & Destructor Documentation

virtual asdm::FreqOffsetRow::~FreqOffsetRow ( ) [virtual]

friend class asdm::TableStreamReader<FreqOffsetTable, FreqOffsetRow>;

asdm::FreqOffsetRow::FreqOffsetRow ( FreqOffsetTable & table ) [private]

Create a FreqOffsetRow.

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::FreqOffsetRow::FreqOffsetRow	(	FreqOffsetTable &	table,
		FreqOffsetRow &	row
	)			`[private]`

Create a FreqOffsetRow using a copy constructor mechanism.

Given a FreqOffsetRow row and a FreqOffsetTable table, the method creates a new FreqOffsetRow 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::FreqOffsetRow::antennaIdFromBin ( EndianIStream & eis ) [private]

void asdm::FreqOffsetRow::antennaIdFromText ( const string & s ) [private]

bool asdm::FreqOffsetRow::compareNoAutoInc	(	Tag	antennaId,
		Tag	spectralWindowId,
		ArrayTimeInterval	timeInterval,
		int	feedId,
		Frequency	offset
	)

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

Parameters:

	antennaId
	spectralWindowId
	timeInterval
	feedId
	offset

bool asdm::FreqOffsetRow::compareRequiredValue ( Frequency offset )

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:

offset

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

Returns:: a boolean.

void asdm::FreqOffsetRow::feedIdFromBin ( EndianIStream & eis ) [private]

void asdm::FreqOffsetRow::feedIdFromText ( const string & s ) [private]

Links* AntennaRow* asdm::FreqOffsetRow::getAntennaUsingAntennaId ( )

antennaId pointer to the row in the Antenna table having Antenna.antennaId == antennaId

Returns:: a AntennaRow*

int asdm::FreqOffsetRow::getFeedId ( ) const

===> Attribute feedId

Get feedId.

Returns:: feedId as int

vector<FeedRow *> asdm::FreqOffsetRow::getFeeds ( )

===> Slice link from a row of FreqOffset table to a collection of row of Feed table.

Get the collection of row in the Feed table having feedId == this.feedId

Returns:: a vector of FeedRow *

Frequency asdm::FreqOffsetRow::getOffset ( ) const

===> Attribute offset

Get offset.

Returns:: offset as Frequency

Tag asdm::FreqOffsetRow::getSpectralWindowId ( ) const

===> Attribute spectralWindowId

Get spectralWindowId.

Returns:: spectralWindowId as Tag

SpectralWindowRow* asdm::FreqOffsetRow::getSpectralWindowUsingSpectralWindowId ( )

spectralWindowId pointer to the row in the SpectralWindow table having SpectralWindow.spectralWindowId == spectralWindowId

Returns:: a SpectralWindowRow*

FreqOffsetTable& asdm::FreqOffsetRow::getTable ( ) const

Return the table to which this row belongs.

void asdm::FreqOffsetRow::isAdded ( bool added ) [private]

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

bool asdm::FreqOffsetRow::isAdded ( ) const

Has this row been added to its table ?

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

void asdm::FreqOffsetRow::offsetFromBin ( EndianIStream & eis ) [private]

void asdm::FreqOffsetRow::offsetFromText ( const string & s ) [private]

void asdm::FreqOffsetRow::setAntennaId ( Tag antennaId )

Set antennaId with the specified Tag.

Parameters:

antennaId

The Tag value to which antennaId 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::FreqOffsetRow::setFeedId ( int feedId )

Set feedId with the specified int.

Parameters:

feedId

The int value to which feedId 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::FreqOffsetRow::setFromIDL ( asdmIDL::FreqOffsetRowIDL x )

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

Parameters:

x

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

Exceptions:

ConversionException

void asdm::FreqOffsetRow::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::FreqOffsetRow::setOffset ( Frequency offset )

Set offset with the specified Frequency.

Parameters:

offset

The Frequency value to which offset is to be set.

void asdm::FreqOffsetRow::setSpectralWindowId ( Tag spectralWindowId )

Set spectralWindowId with the specified Tag.

Parameters:

spectralWindowId

The Tag value to which spectralWindowId 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::FreqOffsetRow::setTimeInterval ( ArrayTimeInterval timeInterval )

Set timeInterval with the specified ArrayTimeInterval.

Parameters:

timeInterval

The ArrayTimeInterval value to which timeInterval 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::FreqOffsetRow::spectralWindowIdFromBin ( EndianIStream & eis ) [private]

void asdm::FreqOffsetRow::spectralWindowIdFromText ( const string & s ) [private]

void asdm::FreqOffsetRow::timeIntervalFromBin ( EndianIStream & eis ) [private]

void asdm::FreqOffsetRow::timeIntervalFromText ( const string & s ) [private]

void asdm::FreqOffsetRow::toBin ( EndianOSStream & eoss ) [private]

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

Parameters:

eoss

the EndianOSStream to be written to

void asdm::FreqOffsetRow::toIDL ( asdmIDL::FreqOffsetRowIDL & x ) const

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

Parameters:

x

a reference to the FreqOffsetRowIDL struct to be set.

asdmIDL::FreqOffsetRowIDL* asdm::FreqOffsetRow::toIDL ( ) const

Return this row in the form of an IDL struct.

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

std::string asdm::FreqOffsetRow::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::FreqOffsetTable [friend]

Definition at line 108 of file FreqOffsetRow.h.

friend class asdm::RowTransformer< FreqOffsetRow > [friend]

Definition at line 109 of file FreqOffsetRow.h.

Member Data Documentation

Extrinsic Table asdm::FreqOffsetRow::Attributes

Definition at line 198 of file FreqOffsetRow.h.

Extrinsic Table asdm::FreqOffsetRow::Attributes

Definition at line 132 of file FreqOffsetRow.h.

int asdm::FreqOffsetRow::feedId [private]

===> Attribute feedId

Definition at line 548 of file FreqOffsetRow.h.

Links* binary deserialization material from an EndianIStream std::map<std::string, FreqOffsetAttributeFromBin> asdm::FreqOffsetRow::fromBinMethods [private]

Definition at line 594 of file FreqOffsetRow.h.

* text deserialization material std::map<std::string, FreqOffsetAttributeFromText> asdm::FreqOffsetRow::fromTextMethods [private]

Definition at line 607 of file FreqOffsetRow.h.

bool asdm::FreqOffsetRow::hasBeenAdded [private]

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

Definition at line 467 of file FreqOffsetRow.h.

Frequency asdm::FreqOffsetRow::offset [private]

===> Attribute offset

Definition at line 522 of file FreqOffsetRow.h.

Tag asdm::FreqOffsetRow::spectralWindowId [private]

===> Attribute spectralWindowId

Definition at line 559 of file FreqOffsetRow.h.

FreqOffsetTable& asdm::FreqOffsetRow::table [private]

The table to which this row belongs.

Definition at line 463 of file FreqOffsetRow.h.

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

code/alma/ASDM/FreqOffsetRow.h

asdm::FreqOffsetRow Class Reference

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