asdm::AlmaRadiometerRow Class Reference

The AlmaRadiometerRow class is a row of a AlmaRadiometerTable. More...

#include <AlmaRadiometerRow.h>

Public Member Functions
virtual	~AlmaRadiometerRow ()
	friend class asdm::TableStreamReader<AlmaRadiometerTable, AlmaRadiometerRow>;
AlmaRadiometerTable &	getTable () const
	Return the table to which this row belongs.
bool	isAdded () const
	Has this row been added to its table ?
bool	isNumAntennaExists () const
	===> Attribute numAntenna, which is optional
int	getNumAntenna () const
	Get numAntenna, which is optional.
void	setNumAntenna (int numAntenna)
	Set numAntenna with the specified int.
void	clearNumAntenna ()
	Mark numAntenna, which is an optional field, as non-existent.
vector< Tag >	getSpectralWindowId () const
	Get spectralWindowId, which is optional.
void	setSpectralWindowId (vector< Tag > spectralWindowId)
	Set spectralWindowId with the specified vector<Tag> .
void	clearSpectralWindowId ()
	Mark spectralWindowId, which is an optional field, as non-existent.
Links *void	setSpectralWindowId (int i, Tag spectralWindowId)
	Set spectralWindowId[i] with the specified Tag.
void	addSpectralWindowId (Tag id)
	Append a Tag to spectralWindowId.
void	addSpectralWindowId (const vector< Tag > &id)
	Append a vector of Tag to spectralWindowId.
const Tag	getSpectralWindowId (int i)
	Returns the Tag stored in spectralWindowId at position i.
SpectralWindowRow *	getSpectralWindowUsingSpectralWindowId (int i)
	Returns the SpectralWindowRow linked to this row via the tag stored in spectralWindowId at position i.
vector< SpectralWindowRow * >	getSpectralWindowsUsingSpectralWindowId ()
	Returns the vector of SpectralWindowRow* linked to this row via the Tags stored in spectralWindowId.
bool	equalByRequiredValue (AlmaRadiometerRow *x)
	Return true if all required attributes of the value part are equal to their homologues in x and false otherwise.
asdmIDL::AlmaRadiometerRowIDL *	toIDL () const
	Return this row in the form of an IDL struct.
void	toIDL (asdmIDL::AlmaRadiometerRowIDL &x) const
	Define the content of a AlmaRadiometerRowIDL struct from the values found in this row.
void	setFromIDL (asdmIDL::AlmaRadiometerRowIDL x)
	Fill the values of this row from the IDL struct AlmaRadiometerRowIDL.
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.
	AlmaRadiometerRow (AlmaRadiometerTable &table)
	Create a AlmaRadiometerRow.
	AlmaRadiometerRow (AlmaRadiometerTable &table, AlmaRadiometerRow &row)
	Create a AlmaRadiometerRow using a copy constructor mechanism.
void	setAlmaRadiometerId (Tag almaRadiometerId)
	Set almaRadiometerId with the specified Tag value.
void	almaRadiometerIdFromBin (EndianIStream &eis)
void	numAntennaFromBin (EndianIStream &eis)
void	spectralWindowIdFromBin (EndianIStream &eis)
void	almaRadiometerIdFromText (const string &s)
void	numAntennaFromText (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
AlmaRadiometerTable &	table
	The table to which this row belongs.
bool	hasBeenAdded
	Whether this row has been added to the table or not.
bool	numAntennaExists
	===> Attribute numAntenna, which is optional
int	numAntenna
vector< Tag >	spectralWindowId
Links *binary deserialization material from an EndianIStream std::map< std::string, AlmaRadiometerAttributeFromBin >	fromBinMethods
*text deserialization material std::map< std::string, AlmaRadiometerAttributeFromText >	fromTextMethods
Friends
class	asdm::AlmaRadiometerTable
class	asdm::RowTransformer< AlmaRadiometerRow >

Detailed Description

The AlmaRadiometerRow class is a row of a AlmaRadiometerTable.

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

Definition at line 93 of file AlmaRadiometerRow.h.

Constructor & Destructor Documentation

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

friend class asdm::TableStreamReader<AlmaRadiometerTable, AlmaRadiometerRow>;

asdm::AlmaRadiometerRow::AlmaRadiometerRow ( AlmaRadiometerTable & table ) [private]

Create a AlmaRadiometerRow.

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

Create a AlmaRadiometerRow using a copy constructor mechanism.

Given a AlmaRadiometerRow row and a AlmaRadiometerTable table, the method creates a new AlmaRadiometerRow 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::AlmaRadiometerRow::addSpectralWindowId ( const vector< Tag > & id )

Append a vector of Tag to spectralWindowId.

Parameters:

id

an array of Tag to be appended to spectralWindowId

void asdm::AlmaRadiometerRow::addSpectralWindowId ( Tag id )

Append a Tag to spectralWindowId.

Parameters:

id

the Tag to be appended to spectralWindowId

void asdm::AlmaRadiometerRow::almaRadiometerIdFromBin ( EndianIStream & eis ) [private]

void asdm::AlmaRadiometerRow::almaRadiometerIdFromText ( const string & s ) [private]

void asdm::AlmaRadiometerRow::clearNumAntenna ( )

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

void asdm::AlmaRadiometerRow::clearSpectralWindowId ( )

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

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

Returns:: a boolean.

int asdm::AlmaRadiometerRow::getNumAntenna ( ) const

Get numAntenna, which is optional.

Returns:: numAntenna as int

Exceptions:

IllegalAccessException

If numAntenna does not exist.

const Tag asdm::AlmaRadiometerRow::getSpectralWindowId ( int i )

Returns the Tag stored in spectralWindowId at position i.

Parameters:

i

the position in spectralWindowId where the Tag is retrieved.

Returns:: the Tag stored at position i in spectralWindowId.

vector<Tag> asdm::AlmaRadiometerRow::getSpectralWindowId ( ) const

Get spectralWindowId, which is optional.

Returns:: spectralWindowId as vector<Tag>

Exceptions:

IllegalAccessException

If spectralWindowId does not exist.

vector<SpectralWindowRow *> asdm::AlmaRadiometerRow::getSpectralWindowsUsingSpectralWindowId ( )

Returns the vector of SpectralWindowRow* linked to this row via the Tags stored in spectralWindowId.

Returns:: an array of pointers on SpectralWindowRow.

SpectralWindowRow* asdm::AlmaRadiometerRow::getSpectralWindowUsingSpectralWindowId ( int i )

Returns the SpectralWindowRow linked to this row via the tag stored in spectralWindowId at position i.

Parameters:

i

the position in spectralWindowId.

Returns:: a pointer on a SpectralWindowRow whose key (a Tag) is equal to the Tag stored at position i in the spectralWindowId.

AlmaRadiometerTable& asdm::AlmaRadiometerRow::getTable ( ) const

Return the table to which this row belongs.

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

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

bool asdm::AlmaRadiometerRow::isAdded ( ) const

Has this row been added to its table ?

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

bool asdm::AlmaRadiometerRow::isNumAntennaExists ( ) const

===> Attribute numAntenna, which is optional

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

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

void asdm::AlmaRadiometerRow::numAntennaFromBin ( EndianIStream & eis ) [private]

void asdm::AlmaRadiometerRow::numAntennaFromText ( const string & s ) [private]

void asdm::AlmaRadiometerRow::setAlmaRadiometerId ( Tag almaRadiometerId ) [private]

Set almaRadiometerId with the specified Tag value.

Parameters:

almaRadiometerId

The Tag value to which almaRadiometerId 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::AlmaRadiometerRow::setFromIDL ( asdmIDL::AlmaRadiometerRowIDL x )

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

Parameters:

x

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

Exceptions:

ConversionException

void asdm::AlmaRadiometerRow::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::AlmaRadiometerRow::setNumAntenna ( int numAntenna )

Set numAntenna with the specified int.

Parameters:

numAntenna

The int value to which numAntenna is to be set.

Links* void asdm::AlmaRadiometerRow::setSpectralWindowId	(	int	i,
		Tag	spectralWindowId
	)

Set spectralWindowId[i] with the specified Tag.

Parameters:

	i	The index in spectralWindowId where to set the Tag value.
	spectralWindowId	The Tag value to which spectralWindowId[i] is to be set.

Exceptions:

OutOfBoundsException

void asdm::AlmaRadiometerRow::setSpectralWindowId ( vector< Tag > spectralWindowId )

Set spectralWindowId with the specified vector<Tag> .

Parameters:

spectralWindowId

The vector<Tag> value to which spectralWindowId is to be set.

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

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

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

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

Parameters:

x

a reference to the AlmaRadiometerRowIDL struct to be set.

asdmIDL::AlmaRadiometerRowIDL* asdm::AlmaRadiometerRow::toIDL ( ) const

Return this row in the form of an IDL struct.

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

std::string asdm::AlmaRadiometerRow::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::AlmaRadiometerTable [friend]

Definition at line 94 of file AlmaRadiometerRow.h.

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

Definition at line 95 of file AlmaRadiometerRow.h.

Member Data Documentation

Extrinsic Table asdm::AlmaRadiometerRow::Attributes

Definition at line 183 of file AlmaRadiometerRow.h.

Extrinsic Table asdm::AlmaRadiometerRow::Attributes

Definition at line 118 of file AlmaRadiometerRow.h.

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

Definition at line 480 of file AlmaRadiometerRow.h.

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

Definition at line 491 of file AlmaRadiometerRow.h.

bool asdm::AlmaRadiometerRow::hasBeenAdded [private]

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

Definition at line 373 of file AlmaRadiometerRow.h.

int asdm::AlmaRadiometerRow::numAntenna [private]

Definition at line 442 of file AlmaRadiometerRow.h.

bool asdm::AlmaRadiometerRow::numAntennaExists [private]

===> Attribute numAntenna, which is optional

Definition at line 439 of file AlmaRadiometerRow.h.

vector<Tag> asdm::AlmaRadiometerRow::spectralWindowId [private]

Definition at line 459 of file AlmaRadiometerRow.h.

AlmaRadiometerTable& asdm::AlmaRadiometerRow::table [private]

The table to which this row belongs.

Definition at line 369 of file AlmaRadiometerRow.h.

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

code/alma/ASDM/AlmaRadiometerRow.h

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