asdm::BeamRow Class Reference

#include <BeamRow.h>

Collaboration diagram for asdm::BeamRow:

Collaboration graph
[legend]
List of all members.

Detailed Description

The BeamRow class is a row of a BeamTable.

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

Definition at line 118 of file BeamRow.h.

Public Member Functions

virtual ~BeamRow ()
BeamTablegetTable () const
 Return the table to which this row belongs.
BeamRowIDL * toIDL () const
 Return this row in the form of an IDL struct.
void setFromIDL (BeamRowIDL x) throw (ConversionException)
 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) throw (ConversionException)
 Fill the values of this row from an XML string that was produced by the toXML() method.
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.

Public Attributes

Intrinsic Table Attributes

Private Member Functions

void isAdded ()
 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.

Private Attributes

BeamTabletable
 The table to which this row belongs.
bool hasBeenAdded
 Whether this row has been added to the table or not.

Friends

class asdm::BeamTable


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

BeamTable& asdm::BeamRow::getTable (  )  const

Return the table to which this row belongs.

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.

void asdm::BeamRow::setFromIDL ( BeamRowIDL  x  )  throw (ConversionException)

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

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

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.

void asdm::BeamRow::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.

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.

void asdm::BeamRow::isAdded (  )  [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.


Friends And Related Function Documentation

friend class asdm::BeamTable [friend]

Definition at line 119 of file BeamRow.h.


Member Data Documentation

Intrinsic Table asdm::BeamRow::Attributes

Definition at line 164 of file BeamRow.h.

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

The table to which this row belongs.

Definition at line 211 of file BeamRow.h.

bool asdm::BeamRow::hasBeenAdded [private]

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

Definition at line 215 of file BeamRow.h.


The documentation for this class was generated from the following file:
Generated on Thu Aug 27 21:23:28 2009 for NRAOCASA by  doxygen 1.5.1