asdm::AntennaRow Class Reference

#include <AntennaRow.h>

Collaboration diagram for asdm::AntennaRow:

[legend]List of all members.

---

Detailed Description

The AntennaRow class is a row of a AntennaTable.

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

Definition at line 154 of file AntennaRow.h.

Public Member Functions
virtual	~AntennaRow ()
AntennaTable &	getTable () const
	Return the table to which this row belongs.
AntennaRowIDL *	toIDL () const
	Return this row in the form of an IDL struct.
void	setFromIDL (AntennaRowIDL x) throw (ConversionException)
	Fill the values of this row from the IDL struct AntennaRowIDL.
string	toXML () const
	Return this row in the form of an XML string.
void	setFromXML (string rowDoc) throw (ConversionException)
	Fill the values of this row from an XML string that was produced by the toXML() method.
string	getName () const
	Get name.
void	setName (string name)
	Set name with the specified string.
AntennaMakeMod::AntennaMake	getAntennaMake () const
	Get antennaMake.
void	setAntennaMake (AntennaMakeMod::AntennaMake antennaMake)
	Set antennaMake with the specified AntennaMakeMod::AntennaMake.
AntennaTypeMod::AntennaType	getAntennaType () const
	Get antennaType.
void	setAntennaType (AntennaTypeMod::AntennaType antennaType)
	Set antennaType with the specified AntennaTypeMod::AntennaType.
Length	getXPosition () const
	Get xPosition.
void	setXPosition (Length xPosition)
	Set xPosition with the specified Length.
Length	getYPosition () const
	Get yPosition.
void	setYPosition (Length yPosition)
	Set yPosition with the specified Length.
Length	getZPosition () const
	Get zPosition.
void	setZPosition (Length zPosition)
	Set zPosition with the specified Length.
ArrayTime	getTime () const
	Get time.
void	setTime (ArrayTime time)
	Set time with the specified ArrayTime.
Length	getXOffset () const
	Get xOffset.
void	setXOffset (Length xOffset)
	Set xOffset with the specified Length.
Length	getYOffset () const
	Get yOffset.
void	setYOffset (Length yOffset)
	Set yOffset with the specified Length.
Length	getZOffset () const
	Get zOffset.
void	setZOffset (Length zOffset)
	Set zOffset with the specified Length.
Length	getDishDiameter () const
	Get dishDiameter.
void	setDishDiameter (Length dishDiameter)
	Set dishDiameter with the specified Length.
bool	getFlagRow () const
	Get flagRow.
void	setFlagRow (bool flagRow)
	Set flagRow with the specified bool.
Tag	getAssocAntennaId () const throw (IllegalAccessException)
	Get assocAntennaId, which is optional.
void	setAssocAntennaId (Tag assocAntennaId)
	Set assocAntennaId with the specified Tag.
void	clearAssocAntennaId ()
	Mark assocAntennaId, which is an optional field, as non-existent.
Tag	getStationId () const
	Get stationId.
void	setStationId (Tag stationId)
	Set stationId with the specified Tag.
AntennaRow *	getAssociatedAntenna () const throw (NoSuchRow)
	Get the optional row in table Antenna by traversing the defined link to that table.
void	setAssociatedAntennaLink (Tag assocAntennaId)
	Set the values of the link attributes needed to link this row to a row in table Antenna.
StationRow *	getStationUsingStationId ()
	stationId pointer to the row in the Station table having Station.stationId == stationId
bool	compareNoAutoInc (Tag stationId, string name, AntennaMakeMod::AntennaMake antennaMake, AntennaTypeMod::AntennaType antennaType, Length xPosition, Length yPosition, Length zPosition, ArrayTime time, Length xOffset, Length yOffset, Length zOffset, Length dishDiameter, bool flagRow)
	Compare each mandatory attribute except the autoincrementable one of this AntennaRow with the corresponding parameters and return true if there is a match and false otherwise.
bool	compareRequiredValue (Tag stationId, string name, AntennaMakeMod::AntennaMake antennaMake, AntennaTypeMod::AntennaType antennaType, Length xPosition, Length yPosition, Length zPosition, ArrayTime time, Length xOffset, Length yOffset, Length zOffset, Length dishDiameter, bool flagRow)
bool	equalByRequiredValue (AntennaRow *x)
	Return true if all required attributes of the value part are equal to their homologues in x and false otherwise.
Public Attributes
Intrinsic Table	Attributes
Extrinsic Table	Attributes
	Links
Private Member Functions
void	isAdded ()
	This method is used by the Table class when this row is added to the table.
	AntennaRow (AntennaTable &table)
	Create a AntennaRow.
	AntennaRow (AntennaTable &table, AntennaRow &row)
	Create a AntennaRow using a copy constructor mechanism.
void	setAntennaId (Tag antennaId)
	Set antennaId with the specified Tag value.
Private Attributes
AntennaTable &	table
	The table to which this row belongs.
bool	hasBeenAdded
	Whether this row has been added to the table or not.
string	name
	===> Attribute name
AntennaMakeMod::AntennaMake	antennaMake
	===> Attribute antennaMake
AntennaTypeMod::AntennaType	antennaType
	===> Attribute antennaType
Length	xPosition
	===> Attribute xPosition
Length	yPosition
	===> Attribute yPosition
Length	zPosition
	===> Attribute zPosition
ArrayTime	time
	===> Attribute time
Length	xOffset
	===> Attribute xOffset
Length	yOffset
	===> Attribute yOffset
Length	zOffset
	===> Attribute zOffset
Length	dishDiameter
	===> Attribute dishDiameter
bool	flagRow
	===> Attribute flagRow
Tag	assocAntennaId
Tag	stationId
	===> Attribute stationId
Friends
class	asdm::AntennaTable

---

Constructor & Destructor Documentation

virtual asdm::AntennaRow::~AntennaRow

(

)

[virtual]

asdm::AntennaRow::AntennaRow

(

AntennaTable &

table

)

[private]

Create a AntennaRow.

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::AntennaRow::AntennaRow	(	AntennaTable &	table,
		AntennaRow &	row
	)			[private]

Create a AntennaRow using a copy constructor mechanism.

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

AntennaTable& asdm::AntennaRow::getTable

(

)

const

Return the table to which this row belongs.

AntennaRowIDL* asdm::AntennaRow::toIDL

(

)

const

Return this row in the form of an IDL struct.

Returns:

The values of this row as a AntennaRowIDL struct.

void asdm::AntennaRow::setFromIDL

(

AntennaRowIDL

x

)

throw (ConversionException)

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

Parameters:

x

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

string asdm::AntennaRow::toXML

(

)

const

Return this row in the form of an XML string.

Returns:

The values of this row as an XML string.

void asdm::AntennaRow::setFromXML

(

string

rowDoc

)

throw (ConversionException)

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

Parameters:

x

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

string asdm::AntennaRow::getName

(

)

const

Get name.

Returns:

name as string

void asdm::AntennaRow::setName

(

string

name

)

Set name with the specified string.

Parameters:

name

The string value to which name is to be set.

AntennaMakeMod::AntennaMake asdm::AntennaRow::getAntennaMake

(

)

const

Get antennaMake.

Returns:

antennaMake as AntennaMakeMod::AntennaMake

void asdm::AntennaRow::setAntennaMake

(

AntennaMakeMod::AntennaMake

antennaMake

)

Set antennaMake with the specified AntennaMakeMod::AntennaMake.

Parameters:

antennaMake

The AntennaMakeMod::AntennaMake value to which antennaMake is to be set.

AntennaTypeMod::AntennaType asdm::AntennaRow::getAntennaType

(

)

const

Get antennaType.

Returns:

antennaType as AntennaTypeMod::AntennaType

void asdm::AntennaRow::setAntennaType

(

AntennaTypeMod::AntennaType

antennaType

)

Set antennaType with the specified AntennaTypeMod::AntennaType.

Parameters:

antennaType

The AntennaTypeMod::AntennaType value to which antennaType is to be set.

Length asdm::AntennaRow::getXPosition

(

)

const

Get xPosition.

Returns:

xPosition as Length

void asdm::AntennaRow::setXPosition

(

Length

xPosition

)

Set xPosition with the specified Length.

Parameters:

xPosition

The Length value to which xPosition is to be set.

Length asdm::AntennaRow::getYPosition

(

)

const

Get yPosition.

Returns:

yPosition as Length

void asdm::AntennaRow::setYPosition

(

Length

yPosition

)

Set yPosition with the specified Length.

Parameters:

yPosition

The Length value to which yPosition is to be set.

Length asdm::AntennaRow::getZPosition

(

)

const

Get zPosition.

Returns:

zPosition as Length

void asdm::AntennaRow::setZPosition

(

Length

zPosition

)

Set zPosition with the specified Length.

Parameters:

zPosition

The Length value to which zPosition is to be set.

ArrayTime asdm::AntennaRow::getTime

(

)

const

Get time.

Returns:

time as ArrayTime

void asdm::AntennaRow::setTime

(

ArrayTime

time

)

Set time with the specified ArrayTime.

Parameters:

time

The ArrayTime value to which time is to be set.

Length asdm::AntennaRow::getXOffset

(

)

const

Get xOffset.

Returns:

xOffset as Length

void asdm::AntennaRow::setXOffset

(

Length

xOffset

)

Set xOffset with the specified Length.

Parameters:

xOffset

The Length value to which xOffset is to be set.

Length asdm::AntennaRow::getYOffset

(

)

const

Get yOffset.

Returns:

yOffset as Length

void asdm::AntennaRow::setYOffset

(

Length

yOffset

)

Set yOffset with the specified Length.

Parameters:

yOffset

The Length value to which yOffset is to be set.

Length asdm::AntennaRow::getZOffset

(

)

const

Get zOffset.

Returns:

zOffset as Length

void asdm::AntennaRow::setZOffset

(

Length

zOffset

)

Set zOffset with the specified Length.

Parameters:

zOffset

The Length value to which zOffset is to be set.

Length asdm::AntennaRow::getDishDiameter

(

)

const

Get dishDiameter.

Returns:

dishDiameter as Length

void asdm::AntennaRow::setDishDiameter

(

Length

dishDiameter

)

Set dishDiameter with the specified Length.

Parameters:

dishDiameter

The Length value to which dishDiameter is to be set.

bool asdm::AntennaRow::getFlagRow

(

)

const

Get flagRow.

Returns:

flagRow as bool

void asdm::AntennaRow::setFlagRow

(

bool

flagRow

)

Set flagRow with the specified bool.

Parameters:

flagRow

The bool value to which flagRow is to be set.

Tag asdm::AntennaRow::getAssocAntennaId

(

)

const throw (IllegalAccessException)

Get assocAntennaId, which is optional.

Returns:

assocAntennaId as Tag

Exceptions:

IllegalAccessException

If assocAntennaId does not exist.

void asdm::AntennaRow::setAssocAntennaId

(

Tag

assocAntennaId

)

Set assocAntennaId with the specified Tag.

Parameters:

assocAntennaId

The Tag value to which assocAntennaId is to be set.

void asdm::AntennaRow::clearAssocAntennaId

(

)

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

Tag asdm::AntennaRow::getStationId

(

)

const

Get stationId.

Returns:

stationId as Tag

void asdm::AntennaRow::setStationId

(

Tag

stationId

)

Set stationId with the specified Tag.

Parameters:

stationId

The Tag value to which stationId is to be set.

AntennaRow* asdm::AntennaRow::getAssociatedAntenna

(

)

const throw (NoSuchRow)

Get the optional row in table Antenna by traversing the defined link to that table.

Returns:

A row in Antenna table.

Exceptions:

NoSuchRow

if there is no such row in table Antenna or the link does not exist.

void asdm::AntennaRow::setAssociatedAntennaLink

(

Tag

assocAntennaId

)

Set the values of the link attributes needed to link this row to a row in table Antenna.

StationRow* asdm::AntennaRow::getStationUsingStationId

(

)

stationId pointer to the row in the Station table having Station.stationId == stationId

Returns:

a StationRow*

bool asdm::AntennaRow::compareNoAutoInc	(	Tag	stationId,
		string	name,
		AntennaMakeMod::AntennaMake	antennaMake,
		AntennaTypeMod::AntennaType	antennaType,
		Length	xPosition,
		Length	yPosition,
		Length	zPosition,
		ArrayTime	time,
		Length	xOffset,
		Length	yOffset,
		Length	zOffset,
		Length	dishDiameter,
		bool	flagRow
	)

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

bool asdm::AntennaRow::compareRequiredValue	(	Tag	stationId,
		string	name,
		AntennaMakeMod::AntennaMake	antennaMake,
		AntennaTypeMod::AntennaType	antennaType,
		Length	xPosition,
		Length	yPosition,
		Length	zPosition,
		ArrayTime	time,
		Length	xOffset,
		Length	yOffset,
		Length	zOffset,
		Length	dishDiameter,
		bool	flagRow
	)

bool asdm::AntennaRow::equalByRequiredValue

(

AntennaRow *

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 AntennaRow whose required attributes of the value part will be compared with those of this.

Returns:

a boolean.

void asdm::AntennaRow::isAdded

(

)

[private]

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

void asdm::AntennaRow::setAntennaId

(

Tag

antennaId

)

[private]

Set antennaId with the specified Tag value.

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.

---

Friends And Related Function Documentation

friend class asdm::AntennaTable [friend]

Definition at line 155 of file AntennaRow.h.

---

Member Data Documentation

Extrinsic Table asdm::AntennaRow::Attributes

Definition at line 200 of file AntennaRow.h.

Extrinsic Table asdm::AntennaRow::Attributes

Definition at line 584 of file AntennaRow.h.

asdm::AntennaRow::Links

Definition at line 664 of file AntennaRow.h.

AntennaTable& asdm::AntennaRow::table [private]

The table to which this row belongs.

Definition at line 733 of file AntennaRow.h.

bool asdm::AntennaRow::hasBeenAdded [private]

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

Definition at line 737 of file AntennaRow.h.

string asdm::AntennaRow::name [private]

===> Attribute name

Definition at line 804 of file AntennaRow.h.

AntennaMakeMod::AntennaMake asdm::AntennaRow::antennaMake [private]

===> Attribute antennaMake

Definition at line 815 of file AntennaRow.h.

AntennaTypeMod::AntennaType asdm::AntennaRow::antennaType [private]

===> Attribute antennaType

Definition at line 826 of file AntennaRow.h.

Length asdm::AntennaRow::xPosition [private]

===> Attribute xPosition

Definition at line 837 of file AntennaRow.h.

Length asdm::AntennaRow::yPosition [private]

===> Attribute yPosition

Definition at line 848 of file AntennaRow.h.

Length asdm::AntennaRow::zPosition [private]

===> Attribute zPosition

Definition at line 859 of file AntennaRow.h.

ArrayTime asdm::AntennaRow::time [private]

===> Attribute time

Definition at line 870 of file AntennaRow.h.

Length asdm::AntennaRow::xOffset [private]

===> Attribute xOffset

Definition at line 881 of file AntennaRow.h.

Length asdm::AntennaRow::yOffset [private]

===> Attribute yOffset

Definition at line 892 of file AntennaRow.h.

Length asdm::AntennaRow::zOffset [private]

===> Attribute zOffset

Definition at line 903 of file AntennaRow.h.

Length asdm::AntennaRow::dishDiameter [private]

===> Attribute dishDiameter

Definition at line 914 of file AntennaRow.h.

bool asdm::AntennaRow::flagRow [private]

===> Attribute flagRow

Definition at line 925 of file AntennaRow.h.

Tag asdm::AntennaRow::assocAntennaId [private]

Definition at line 942 of file AntennaRow.h.

Tag asdm::AntennaRow::stationId [private]

===> Attribute stationId

Definition at line 953 of file AntennaRow.h.

---

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

• alma/implement/ASDM/AntennaRow.h

---