asdm::SeeingRow Class Reference

The SeeingRow class is a row of a SeeingTable. More...

#include <SeeingRow.h>

Public Member Functions
virtual	~SeeingRow ()
	friend class asdm::TableStreamReader<SeeingTable, SeeingRow>;
SeeingTable &	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.
int	getNumBaseLength () const
	===> Attribute numBaseLength
void	setNumBaseLength (int numBaseLength)
	Set numBaseLength with the specified int.
vector< Length >	getBaseLength () const
	===> Attribute baseLength
void	setBaseLength (vector< Length > baseLength)
	Set baseLength with the specified vector<Length >.
vector< Angle >	getPhaseRms () const
	===> Attribute phaseRms
void	setPhaseRms (vector< Angle > phaseRms)
	Set phaseRms with the specified vector<Angle >.
float	getSeeing () const
	===> Attribute seeing
void	setSeeing (float seeing)
	Set seeing with the specified float.
float	getExponent () const
	===> Attribute exponent
void	setExponent (float exponent)
	Set exponent with the specified float.
Extrinsic Table Attributes Links *bool	compareNoAutoInc (ArrayTimeInterval timeInterval, int numBaseLength, vector< Length > baseLength, vector< Angle > phaseRms, float seeing, float exponent)
	Compare each mandatory attribute except the autoincrementable one of this SeeingRow with the corresponding parameters and return true if there is a match and false otherwise.
bool	compareRequiredValue (int numBaseLength, vector< Length > baseLength, vector< Angle > phaseRms, float seeing, float exponent)
	Compare each mandatory value (i.e.
bool	equalByRequiredValue (SeeingRow *x)
	Return true if all required attributes of the value part are equal to their homologues in x and false otherwise.
asdmIDL::SeeingRowIDL *	toIDL () const
	Return this row in the form of an IDL struct.
void	toIDL (asdmIDL::SeeingRowIDL &x) const
	Define the content of a SeeingRowIDL struct from the values found in this row.
void	setFromIDL (asdmIDL::SeeingRowIDL x)
	Fill the values of this row from the IDL struct SeeingRowIDL.
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
Private Member Functions
void	isAdded (bool added)
	This method is used by the Table class when this row is added to the table.
	SeeingRow (SeeingTable &table)
	Create a SeeingRow.
	SeeingRow (SeeingTable &table, SeeingRow &row)
	Create a SeeingRow using a copy constructor mechanism.
void	timeIntervalFromBin (EndianIStream &eis)
void	numBaseLengthFromBin (EndianIStream &eis)
void	baseLengthFromBin (EndianIStream &eis)
void	phaseRmsFromBin (EndianIStream &eis)
void	seeingFromBin (EndianIStream &eis)
void	exponentFromBin (EndianIStream &eis)
void	timeIntervalFromText (const string &s)
void	numBaseLengthFromText (const string &s)
void	baseLengthFromText (const string &s)
void	phaseRmsFromText (const string &s)
void	seeingFromText (const string &s)
void	exponentFromText (const string &s)
void	toBin (EndianOSStream &eoss)
	Serialize this into a stream of bytes written to an EndianOSStream.
Private Attributes
SeeingTable &	table
	The table to which this row belongs.
bool	hasBeenAdded
	Whether this row has been added to the table or not.
int	numBaseLength
	===> Attribute numBaseLength
vector< Length >	baseLength
	===> Attribute baseLength
vector< Angle >	phaseRms
	===> Attribute phaseRms
float	seeing
	===> Attribute seeing
float	exponent
	===> Attribute exponent
Extrinsic Table Attributes Links *binary deserialization material from an EndianIStream std::map< std::string, SeeingAttributeFromBin >	fromBinMethods
*text deserialization material std::map< std::string, SeeingAttributeFromText >	fromTextMethods
Friends
class	asdm::SeeingTable
class	asdm::RowTransformer< SeeingRow >

Detailed Description

The SeeingRow class is a row of a SeeingTable.

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

Definition at line 106 of file SeeingRow.h.

Constructor & Destructor Documentation

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

friend class asdm::TableStreamReader<SeeingTable, SeeingRow>;

asdm::SeeingRow::SeeingRow ( SeeingTable & table ) [private]

Create a SeeingRow.

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

Create a SeeingRow using a copy constructor mechanism.

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

void asdm::SeeingRow::baseLengthFromText ( const string & s ) [private]

Extrinsic Table Attributes Links* bool asdm::SeeingRow::compareNoAutoInc	(	ArrayTimeInterval	timeInterval,
		int	numBaseLength,
		vector< Length >	baseLength,
		vector< Angle >	phaseRms,
		float	seeing,
		float	exponent
	)

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

Parameters:

	timeInterval
	numBaseLength
	baseLength
	phaseRms
	seeing
	exponent

bool asdm::SeeingRow::compareRequiredValue	(	int	numBaseLength,
		vector< Length >	baseLength,
		vector< Angle >	phaseRms,
		float	seeing,
		float	exponent
	)

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:

	numBaseLength
	baseLength
	phaseRms
	seeing
	exponent

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

Returns:: a boolean.

void asdm::SeeingRow::exponentFromBin ( EndianIStream & eis ) [private]

void asdm::SeeingRow::exponentFromText ( const string & s ) [private]

vector<Length > asdm::SeeingRow::getBaseLength ( ) const

===> Attribute baseLength

Get baseLength.

Returns:: baseLength as vector<Length >

float asdm::SeeingRow::getExponent ( ) const

===> Attribute exponent

Get exponent.

Returns:: exponent as float

int asdm::SeeingRow::getNumBaseLength ( ) const

===> Attribute numBaseLength

Get numBaseLength.

Returns:: numBaseLength as int

vector<Angle > asdm::SeeingRow::getPhaseRms ( ) const

===> Attribute phaseRms

Get phaseRms.

Returns:: phaseRms as vector<Angle >

float asdm::SeeingRow::getSeeing ( ) const

===> Attribute seeing

Get seeing.

Returns:: seeing as float

SeeingTable& asdm::SeeingRow::getTable ( ) const

Return the table to which this row belongs.

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

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

bool asdm::SeeingRow::isAdded ( ) const

Has this row been added to its table ?

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

void asdm::SeeingRow::numBaseLengthFromBin ( EndianIStream & eis ) [private]

void asdm::SeeingRow::numBaseLengthFromText ( const string & s ) [private]

void asdm::SeeingRow::phaseRmsFromBin ( EndianIStream & eis ) [private]

void asdm::SeeingRow::phaseRmsFromText ( const string & s ) [private]

void asdm::SeeingRow::seeingFromBin ( EndianIStream & eis ) [private]

void asdm::SeeingRow::seeingFromText ( const string & s ) [private]

void asdm::SeeingRow::setBaseLength ( vector< Length > baseLength )

Set baseLength with the specified vector<Length >.

Parameters:

baseLength

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

void asdm::SeeingRow::setExponent ( float exponent )

Set exponent with the specified float.

Parameters:

exponent

The float value to which exponent is to be set.

void asdm::SeeingRow::setFromIDL ( asdmIDL::SeeingRowIDL x )

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

Parameters:

x

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

Exceptions:

ConversionException

void asdm::SeeingRow::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::SeeingRow::setNumBaseLength ( int numBaseLength )

Set numBaseLength with the specified int.

Parameters:

numBaseLength

The int value to which numBaseLength is to be set.

void asdm::SeeingRow::setPhaseRms ( vector< Angle > phaseRms )

Set phaseRms with the specified vector<Angle >.

Parameters:

phaseRms

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

void asdm::SeeingRow::setSeeing ( float seeing )

Set seeing with the specified float.

Parameters:

seeing

The float value to which seeing is to be set.

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

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

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

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

Parameters:

x

a reference to the SeeingRowIDL struct to be set.

asdmIDL::SeeingRowIDL* asdm::SeeingRow::toIDL ( ) const

Return this row in the form of an IDL struct.

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

std::string asdm::SeeingRow::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::RowTransformer< SeeingRow > [friend]

Definition at line 108 of file SeeingRow.h.

friend class asdm::SeeingTable [friend]

Definition at line 107 of file SeeingRow.h.

Member Data Documentation

Intrinsic Table asdm::SeeingRow::Attributes

Definition at line 131 of file SeeingRow.h.

vector<Length > asdm::SeeingRow::baseLength [private]

===> Attribute baseLength

Definition at line 520 of file SeeingRow.h.

float asdm::SeeingRow::exponent [private]

===> Attribute exponent

Definition at line 553 of file SeeingRow.h.

Extrinsic Table Attributes Links* binary deserialization material from an EndianIStream std::map<std::string, SeeingAttributeFromBin> asdm::SeeingRow::fromBinMethods [private]

Definition at line 572 of file SeeingRow.h.

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

Definition at line 586 of file SeeingRow.h.

bool asdm::SeeingRow::hasBeenAdded [private]

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

Definition at line 454 of file SeeingRow.h.

int asdm::SeeingRow::numBaseLength [private]

===> Attribute numBaseLength

Definition at line 509 of file SeeingRow.h.

vector<Angle > asdm::SeeingRow::phaseRms [private]

===> Attribute phaseRms

Definition at line 531 of file SeeingRow.h.

float asdm::SeeingRow::seeing [private]

===> Attribute seeing

Definition at line 542 of file SeeingRow.h.

SeeingTable& asdm::SeeingRow::table [private]

The table to which this row belongs.

Definition at line 450 of file SeeingRow.h.

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

code/alma/ASDM/SeeingRow.h

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