casa  5.7.0-16
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Public Attributes | Private Member Functions | Private Attributes | Friends | List of all members
asdm::AntennaRow Class Reference

The AntennaRow class is a row of a AntennaTable. More...

#include <AntennaRow.h>

Public Member Functions

virtual ~AntennaRow ()
 friend class asdm::TableStreamReader<AntennaTable, AntennaRow>; More...
 
AntennaTablegetTable () const
 Return the table to which this row belongs. More...
 
bool isAdded () const
 Has this row been added to its table ? More...
 
std::string getName () const
 ===> Attribute name More...
 
void setName (std::string name)
 Set name with the specified std::string. More...
 
AntennaMakeMod::AntennaMake getAntennaMake () const
 ===> Attribute antennaMake More...
 
void setAntennaMake (AntennaMakeMod::AntennaMake antennaMake)
 Set antennaMake with the specified AntennaMakeMod::AntennaMake. More...
 
AntennaTypeMod::AntennaType getAntennaType () const
 ===> Attribute antennaType More...
 
void setAntennaType (AntennaTypeMod::AntennaType antennaType)
 Set antennaType with the specified AntennaTypeMod::AntennaType. More...
 
Length getDishDiameter () const
 ===> Attribute dishDiameter More...
 
void setDishDiameter (Length dishDiameter)
 Set dishDiameter with the specified Length. More...
 
std::vector< LengthgetPosition () const
 ===> Attribute position More...
 
void setPosition (std::vector< Length > position)
 Set position with the specified std::vector<Length >. More...
 
std::vector< LengthgetOffset () const
 ===> Attribute offset More...
 
void setOffset (std::vector< Length > offset)
 Set offset with the specified std::vector<Length >. More...
 
ArrayTime getTime () const
 ===> Attribute time More...
 
void setTime (ArrayTime time)
 Set time with the specified ArrayTime. More...
 
Tag getAssocAntennaId () const
 Get assocAntennaId, which is optional. More...
 
void setAssocAntennaId (Tag assocAntennaId)
 Set assocAntennaId with the specified Tag. More...
 
void clearAssocAntennaId ()
 Mark assocAntennaId, which is an optional field, as non-existent. More...
 
Tag getStationId () const
 ===> Attribute stationId More...
 
void setStationId (Tag stationId)
 Set stationId with the specified Tag. More...
 
AntennaRowgetAssociatedAntenna () const
 Get the optional row in table Antenna by traversing the defined link to that table. More...
 
void setAssociatedAntennaLink (Tag assocAntennaId)
 Set the values of the link attributes needed to link this row to a row in table Antenna. More...
 
StationRowgetStationUsingStationId ()
 stationId pointer to the row in the Station table having Station.stationId == stationId More...
 
bool compareNoAutoInc (std::string name, AntennaMakeMod::AntennaMake antennaMake, AntennaTypeMod::AntennaType antennaType, Length dishDiameter, std::vector< Length > position, std::vector< Length > offset, ArrayTime time, Tag stationId)
 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. More...
 
bool compareRequiredValue (std::string name, AntennaMakeMod::AntennaMake antennaMake, AntennaTypeMod::AntennaType antennaType, Length dishDiameter, std::vector< Length > position, std::vector< Length > offset, ArrayTime time, Tag stationId)
 Compare each mandatory value (i.e. More...
 
bool equalByRequiredValue (AntennaRow *x)
 Return true if all required attributes of the value part are equal to their homologues in x and false otherwise. More...
 
asdmIDL::AntennaRowIDL * toIDL () const
 Return this row in the form of an IDL struct. More...
 
void toIDL (asdmIDL::AntennaRowIDL &x) const
 Define the content of a AntennaRowIDL struct from the values found in this row. More...
 
void setFromIDL (asdmIDL::AntennaRowIDL x)
 Fill the values of this row from the IDL struct AntennaRowIDL. More...
 
std::string toXML () const
 Return this row in the form of an XML string. More...
 
void setFromXML (std::string rowDoc)
 Fill the values of this row from an XML string that was produced by the toXML() method. More...
 

Public Attributes

Intrinsic Table Attributes
 
Extrinsic Table Attributes
 
 Links
 

Private Member Functions

void isAdded (bool added)
 This method is used by the Table class when this row is added to the table. More...
 
 AntennaRow (AntennaTable &table)
 Create a AntennaRow. More...
 
 AntennaRow (AntennaTable &table, AntennaRow *row)
 Create a AntennaRow using a copy constructor mechanism. More...
 
void setAntennaId (Tag antennaId)
 Set antennaId with the specified Tag value. More...
 
void antennaIdFromBin (EndianIStream &eis)
 
void nameFromBin (EndianIStream &eis)
 
void antennaMakeFromBin (EndianIStream &eis)
 
void antennaTypeFromBin (EndianIStream &eis)
 
void dishDiameterFromBin (EndianIStream &eis)
 
void positionFromBin (EndianIStream &eis)
 
void offsetFromBin (EndianIStream &eis)
 
void timeFromBin (EndianIStream &eis)
 
void stationIdFromBin (EndianIStream &eis)
 
void assocAntennaIdFromBin (EndianIStream &eis)
 
void antennaIdFromText (const std::string &s)
 
void nameFromText (const std::string &s)
 
void antennaMakeFromText (const std::string &s)
 
void antennaTypeFromText (const std::string &s)
 
void dishDiameterFromText (const std::string &s)
 
void positionFromText (const std::string &s)
 
void offsetFromText (const std::string &s)
 
void timeFromText (const std::string &s)
 
void stationIdFromText (const std::string &s)
 
void assocAntennaIdFromText (const std::string &s)
 
void toBin (EndianOSStream &eoss)
 Serialize this into a stream of bytes written to an EndianOSStream. More...
 

Private Attributes

AntennaTabletable
 The table to which this row belongs. More...
 
bool hasBeenAdded
 Whether this row has been added to the table or not. More...
 
std::string name
 ===> Attribute name More...
 
AntennaMakeMod::AntennaMake antennaMake
 ===> Attribute antennaMake More...
 
AntennaTypeMod::AntennaType antennaType
 ===> Attribute antennaType More...
 
Length dishDiameter
 ===> Attribute dishDiameter More...
 
std::vector< Lengthposition
 ===> Attribute position More...
 
std::vector< Lengthoffset
 ===> Attribute offset More...
 
ArrayTime time
 ===> Attribute time More...
 
Tag assocAntennaId
 
Tag stationId
 ===> Attribute stationId More...
 
Links *binary deserialization
material from an EndianIStream
std::map< std::string,
AntennaAttributeFromBin
fromBinMethods
 
*text deserialization material
std::map< std::string,
AntennaAttributeFromText
fromTextMethods
 

Friends

class asdm::AntennaTable
 
class asdm::RowTransformer< AntennaRow >
 

Detailed Description

The AntennaRow class is a row of a AntennaTable.

Generated from model's revision "-1", branch ""

Definition at line 120 of file AntennaRow.h.

Constructor & Destructor Documentation

virtual asdm::AntennaRow::~AntennaRow ( )
virtual

friend class asdm::TableStreamReader<AntennaTable, AntennaRow>;

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
tableThe 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
tableThe table to which this row belongs.
rowThe row which is to be copied.

Member Function Documentation

void asdm::AntennaRow::antennaIdFromBin ( EndianIStream eis)
private
void asdm::AntennaRow::antennaIdFromText ( const std::string &  s)
private
void asdm::AntennaRow::antennaMakeFromBin ( EndianIStream eis)
private
void asdm::AntennaRow::antennaMakeFromText ( const std::string &  s)
private
void asdm::AntennaRow::antennaTypeFromBin ( EndianIStream eis)
private
void asdm::AntennaRow::antennaTypeFromText ( const std::string &  s)
private
void asdm::AntennaRow::assocAntennaIdFromBin ( EndianIStream eis)
private
void asdm::AntennaRow::assocAntennaIdFromText ( const std::string &  s)
private
void asdm::AntennaRow::clearAssocAntennaId ( )

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

bool asdm::AntennaRow::compareNoAutoInc ( std::string  name,
AntennaMakeMod::AntennaMake  antennaMake,
AntennaTypeMod::AntennaType  antennaType,
Length  dishDiameter,
std::vector< Length position,
std::vector< Length offset,
ArrayTime  time,
Tag  stationId 
)

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.

Parameters
name
antennaMake
antennaType
dishDiameter
position
offset
time
stationId
bool asdm::AntennaRow::compareRequiredValue ( std::string  name,
AntennaMakeMod::AntennaMake  antennaMake,
AntennaTypeMod::AntennaType  antennaType,
Length  dishDiameter,
std::vector< Length position,
std::vector< Length offset,
ArrayTime  time,
Tag  stationId 
)

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
name
antennaMake
antennaType
dishDiameter
position
offset
time
stationId
void asdm::AntennaRow::dishDiameterFromBin ( EndianIStream eis)
private
void asdm::AntennaRow::dishDiameterFromText ( const std::string &  s)
private
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
xa pointer on the AntennaRow whose required attributes of the value part will be compared with those of this.
Returns
a boolean.
AntennaMakeMod::AntennaMake asdm::AntennaRow::getAntennaMake ( ) const

===> Attribute antennaMake

Get antennaMake.

Returns
antennaMake as AntennaMakeMod::AntennaMake
AntennaTypeMod::AntennaType asdm::AntennaRow::getAntennaType ( ) const

===> Attribute antennaType

Get antennaType.

Returns
antennaType as AntennaTypeMod::AntennaType
Tag asdm::AntennaRow::getAssocAntennaId ( ) const

Get assocAntennaId, which is optional.

Returns
assocAntennaId as Tag
Exceptions
IllegalAccessExceptionIf assocAntennaId does not exist.
AntennaRow* asdm::AntennaRow::getAssociatedAntenna ( ) const

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

Returns
A row in Antenna table.
Exceptions
NoSuchRowif there is no such row in table Antenna or the link does not exist.
Length asdm::AntennaRow::getDishDiameter ( ) const

===> Attribute dishDiameter

Get dishDiameter.

Returns
dishDiameter as Length
std::string asdm::AntennaRow::getName ( ) const

===> Attribute name

Get name.

Returns
name as std::string
std::vector<Length > asdm::AntennaRow::getOffset ( ) const

===> Attribute offset

Get offset.

Returns
offset as std::vector<Length >
std::vector<Length > asdm::AntennaRow::getPosition ( ) const

===> Attribute position

Get position.

Returns
position as std::vector<Length >
Tag asdm::AntennaRow::getStationId ( ) const

===> Attribute stationId

Get stationId.

Returns
stationId as Tag
StationRow* asdm::AntennaRow::getStationUsingStationId ( )

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

Returns
a StationRow*
AntennaTable& asdm::AntennaRow::getTable ( ) const

Return the table to which this row belongs.

ArrayTime asdm::AntennaRow::getTime ( ) const

===> Attribute time

Get time.

Returns
time as ArrayTime
bool asdm::AntennaRow::isAdded ( ) const

Has this row been added to its table ?

Returns
true if and only if it has been added.
void asdm::AntennaRow::isAdded ( bool  added)
private

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

void asdm::AntennaRow::nameFromBin ( EndianIStream eis)
private
void asdm::AntennaRow::nameFromText ( const std::string &  s)
private
void asdm::AntennaRow::offsetFromBin ( EndianIStream eis)
private
void asdm::AntennaRow::offsetFromText ( const std::string &  s)
private
void asdm::AntennaRow::positionFromBin ( EndianIStream eis)
private
void asdm::AntennaRow::positionFromText ( const std::string &  s)
private
void asdm::AntennaRow::setAntennaId ( Tag  antennaId)
private

Set antennaId with the specified Tag value.

Parameters
antennaIdThe Tag value to which antennaId is to be set.
Exceptions
IllegalAccessExceptionIf an attempt is made to change this field after is has been added to the table.
void asdm::AntennaRow::setAntennaMake ( AntennaMakeMod::AntennaMake  antennaMake)

Set antennaMake with the specified AntennaMakeMod::AntennaMake.

Parameters
antennaMakeThe AntennaMakeMod::AntennaMake value to which antennaMake is to be set.
void asdm::AntennaRow::setAntennaType ( AntennaTypeMod::AntennaType  antennaType)

Set antennaType with the specified AntennaTypeMod::AntennaType.

Parameters
antennaTypeThe AntennaTypeMod::AntennaType value to which antennaType is to be set.
void asdm::AntennaRow::setAssocAntennaId ( Tag  assocAntennaId)

Set assocAntennaId with the specified Tag.

Parameters
assocAntennaIdThe Tag value to which assocAntennaId is to be set.
void asdm::AntennaRow::setAssociatedAntennaLink ( Tag  assocAntennaId)

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

void asdm::AntennaRow::setDishDiameter ( Length  dishDiameter)

Set dishDiameter with the specified Length.

Parameters
dishDiameterThe Length value to which dishDiameter is to be set.
void asdm::AntennaRow::setFromIDL ( asdmIDL::AntennaRowIDL  x)

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

Parameters
xThe IDL struct containing the values used to fill this row.
Exceptions
ConversionException
void asdm::AntennaRow::setFromXML ( std::string  rowDoc)

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

Parameters
rowDocthe XML string being used to set the values of this row.
Exceptions
ConversionException
void asdm::AntennaRow::setName ( std::string  name)

Set name with the specified std::string.

Parameters
nameThe std::string value to which name is to be set.
void asdm::AntennaRow::setOffset ( std::vector< Length offset)

Set offset with the specified std::vector<Length >.

Parameters
offsetThe std::vector<Length > value to which offset is to be set.
void asdm::AntennaRow::setPosition ( std::vector< Length position)

Set position with the specified std::vector<Length >.

Parameters
positionThe std::vector<Length > value to which position is to be set.
void asdm::AntennaRow::setStationId ( Tag  stationId)

Set stationId with the specified Tag.

Parameters
stationIdThe Tag value to which stationId is to be set.
void asdm::AntennaRow::setTime ( ArrayTime  time)

Set time with the specified ArrayTime.

Parameters
timeThe ArrayTime value to which time is to be set.
void asdm::AntennaRow::stationIdFromBin ( EndianIStream eis)
private
void asdm::AntennaRow::stationIdFromText ( const std::string &  s)
private
void asdm::AntennaRow::timeFromBin ( EndianIStream eis)
private
void asdm::AntennaRow::timeFromText ( const std::string &  s)
private
void asdm::AntennaRow::toBin ( EndianOSStream eoss)
private

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

Parameters
eossthe EndianOSStream to be written to
asdmIDL::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::toIDL ( asdmIDL::AntennaRowIDL &  x) const

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

Parameters
xa reference to the AntennaRowIDL struct to be set.
std::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.

Friends And Related Function Documentation

friend class asdm::AntennaTable
friend

Definition at line 121 of file AntennaRow.h.

friend class asdm::RowTransformer< AntennaRow >
friend

Definition at line 122 of file AntennaRow.h.

Member Data Documentation

AntennaMakeMod::AntennaMake asdm::AntennaRow::antennaMake
private

===> Attribute antennaMake

Definition at line 725 of file AntennaRow.h.

AntennaTypeMod::AntennaType asdm::AntennaRow::antennaType
private

===> Attribute antennaType

Definition at line 736 of file AntennaRow.h.

Tag asdm::AntennaRow::assocAntennaId
private

Definition at line 797 of file AntennaRow.h.

Extrinsic Table asdm::AntennaRow::Attributes

Definition at line 145 of file AntennaRow.h.

Extrinsic Table asdm::AntennaRow::Attributes

Definition at line 379 of file AntennaRow.h.

Length asdm::AntennaRow::dishDiameter
private

===> Attribute dishDiameter

Definition at line 747 of file AntennaRow.h.

Links* binary deserialization material from an EndianIStream std::map<std::string, AntennaAttributeFromBin> asdm::AntennaRow::fromBinMethods
private

Definition at line 834 of file AntennaRow.h.

* text deserialization material std::map<std::string, AntennaAttributeFromText> asdm::AntennaRow::fromTextMethods
private

Definition at line 852 of file AntennaRow.h.

bool asdm::AntennaRow::hasBeenAdded
private

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

Definition at line 647 of file AntennaRow.h.

asdm::AntennaRow::Links

Definition at line 459 of file AntennaRow.h.

std::string asdm::AntennaRow::name
private

===> Attribute name

Definition at line 714 of file AntennaRow.h.

std::vector<Length > asdm::AntennaRow::offset
private

===> Attribute offset

Definition at line 769 of file AntennaRow.h.

std::vector<Length > asdm::AntennaRow::position
private

===> Attribute position

Definition at line 758 of file AntennaRow.h.

Tag asdm::AntennaRow::stationId
private

===> Attribute stationId

Definition at line 808 of file AntennaRow.h.

AntennaTable& asdm::AntennaRow::table
private

The table to which this row belongs.

Definition at line 643 of file AntennaRow.h.

ArrayTime asdm::AntennaRow::time
private

===> Attribute time

Definition at line 780 of file AntennaRow.h.


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