asdm::DataDescriptionRow Class Reference

The DataDescriptionRow class is a row of a DataDescriptionTable. More...

#include <DataDescriptionRow.h>

Public Member Functions
virtual	~DataDescriptionRow ()
	friend class asdm::TableStreamReader<DataDescriptionTable, DataDescriptionRow>;
DataDescriptionTable &	getTable () const
	Return the table to which this row belongs.
bool	isAdded () const
	Has this row been added to its table ?
void	setPolOrHoloId (Tag polOrHoloId)
	Set polOrHoloId with the specified Tag.
Tag	getSpectralWindowId () const
	===> Attribute spectralWindowId
void	setSpectralWindowId (Tag spectralWindowId)
	Set spectralWindowId with the specified Tag.
Links PolarizationRow	getPolarizationUsingPolOrHoloId ()
	Returns pointer to the row in the Polarization table having Polarization.polarizationId == polOrHoloId.
HolographyRow *	getHolographyUsingPolOrHoloId ()
	Returns pointer to the row in the Holograpy table having Holography.holographyId == polOrHoloId.
SpectralWindowRow *	getSpectralWindowUsingSpectralWindowId ()
	spectralWindowId pointer to the row in the SpectralWindow table having SpectralWindow.spectralWindowId == spectralWindowId
bool	compareNoAutoInc (Tag polOrHoloId, Tag spectralWindowId)
	Compare each mandatory attribute except the autoincrementable one of this DataDescriptionRow with the corresponding parameters and return true if there is a match and false otherwise.
bool	compareRequiredValue (Tag polOrHoloId, Tag spectralWindowId)
	Compare each mandatory value (i.e.
bool	equalByRequiredValue (DataDescriptionRow *x)
	Return true if all required attributes of the value part are equal to their homologues in x and false otherwise.
asdmIDL::DataDescriptionRowIDL *	toIDL () const
	Return this row in the form of an IDL struct.
void	toIDL (asdmIDL::DataDescriptionRowIDL &x) const
	Define the content of a DataDescriptionRowIDL struct from the values found in this row.
void	setFromIDL (asdmIDL::DataDescriptionRowIDL x)
	Fill the values of this row from the IDL struct DataDescriptionRowIDL.
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.
	DataDescriptionRow (DataDescriptionTable &table)
	Create a DataDescriptionRow.
	DataDescriptionRow (DataDescriptionTable &table, DataDescriptionRow &row)
	Create a DataDescriptionRow using a copy constructor mechanism.
void	setDataDescriptionId (Tag dataDescriptionId)
	Set dataDescriptionId with the specified Tag value.
void	dataDescriptionIdFromBin (EndianIStream &eis)
void	polOrHoloIdFromBin (EndianIStream &eis)
void	spectralWindowIdFromBin (EndianIStream &eis)
void	dataDescriptionIdFromText (const string &s)
void	polOrHoloIdFromText (const string &s)
void	spectralWindowIdFromText (const string &s)
void	toBin (EndianOSStream &eoss)
	Serialize this into a stream of bytes written to an EndianOSStream.
Private Attributes
DataDescriptionTable &	table
	The table to which this row belongs.
bool	hasBeenAdded
	Whether this row has been added to the table or not.
Tag	spectralWindowId
	===> Attribute spectralWindowId
Links *binary deserialization material from an EndianIStream std::map< std::string, DataDescriptionAttributeFromBin >	fromBinMethods
*text deserialization material std::map< std::string, DataDescriptionAttributeFromText >	fromTextMethods
Friends
class	asdm::DataDescriptionTable
class	asdm::RowTransformer< DataDescriptionRow >

Detailed Description

The DataDescriptionRow class is a row of a DataDescriptionTable.

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

Definition at line 97 of file DataDescriptionRow.h.

Constructor & Destructor Documentation

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

friend class asdm::TableStreamReader<DataDescriptionTable, DataDescriptionRow>;

asdm::DataDescriptionRow::DataDescriptionRow ( DataDescriptionTable & table ) [private]

Create a DataDescriptionRow.

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

Create a DataDescriptionRow using a copy constructor mechanism.

Given a DataDescriptionRow row and a DataDescriptionTable table, the method creates a new DataDescriptionRow 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

bool asdm::DataDescriptionRow::compareNoAutoInc	(	Tag	polOrHoloId,
		Tag	spectralWindowId
	)

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

Parameters:

	polOrHoloId
	spectralWindowId

bool asdm::DataDescriptionRow::compareRequiredValue	(	Tag	polOrHoloId,
		Tag	spectralWindowId
	)

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:

	polOrHoloId
	spectralWindowId

void asdm::DataDescriptionRow::dataDescriptionIdFromBin ( EndianIStream & eis ) [private]

void asdm::DataDescriptionRow::dataDescriptionIdFromText ( const string & s ) [private]

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

Returns:: a boolean.

HolographyRow* asdm::DataDescriptionRow::getHolographyUsingPolOrHoloId ( )

Returns pointer to the row in the Holograpy table having Holography.holographyId == polOrHoloId.

Returns:: a HolographyRow* or 0 if polOrHoloId is an Polarization Tag.

Links* PolarizationRow* asdm::DataDescriptionRow::getPolarizationUsingPolOrHoloId ( )

Returns pointer to the row in the Polarization table having Polarization.polarizationId == polOrHoloId.

Returns:: a PolarizationRow* or 0 if polOrHoloId is an Holography Tag.

Tag asdm::DataDescriptionRow::getSpectralWindowId ( ) const

===> Attribute spectralWindowId

Get spectralWindowId.

Returns:: spectralWindowId as Tag

SpectralWindowRow* asdm::DataDescriptionRow::getSpectralWindowUsingSpectralWindowId ( )

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

Returns:: a SpectralWindowRow*

DataDescriptionTable& asdm::DataDescriptionRow::getTable ( ) const

Return the table to which this row belongs.

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

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

bool asdm::DataDescriptionRow::isAdded ( ) const

Has this row been added to its table ?

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

void asdm::DataDescriptionRow::polOrHoloIdFromBin ( EndianIStream & eis ) [private]

void asdm::DataDescriptionRow::polOrHoloIdFromText ( const string & s ) [private]

void asdm::DataDescriptionRow::setDataDescriptionId ( Tag dataDescriptionId ) [private]

Set dataDescriptionId with the specified Tag value.

Parameters:

dataDescriptionId

The Tag value to which dataDescriptionId 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::DataDescriptionRow::setFromIDL ( asdmIDL::DataDescriptionRowIDL x )

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

Parameters:

x

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

Exceptions:

ConversionException

void asdm::DataDescriptionRow::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::DataDescriptionRow::setPolOrHoloId ( Tag polOrHoloId )

Set polOrHoloId with the specified Tag.

Parameters:

polOrHoloId

The Tag value to which polOrHoloId is to be set.

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

Set spectralWindowId with the specified Tag.

Parameters:

spectralWindowId

The Tag value to which spectralWindowId is to be set.

void asdm::DataDescriptionRow::spectralWindowIdFromBin ( EndianIStream & eis ) [private]

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

void asdm::DataDescriptionRow::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::DataDescriptionRow::toIDL ( asdmIDL::DataDescriptionRowIDL & x ) const

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

Parameters:

x

a reference to the DataDescriptionRowIDL struct to be set.

asdmIDL::DataDescriptionRowIDL* asdm::DataDescriptionRow::toIDL ( ) const

Return this row in the form of an IDL struct.

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

std::string asdm::DataDescriptionRow::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::DataDescriptionTable [friend]

Definition at line 98 of file DataDescriptionRow.h.

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

Definition at line 99 of file DataDescriptionRow.h.

Member Data Documentation

Extrinsic Table asdm::DataDescriptionRow::Attributes

Definition at line 146 of file DataDescriptionRow.h.

Extrinsic Table asdm::DataDescriptionRow::Attributes

Definition at line 122 of file DataDescriptionRow.h.

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

Definition at line 464 of file DataDescriptionRow.h.

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

Definition at line 475 of file DataDescriptionRow.h.

bool asdm::DataDescriptionRow::hasBeenAdded [private]

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

Definition at line 353 of file DataDescriptionRow.h.

Tag asdm::DataDescriptionRow::spectralWindowId [private]

===> Attribute spectralWindowId

Definition at line 435 of file DataDescriptionRow.h.

DataDescriptionTable& asdm::DataDescriptionRow::table [private]

The table to which this row belongs.

Definition at line 349 of file DataDescriptionRow.h.

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

code/alma/ASDM/DataDescriptionRow.h

asdm::DataDescriptionRow 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