asdm::ReceiverRow Class Reference

The ReceiverRow class is a row of a ReceiverTable. More...

#include <ReceiverRow.h>

List of all members.

Public Member Functions

virtual ~ReceiverRow ()
 friend class asdm::TableStreamReader<ReceiverTable, ReceiverRow>;
ReceiverTablegetTable () const
 Return the table to which this row belongs.
bool isAdded () const
 Has this row been added to its table ?
ArrayTimeInterval getTimeInterval () const
 ===> Attribute timeInterval
void setTimeInterval (ArrayTimeInterval timeInterval)
 Set timeInterval with the specified ArrayTimeInterval.
string getName () const
 ===> Attribute name
void setName (string name)
 Set name with the specified string.
int getNumLO () const
 ===> Attribute numLO
void setNumLO (int numLO)
 Set numLO with the specified int.
ReceiverBandMod::ReceiverBand getFrequencyBand () const
 ===> Attribute frequencyBand
void setFrequencyBand (ReceiverBandMod::ReceiverBand frequencyBand)
 Set frequencyBand with the specified ReceiverBandMod::ReceiverBand.
vector< FrequencygetFreqLO () const
 ===> Attribute freqLO
void setFreqLO (vector< Frequency > freqLO)
 Set freqLO with the specified vector<Frequency >.
ReceiverSidebandMod::ReceiverSideband getReceiverSideband () const
 ===> Attribute receiverSideband
void setReceiverSideband (ReceiverSidebandMod::ReceiverSideband receiverSideband)
 Set receiverSideband with the specified ReceiverSidebandMod::ReceiverSideband.
vector
< NetSidebandMod::NetSideband > 
getSidebandLO () const
 ===> Attribute sidebandLO
void setSidebandLO (vector< NetSidebandMod::NetSideband > sidebandLO)
 Set sidebandLO with the specified vector<NetSidebandMod::NetSideband >.
void setSpectralWindowId (Tag spectralWindowId)
 Set spectralWindowId with the specified Tag.
Links *SpectralWindowRowgetSpectralWindowUsingSpectralWindowId ()
 spectralWindowId pointer to the row in the SpectralWindow table having SpectralWindow.spectralWindowId == spectralWindowId
bool compareNoAutoInc (Tag spectralWindowId, ArrayTimeInterval timeInterval, string name, int numLO, ReceiverBandMod::ReceiverBand frequencyBand, vector< Frequency > freqLO, ReceiverSidebandMod::ReceiverSideband receiverSideband, vector< NetSidebandMod::NetSideband > sidebandLO)
 Compare each mandatory attribute except the autoincrementable one of this ReceiverRow with the corresponding parameters and return true if there is a match and false otherwise.
bool compareRequiredValue (string name, int numLO, ReceiverBandMod::ReceiverBand frequencyBand, vector< Frequency > freqLO, ReceiverSidebandMod::ReceiverSideband receiverSideband, vector< NetSidebandMod::NetSideband > sidebandLO)
 Compare each mandatory value (i.e.
bool equalByRequiredValue (ReceiverRow *x)
 Return true if all required attributes of the value part are equal to their homologues in x and false otherwise.
asdmIDL::ReceiverRowIDL * toIDL () const
 Return this row in the form of an IDL struct.
void toIDL (asdmIDL::ReceiverRowIDL &x) const
 Define the content of a ReceiverRowIDL struct from the values found in this row.
void setFromIDL (asdmIDL::ReceiverRowIDL x)
 Fill the values of this row from the IDL struct ReceiverRowIDL.
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.
 ReceiverRow (ReceiverTable &table)
 Create a ReceiverRow.
 ReceiverRow (ReceiverTable &table, ReceiverRow &row)
 Create a ReceiverRow using a copy constructor mechanism.
void setReceiverId (int receiverId)
 Set receiverId with the specified int value.
void receiverIdFromBin (EndianIStream &eis)
void spectralWindowIdFromBin (EndianIStream &eis)
void timeIntervalFromBin (EndianIStream &eis)
void nameFromBin (EndianIStream &eis)
void numLOFromBin (EndianIStream &eis)
void frequencyBandFromBin (EndianIStream &eis)
void freqLOFromBin (EndianIStream &eis)
void receiverSidebandFromBin (EndianIStream &eis)
void sidebandLOFromBin (EndianIStream &eis)
void receiverIdFromText (const string &s)
void spectralWindowIdFromText (const string &s)
void timeIntervalFromText (const string &s)
void nameFromText (const string &s)
void numLOFromText (const string &s)
void frequencyBandFromText (const string &s)
void freqLOFromText (const string &s)
void receiverSidebandFromText (const string &s)
void sidebandLOFromText (const string &s)
void toBin (EndianOSStream &eoss)
 Serialize this into a stream of bytes written to an EndianOSStream.

Private Attributes

ReceiverTabletable
 The table to which this row belongs.
bool hasBeenAdded
 Whether this row has been added to the table or not.
ArrayTimeInterval timeInterval
 ===> Attribute timeInterval
string name
 ===> Attribute name
int numLO
 ===> Attribute numLO
ReceiverBandMod::ReceiverBand frequencyBand
 ===> Attribute frequencyBand
vector< FrequencyfreqLO
 ===> Attribute freqLO
ReceiverSidebandMod::ReceiverSideband receiverSideband
 ===> Attribute receiverSideband
vector
< NetSidebandMod::NetSideband > 
sidebandLO
 ===> Attribute sidebandLO
Links *binary deserialization
material from an EndianIStream
std::map< std::string,
ReceiverAttributeFromBin
fromBinMethods
*text deserialization material
std::map< std::string,
ReceiverAttributeFromText
fromTextMethods

Friends

class asdm::ReceiverTable
class asdm::RowTransformer< ReceiverRow >

Detailed Description

The ReceiverRow class is a row of a ReceiverTable.

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

Definition at line 119 of file ReceiverRow.h.


Constructor & Destructor Documentation

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

friend class asdm::TableStreamReader<ReceiverTable, ReceiverRow>;

asdm::ReceiverRow::ReceiverRow ( ReceiverTable table  )  [private]

Create a ReceiverRow.

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::ReceiverRow::ReceiverRow ( ReceiverTable table,
ReceiverRow row 
) [private]

Create a ReceiverRow using a copy constructor mechanism.

Given a ReceiverRow row and a ReceiverTable table, the method creates a new ReceiverRow 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

bool asdm::ReceiverRow::compareNoAutoInc ( Tag  spectralWindowId,
ArrayTimeInterval  timeInterval,
string  name,
int  numLO,
ReceiverBandMod::ReceiverBand  frequencyBand,
vector< Frequency freqLO,
ReceiverSidebandMod::ReceiverSideband  receiverSideband,
vector< NetSidebandMod::NetSideband >  sidebandLO 
)

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

Parameters:
spectralWindowId 
timeInterval 
name 
numLO 
frequencyBand 
freqLO 
receiverSideband 
sidebandLO 
bool asdm::ReceiverRow::compareRequiredValue ( string  name,
int  numLO,
ReceiverBandMod::ReceiverBand  frequencyBand,
vector< Frequency freqLO,
ReceiverSidebandMod::ReceiverSideband  receiverSideband,
vector< NetSidebandMod::NetSideband >  sidebandLO 
)

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 
numLO 
frequencyBand 
freqLO 
receiverSideband 
sidebandLO 
bool asdm::ReceiverRow::equalByRequiredValue ( ReceiverRow 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 ReceiverRow whose required attributes of the value part will be compared with those of this.
Returns:
a boolean.
void asdm::ReceiverRow::freqLOFromBin ( EndianIStream eis  )  [private]
void asdm::ReceiverRow::freqLOFromText ( const string &  s  )  [private]
void asdm::ReceiverRow::frequencyBandFromBin ( EndianIStream eis  )  [private]
void asdm::ReceiverRow::frequencyBandFromText ( const string &  s  )  [private]
vector<Frequency > asdm::ReceiverRow::getFreqLO (  )  const

===> Attribute freqLO

Get freqLO.

Returns:
freqLO as vector<Frequency >
ReceiverBandMod::ReceiverBand asdm::ReceiverRow::getFrequencyBand (  )  const

===> Attribute frequencyBand

Get frequencyBand.

Returns:
frequencyBand as ReceiverBandMod::ReceiverBand
string asdm::ReceiverRow::getName (  )  const

===> Attribute name

Get name.

Returns:
name as string
int asdm::ReceiverRow::getNumLO (  )  const

===> Attribute numLO

Get numLO.

Returns:
numLO as int
ReceiverSidebandMod::ReceiverSideband asdm::ReceiverRow::getReceiverSideband (  )  const

===> Attribute receiverSideband

Get receiverSideband.

Returns:
receiverSideband as ReceiverSidebandMod::ReceiverSideband
vector<NetSidebandMod::NetSideband > asdm::ReceiverRow::getSidebandLO (  )  const

===> Attribute sidebandLO

Get sidebandLO.

Returns:
sidebandLO as vector<NetSidebandMod::NetSideband >
Links* SpectralWindowRow* asdm::ReceiverRow::getSpectralWindowUsingSpectralWindowId (  ) 

spectralWindowId pointer to the row in the SpectralWindow table having SpectralWindow.spectralWindowId == spectralWindowId

Returns:
a SpectralWindowRow*
ReceiverTable& asdm::ReceiverRow::getTable (  )  const

Return the table to which this row belongs.

ArrayTimeInterval asdm::ReceiverRow::getTimeInterval (  )  const

===> Attribute timeInterval

Get timeInterval.

Returns:
timeInterval as ArrayTimeInterval
void asdm::ReceiverRow::isAdded ( bool  added  )  [private]

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

bool asdm::ReceiverRow::isAdded (  )  const

Has this row been added to its table ?

Returns:
true if and only if it has been added.
void asdm::ReceiverRow::nameFromBin ( EndianIStream eis  )  [private]
void asdm::ReceiverRow::nameFromText ( const string &  s  )  [private]
void asdm::ReceiverRow::numLOFromBin ( EndianIStream eis  )  [private]
void asdm::ReceiverRow::numLOFromText ( const string &  s  )  [private]
void asdm::ReceiverRow::receiverIdFromBin ( EndianIStream eis  )  [private]
void asdm::ReceiverRow::receiverIdFromText ( const string &  s  )  [private]
void asdm::ReceiverRow::receiverSidebandFromBin ( EndianIStream eis  )  [private]
void asdm::ReceiverRow::receiverSidebandFromText ( const string &  s  )  [private]
void asdm::ReceiverRow::setFreqLO ( vector< Frequency freqLO  ) 

Set freqLO with the specified vector<Frequency >.

Parameters:
freqLO The vector<Frequency > value to which freqLO is to be set.
void asdm::ReceiverRow::setFrequencyBand ( ReceiverBandMod::ReceiverBand  frequencyBand  ) 

Set frequencyBand with the specified ReceiverBandMod::ReceiverBand.

Parameters:
frequencyBand The ReceiverBandMod::ReceiverBand value to which frequencyBand is to be set.
void asdm::ReceiverRow::setFromIDL ( asdmIDL::ReceiverRowIDL  x  ) 

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

Parameters:
x The IDL struct containing the values used to fill this row.
Exceptions:
ConversionException 
void asdm::ReceiverRow::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::ReceiverRow::setName ( string  name  ) 

Set name with the specified string.

Parameters:
name The string value to which name is to be set.
void asdm::ReceiverRow::setNumLO ( int  numLO  ) 

Set numLO with the specified int.

Parameters:
numLO The int value to which numLO is to be set.
void asdm::ReceiverRow::setReceiverId ( int  receiverId  )  [private]

Set receiverId with the specified int value.

Parameters:
receiverId The int value to which receiverId 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::ReceiverRow::setReceiverSideband ( ReceiverSidebandMod::ReceiverSideband  receiverSideband  ) 

Set receiverSideband with the specified ReceiverSidebandMod::ReceiverSideband.

Parameters:
receiverSideband The ReceiverSidebandMod::ReceiverSideband value to which receiverSideband is to be set.
void asdm::ReceiverRow::setSidebandLO ( vector< NetSidebandMod::NetSideband >  sidebandLO  ) 

Set sidebandLO with the specified vector<NetSidebandMod::NetSideband >.

Parameters:
sidebandLO The vector<NetSidebandMod::NetSideband > value to which sidebandLO is to be set.
void asdm::ReceiverRow::setSpectralWindowId ( Tag  spectralWindowId  ) 

Set spectralWindowId with the specified Tag.

Parameters:
spectralWindowId The Tag value to which spectralWindowId 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::ReceiverRow::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::ReceiverRow::sidebandLOFromBin ( EndianIStream eis  )  [private]
void asdm::ReceiverRow::sidebandLOFromText ( const string &  s  )  [private]
void asdm::ReceiverRow::spectralWindowIdFromBin ( EndianIStream eis  )  [private]
void asdm::ReceiverRow::spectralWindowIdFromText ( const string &  s  )  [private]
void asdm::ReceiverRow::timeIntervalFromBin ( EndianIStream eis  )  [private]
void asdm::ReceiverRow::timeIntervalFromText ( const string &  s  )  [private]
void asdm::ReceiverRow::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::ReceiverRow::toIDL ( asdmIDL::ReceiverRowIDL &  x  )  const

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

Parameters:
x a reference to the ReceiverRowIDL struct to be set.
asdmIDL::ReceiverRowIDL* asdm::ReceiverRow::toIDL (  )  const

Return this row in the form of an IDL struct.

Returns:
The values of this row as a ReceiverRowIDL struct.
std::string asdm::ReceiverRow::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::ReceiverTable [friend]

Definition at line 120 of file ReceiverRow.h.

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

Definition at line 121 of file ReceiverRow.h.


Member Data Documentation

Definition at line 380 of file ReceiverRow.h.

Definition at line 144 of file ReceiverRow.h.

===> Attribute freqLO

Definition at line 684 of file ReceiverRow.h.

ReceiverBandMod::ReceiverBand asdm::ReceiverRow::frequencyBand [private]

===> Attribute frequencyBand

Definition at line 673 of file ReceiverRow.h.

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

Definition at line 743 of file ReceiverRow.h.

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

Definition at line 760 of file ReceiverRow.h.

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

Definition at line 573 of file ReceiverRow.h.

string asdm::ReceiverRow::name [private]

===> Attribute name

Definition at line 651 of file ReceiverRow.h.

int asdm::ReceiverRow::numLO [private]

===> Attribute numLO

Definition at line 662 of file ReceiverRow.h.

ReceiverSidebandMod::ReceiverSideband asdm::ReceiverRow::receiverSideband [private]

===> Attribute receiverSideband

Definition at line 695 of file ReceiverRow.h.

vector<NetSidebandMod::NetSideband > asdm::ReceiverRow::sidebandLO [private]

===> Attribute sidebandLO

Definition at line 706 of file ReceiverRow.h.

The table to which this row belongs.

Definition at line 569 of file ReceiverRow.h.

===> Attribute timeInterval

Definition at line 640 of file ReceiverRow.h.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

Generated on 31 Aug 2016 for casa by  doxygen 1.6.1