asdm::FocusRow Class Reference

The FocusRow class is a row of a FocusTable. More...

#include <FocusRow.h>

Public Member Functions
virtual	~FocusRow ()
	friend class asdm::TableStreamReader<FocusTable, FocusRow>;
FocusTable &	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.
bool	getFocusTracking () const
	===> Attribute focusTracking
void	setFocusTracking (bool focusTracking)
	Set focusTracking with the specified bool.
vector< Length >	getFocusOffset () const
	===> Attribute focusOffset
void	setFocusOffset (vector< Length > focusOffset)
	Set focusOffset with the specified vector<Length >.
vector< Angle >	getFocusRotationOffset () const
	===> Attribute focusRotationOffset
void	setFocusRotationOffset (vector< Angle > focusRotationOffset)
	Set focusRotationOffset with the specified vector<Angle >.
bool	isMeasuredFocusPositionExists () const
	===> Attribute measuredFocusPosition, which is optional
vector< Length >	getMeasuredFocusPosition () const
	Get measuredFocusPosition, which is optional.
void	setMeasuredFocusPosition (vector< Length > measuredFocusPosition)
	Set measuredFocusPosition with the specified vector<Length >.
void	clearMeasuredFocusPosition ()
	Mark measuredFocusPosition, which is an optional field, as non-existent.
bool	isMeasuredFocusRotationExists () const
	===> Attribute measuredFocusRotation, which is optional
vector< Angle >	getMeasuredFocusRotation () const
	Get measuredFocusRotation, which is optional.
void	setMeasuredFocusRotation (vector< Angle > measuredFocusRotation)
	Set measuredFocusRotation with the specified vector<Angle >.
void	clearMeasuredFocusRotation ()
	Mark measuredFocusRotation, which is an optional field, as non-existent.
void	setAntennaId (Tag antennaId)
	Set antennaId with the specified Tag.
int	getFocusModelId () const
	===> Attribute focusModelId
void	setFocusModelId (int focusModelId)
	Set focusModelId with the specified int.
Links AntennaRow	getAntennaUsingAntennaId ()
	antennaId pointer to the row in the Antenna table having Antenna.antennaId == antennaId
vector< FocusModelRow * >	getFocusModels ()
	===> Slice link from a row of Focus table to a collection of row of FocusModel table.
bool	compareNoAutoInc (Tag antennaId, ArrayTimeInterval timeInterval, bool focusTracking, vector< Length > focusOffset, vector< Angle > focusRotationOffset, int focusModelId)
	Compare each mandatory attribute except the autoincrementable one of this FocusRow with the corresponding parameters and return true if there is a match and false otherwise.
bool	compareRequiredValue (bool focusTracking, vector< Length > focusOffset, vector< Angle > focusRotationOffset, int focusModelId)
	Compare each mandatory value (i.e.
bool	equalByRequiredValue (FocusRow *x)
	Return true if all required attributes of the value part are equal to their homologues in x and false otherwise.
asdmIDL::FocusRowIDL *	toIDL () const
	Return this row in the form of an IDL struct.
void	toIDL (asdmIDL::FocusRowIDL &x) const
	Define the content of a FocusRowIDL struct from the values found in this row.
void	setFromIDL (asdmIDL::FocusRowIDL x)
	Fill the values of this row from the IDL struct FocusRowIDL.
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.
	FocusRow (FocusTable &table)
	Create a FocusRow.
	FocusRow (FocusTable &table, FocusRow &row)
	Create a FocusRow using a copy constructor mechanism.
void	antennaIdFromBin (EndianIStream &eis)
void	timeIntervalFromBin (EndianIStream &eis)
void	focusTrackingFromBin (EndianIStream &eis)
void	focusOffsetFromBin (EndianIStream &eis)
void	focusRotationOffsetFromBin (EndianIStream &eis)
void	focusModelIdFromBin (EndianIStream &eis)
void	measuredFocusPositionFromBin (EndianIStream &eis)
void	measuredFocusRotationFromBin (EndianIStream &eis)
void	antennaIdFromText (const string &s)
void	timeIntervalFromText (const string &s)
void	focusTrackingFromText (const string &s)
void	focusOffsetFromText (const string &s)
void	focusRotationOffsetFromText (const string &s)
void	focusModelIdFromText (const string &s)
void	measuredFocusPositionFromText (const string &s)
void	measuredFocusRotationFromText (const string &s)
void	toBin (EndianOSStream &eoss)
	Serialize this into a stream of bytes written to an EndianOSStream.
Private Attributes
FocusTable &	table
	The table to which this row belongs.
bool	hasBeenAdded
	Whether this row has been added to the table or not.
bool	focusTracking
	===> Attribute focusTracking
vector< Length >	focusOffset
	===> Attribute focusOffset
vector< Angle >	focusRotationOffset
	===> Attribute focusRotationOffset
bool	measuredFocusPositionExists
	===> Attribute measuredFocusPosition, which is optional
vector< Length >	measuredFocusPosition
bool	measuredFocusRotationExists
	===> Attribute measuredFocusRotation, which is optional
vector< Angle >	measuredFocusRotation
int	focusModelId
	===> Attribute focusModelId
Links *binary deserialization material from an EndianIStream std::map< std::string, FocusAttributeFromBin >	fromBinMethods
*text deserialization material std::map< std::string, FocusAttributeFromText >	fromTextMethods
Friends
class	asdm::FocusTable
class	asdm::RowTransformer< FocusRow >

Detailed Description

The FocusRow class is a row of a FocusTable.

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

Definition at line 116 of file FocusRow.h.

Constructor & Destructor Documentation

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

friend class asdm::TableStreamReader<FocusTable, FocusRow>;

asdm::FocusRow::FocusRow ( FocusTable & table ) [private]

Create a FocusRow.

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

Create a FocusRow using a copy constructor mechanism.

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

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

void asdm::FocusRow::clearMeasuredFocusPosition ( )

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

void asdm::FocusRow::clearMeasuredFocusRotation ( )

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

bool asdm::FocusRow::compareNoAutoInc	(	Tag	antennaId,
		ArrayTimeInterval	timeInterval,
		bool	focusTracking,
		vector< Length >	focusOffset,
		vector< Angle >	focusRotationOffset,
		int	focusModelId
	)

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

Parameters:

	antennaId
	timeInterval
	focusTracking
	focusOffset
	focusRotationOffset
	focusModelId

bool asdm::FocusRow::compareRequiredValue	(	bool	focusTracking,
		vector< Length >	focusOffset,
		vector< Angle >	focusRotationOffset,
		int	focusModelId
	)

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:

	focusTracking
	focusOffset
	focusRotationOffset
	focusModelId

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

Returns:: a boolean.

void asdm::FocusRow::focusModelIdFromBin ( EndianIStream & eis ) [private]

void asdm::FocusRow::focusModelIdFromText ( const string & s ) [private]

void asdm::FocusRow::focusOffsetFromBin ( EndianIStream & eis ) [private]

void asdm::FocusRow::focusOffsetFromText ( const string & s ) [private]

void asdm::FocusRow::focusRotationOffsetFromBin ( EndianIStream & eis ) [private]

void asdm::FocusRow::focusRotationOffsetFromText ( const string & s ) [private]

void asdm::FocusRow::focusTrackingFromBin ( EndianIStream & eis ) [private]

void asdm::FocusRow::focusTrackingFromText ( const string & s ) [private]

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

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

Returns:: a AntennaRow*

int asdm::FocusRow::getFocusModelId ( ) const

===> Attribute focusModelId

Get focusModelId.

Returns:: focusModelId as int

vector<FocusModelRow *> asdm::FocusRow::getFocusModels ( )

===> Slice link from a row of Focus table to a collection of row of FocusModel table.

Get the collection of row in the FocusModel table having focusModelId == this.focusModelId

Returns:: a vector of FocusModelRow *

vector<Length > asdm::FocusRow::getFocusOffset ( ) const

===> Attribute focusOffset

Get focusOffset.

Returns:: focusOffset as vector<Length >

vector<Angle > asdm::FocusRow::getFocusRotationOffset ( ) const

===> Attribute focusRotationOffset

Get focusRotationOffset.

Returns:: focusRotationOffset as vector<Angle >

bool asdm::FocusRow::getFocusTracking ( ) const

===> Attribute focusTracking

Get focusTracking.

Returns:: focusTracking as bool

vector<Length > asdm::FocusRow::getMeasuredFocusPosition ( ) const

Get measuredFocusPosition, which is optional.

Returns:: measuredFocusPosition as vector<Length >

Exceptions:

IllegalAccessException

If measuredFocusPosition does not exist.

vector<Angle > asdm::FocusRow::getMeasuredFocusRotation ( ) const

Get measuredFocusRotation, which is optional.

Returns:: measuredFocusRotation as vector<Angle >

Exceptions:

IllegalAccessException

If measuredFocusRotation does not exist.

FocusTable& asdm::FocusRow::getTable ( ) const

Return the table to which this row belongs.

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

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

bool asdm::FocusRow::isAdded ( ) const

Has this row been added to its table ?

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

bool asdm::FocusRow::isMeasuredFocusPositionExists ( ) const

===> Attribute measuredFocusPosition, which is optional

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

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

bool asdm::FocusRow::isMeasuredFocusRotationExists ( ) const

===> Attribute measuredFocusRotation, which is optional

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

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

void asdm::FocusRow::measuredFocusPositionFromBin ( EndianIStream & eis ) [private]

void asdm::FocusRow::measuredFocusPositionFromText ( const string & s ) [private]

void asdm::FocusRow::measuredFocusRotationFromBin ( EndianIStream & eis ) [private]

void asdm::FocusRow::measuredFocusRotationFromText ( const string & s ) [private]

void asdm::FocusRow::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::FocusRow::setFocusModelId ( int focusModelId )

Set focusModelId with the specified int.

Parameters:

focusModelId

The int value to which focusModelId is to be set.

void asdm::FocusRow::setFocusOffset ( vector< Length > focusOffset )

Set focusOffset with the specified vector<Length >.

Parameters:

focusOffset

The vector<Length > value to which focusOffset is to be set.

void asdm::FocusRow::setFocusRotationOffset ( vector< Angle > focusRotationOffset )

Set focusRotationOffset with the specified vector<Angle >.

Parameters:

focusRotationOffset

The vector<Angle > value to which focusRotationOffset is to be set.

void asdm::FocusRow::setFocusTracking ( bool focusTracking )

Set focusTracking with the specified bool.

Parameters:

focusTracking

The bool value to which focusTracking is to be set.

void asdm::FocusRow::setFromIDL ( asdmIDL::FocusRowIDL x )

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

Parameters:

x

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

Exceptions:

ConversionException

void asdm::FocusRow::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::FocusRow::setMeasuredFocusPosition ( vector< Length > measuredFocusPosition )

Set measuredFocusPosition with the specified vector<Length >.

Parameters:

measuredFocusPosition

The vector<Length > value to which measuredFocusPosition is to be set.

void asdm::FocusRow::setMeasuredFocusRotation ( vector< Angle > measuredFocusRotation )

Set measuredFocusRotation with the specified vector<Angle >.

Parameters:

measuredFocusRotation

The vector<Angle > value to which measuredFocusRotation is to be set.

void asdm::FocusRow::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::FocusRow::timeIntervalFromBin ( EndianIStream & eis ) [private]

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

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

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

Parameters:

x

a reference to the FocusRowIDL struct to be set.

asdmIDL::FocusRowIDL* asdm::FocusRow::toIDL ( ) const

Return this row in the form of an IDL struct.

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

std::string asdm::FocusRow::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::FocusTable [friend]

Definition at line 117 of file FocusRow.h.

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

Definition at line 118 of file FocusRow.h.

Member Data Documentation

Extrinsic Table asdm::FocusRow::Attributes

Definition at line 349 of file FocusRow.h.

Extrinsic Table asdm::FocusRow::Attributes

Definition at line 141 of file FocusRow.h.

int asdm::FocusRow::focusModelId [private]

===> Attribute focusModelId

Definition at line 709 of file FocusRow.h.

vector<Length > asdm::FocusRow::focusOffset [private]

===> Attribute focusOffset

Definition at line 646 of file FocusRow.h.

vector<Angle > asdm::FocusRow::focusRotationOffset [private]

===> Attribute focusRotationOffset

Definition at line 657 of file FocusRow.h.

bool asdm::FocusRow::focusTracking [private]

===> Attribute focusTracking

Definition at line 635 of file FocusRow.h.

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

Definition at line 737 of file FocusRow.h.

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

Definition at line 753 of file FocusRow.h.

bool asdm::FocusRow::hasBeenAdded [private]

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

Definition at line 580 of file FocusRow.h.

vector<Length > asdm::FocusRow::measuredFocusPosition [private]

Definition at line 670 of file FocusRow.h.

bool asdm::FocusRow::measuredFocusPositionExists [private]

===> Attribute measuredFocusPosition, which is optional

Definition at line 667 of file FocusRow.h.

vector<Angle > asdm::FocusRow::measuredFocusRotation [private]

Definition at line 683 of file FocusRow.h.

bool asdm::FocusRow::measuredFocusRotationExists [private]

===> Attribute measuredFocusRotation, which is optional

Definition at line 680 of file FocusRow.h.

FocusTable& asdm::FocusRow::table [private]

The table to which this row belongs.

Definition at line 576 of file FocusRow.h.

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

code/alma/ASDM/FocusRow.h

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