asdm::BeamRow Class Reference

The BeamRow class is a row of a BeamTable. More...

#include <BeamRow.h>

List of all members.

Public Member Functions
virtual	~BeamRow ()
BeamTable &	getTable () const
	Return the table to which this row belongs.
bool	isAdded () const
	Has this row been added to its table ?
Extrinsic Table Attributes Links *bool	equalByRequiredValue (BeamRow *x)
	Return true if all required attributes of the value part are equal to their homologues in x and false otherwise.
BeamRowIDL *	toIDL () const
	Return this row in the form of an IDL struct.
void	setFromIDL (BeamRowIDL x)
	Fill the values of this row from the IDL struct BeamRowIDL.
string	toXML () const
	Return this row in the form of an XML string.
void	setFromXML (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.
	BeamRow (BeamTable &table)
	Create a BeamRow.
	BeamRow (BeamTable &table, BeamRow &row)
	Create a BeamRow using a copy constructor mechanism.
void	setBeamId (Tag beamId)
	Set beamId with the specified Tag value.
void	beamIdFromBin (EndianIStream &eis)
void	toBin (EndianOSStream &eoss)
	Serialize this into a stream of bytes written to an EndianOSStream.
Static Private Member Functions
static BeamRow *	fromBin (EndianIStream &eis, BeamTable &table, const vector< string > &attributesSeq)
	Deserialize a stream of bytes read from an EndianIStream to build a PointingRow.
Private Attributes
BeamTable &	table
	The table to which this row belongs.
bool	hasBeenAdded
	Whether this row has been added to the table or not.
Extrinsic Table Attributes Links binary deserialization material map< string, BeamAttributeFromBin >	fromBinMethods
Friends
class	asdm::BeamTable

---

Detailed Description

The BeamRow class is a row of a BeamTable.

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

Definition at line 88 of file BeamRow.h.

---

Constructor & Destructor Documentation

virtual asdm::BeamRow::~BeamRow

(

)

[virtual]

asdm::BeamRow::BeamRow

(

BeamTable &

table

)

[private]

Create a BeamRow.

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

Create a BeamRow using a copy constructor mechanism.

Given a BeamRow row and a BeamTable table, the method creates a new BeamRow 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::BeamRow::beamIdFromBin

(

EndianIStream &

eis

)

[private]

Extrinsic Table Attributes Links* bool asdm::BeamRow::equalByRequiredValue

(

BeamRow *

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

Returns:

a boolean.

static BeamRow* asdm::BeamRow::fromBin	(	EndianIStream &	eis,
		BeamTable &	table,
		const vector< string > &	attributesSeq
	)		[static, private]

Deserialize a stream of bytes read from an EndianIStream to build a PointingRow.

Parameters:

eis	the EndianIStream to be read.
table	the BeamTable to which the row built by deserialization will be parented.
attributesSeq	a vector containing the names of the attributes . The elements order defines the order in which the attributes are written in the binary serialization.

BeamTable& asdm::BeamRow::getTable

(

)

const

Return the table to which this row belongs.

bool asdm::BeamRow::isAdded

(

)

const

Has this row been added to its table ?

Returns:

true if and only if it has been added.

void asdm::BeamRow::isAdded

(

bool

added

)

[private]

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

void asdm::BeamRow::setBeamId

(

Tag

beamId

)

[private]

Set beamId with the specified Tag value.

Parameters:

beamId

The Tag value to which beamId 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::BeamRow::setFromIDL

(

BeamRowIDL

x

)

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

Parameters:

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

Exceptions:

ConversionException

void asdm::BeamRow::setFromXML

(

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::BeamRow::toBin

(

EndianOSStream &

eoss

)

[private]

Serialize this into a stream of bytes written to an EndianOSStream.

Parameters:

eoss	the EndianOSStream to be written to

BeamRowIDL* asdm::BeamRow::toIDL

(

)

const

Return this row in the form of an IDL struct.

Returns:

The values of this row as a BeamRowIDL struct.

string asdm::BeamRow::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::BeamTable [friend]

Definition at line 89 of file BeamRow.h.

---

Member Data Documentation

Intrinsic Table asdm::BeamRow::Attributes

Definition at line 111 of file BeamRow.h.

Extrinsic Table Attributes Links binary deserialization material map<string, BeamAttributeFromBin> asdm::BeamRow::fromBinMethods [private]

Definition at line 267 of file BeamRow.h.

bool asdm::BeamRow::hasBeenAdded [private]

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

Definition at line 193 of file BeamRow.h.

BeamTable& asdm::BeamRow::table [private]

The table to which this row belongs.

Definition at line 189 of file BeamRow.h.

---

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

• code/alma_v3/ASDM/BeamRow.h