casa  $Rev:20696$
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Public Member Functions | Public Attributes | Private Member Functions | Private Attributes | Friends
asdm::DopplerRow Class Reference

The DopplerRow class is a row of a DopplerTable. More...

#include <DopplerRow.h>

List of all members.

Public Member Functions

virtual ~DopplerRow ()
 friend class asdm::TableStreamReader<DopplerTable, DopplerRow>;
DopplerTablegetTable () const
 Return the table to which this row belongs.
bool isAdded () const
 Has this row been added to its table ?
int getTransitionIndex () const
 ===> Attribute transitionIndex
void setTransitionIndex (int transitionIndex)
 Set transitionIndex with the specified int.
DopplerReferenceCodeMod::DopplerReferenceCode getVelDef () const
 ===> Attribute velDef
void setVelDef (DopplerReferenceCodeMod::DopplerReferenceCode velDef)
 Set velDef with the specified DopplerReferenceCodeMod::DopplerReferenceCode.
void setSourceId (int sourceId)
 Set sourceId with the specified int.
bool compareNoAutoInc (int sourceId, int transitionIndex, DopplerReferenceCodeMod::DopplerReferenceCode velDef)
 Compare each mandatory attribute except the autoincrementable one of this DopplerRow with the corresponding parameters and return true if there is a match and false otherwise.
bool compareRequiredValue (int transitionIndex, DopplerReferenceCodeMod::DopplerReferenceCode velDef)
 Compare each mandatory value (i.e.
bool equalByRequiredValue (DopplerRow *x)
 Return true if all required attributes of the value part are equal to their homologues in x and false otherwise.
asdmIDL::DopplerRowIDL * toIDL () const
 Return this row in the form of an IDL struct.
void toIDL (asdmIDL::DopplerRowIDL &x) const
 Define the content of a DopplerRowIDL struct from the values found in this row.
void setFromIDL (asdmIDL::DopplerRowIDL x)
 Fill the values of this row from the IDL struct DopplerRowIDL.
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.
virtual ~DopplerRow ()
 friend class asdm::TableStreamReader<DopplerTable, DopplerRow>;
DopplerTablegetTable () const
 Return the table to which this row belongs.
bool isAdded () const
 Has this row been added to its table ?
int getTransitionIndex () const
 ===> Attribute transitionIndex
void setTransitionIndex (int transitionIndex)
 Set transitionIndex with the specified int.
DopplerReferenceCodeMod::DopplerReferenceCode getVelDef () const
 ===> Attribute velDef
void setVelDef (DopplerReferenceCodeMod::DopplerReferenceCode velDef)
 Set velDef with the specified DopplerReferenceCodeMod::DopplerReferenceCode.
void setSourceId (int sourceId)
 Set sourceId with the specified int.
bool compareNoAutoInc (int sourceId, int transitionIndex, DopplerReferenceCodeMod::DopplerReferenceCode velDef)
 Compare each mandatory attribute except the autoincrementable one of this DopplerRow with the corresponding parameters and return true if there is a match and false otherwise.
bool compareRequiredValue (int transitionIndex, DopplerReferenceCodeMod::DopplerReferenceCode velDef)
 Compare each mandatory value (i.e.
bool equalByRequiredValue (DopplerRow *x)
 Return true if all required attributes of the value part are equal to their homologues in x and false otherwise.
asdmIDL::DopplerRowIDL * toIDL () const
 Return this row in the form of an IDL struct.
void setFromIDL (asdmIDL::DopplerRowIDL x)
 Fill the values of this row from the IDL struct DopplerRowIDL.
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
 Links

Private Member Functions

void isAdded (bool added)
 This method is used by the Table class when this row is added to the table.
 DopplerRow (DopplerTable &table)
 Create a DopplerRow.
 DopplerRow (DopplerTable &table, DopplerRow &row)
 Create a DopplerRow using a copy constructor mechanism.
void setDopplerId (int dopplerId)
 Set dopplerId with the specified int value.
void dopplerIdFromBin (EndianIStream &eis)
void sourceIdFromBin (EndianIStream &eis)
void transitionIndexFromBin (EndianIStream &eis)
void velDefFromBin (EndianIStream &eis)
void dopplerIdFromText (const string &s)
void sourceIdFromText (const string &s)
void transitionIndexFromText (const string &s)
void velDefFromText (const string &s)
void toBin (EndianOSStream &eoss)
 Serialize this into a stream of bytes written to an EndianOSStream.
void isAdded (bool added)
 This method is used by the Table class when this row is added to the table.
 DopplerRow (DopplerTable &table)
 Create a DopplerRow.
 DopplerRow (DopplerTable &table, DopplerRow &row)
 Create a DopplerRow using a copy constructor mechanism.
void setDopplerId (int dopplerId)
 Set dopplerId with the specified int value.
void dopplerIdFromBin (EndianIStream &eis)
void sourceIdFromBin (EndianIStream &eis)
void transitionIndexFromBin (EndianIStream &eis)
void velDefFromBin (EndianIStream &eis)
void dopplerIdFromText (const string &s)
void sourceIdFromText (const string &s)
void transitionIndexFromText (const string &s)
void velDefFromText (const string &s)
void fromText (const std::string &attributeName, const std::string &t)
void toBin (EndianOSStream &eoss)
 Serialize this into a stream of bytes written to an EndianOSStream.

Private Attributes

DopplerTabletable
 The table to which this row belongs.
bool hasBeenAdded
 Whether this row has been added to the table or not.
int transitionIndex
 ===> Attribute transitionIndex
DopplerReferenceCodeMod::DopplerReferenceCode velDef
 ===> Attribute velDef
Links *binary deserialization
material from an EndianIStream
std::map< std::string,
DopplerAttributeFromBin
fromBinMethods
*text deserialization material
std::map< std::string,
DopplerAttributeFromText
fromTextMethods

Friends

class asdm::DopplerTable
class asdm::RowTransformer< DopplerRow >

Detailed Description

The DopplerRow class is a row of a DopplerTable.

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

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

Definition at line 93 of file DopplerRow.h.


Constructor & Destructor Documentation

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

friend class asdm::TableStreamReader<DopplerTable, DopplerRow>;

Create a DopplerRow.

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

Create a DopplerRow using a copy constructor mechanism.

Given a DopplerRow row and a DopplerTable table, the method creates a new DopplerRow 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.
virtual asdm::DopplerRow::~DopplerRow ( ) [virtual]

friend class asdm::TableStreamReader<DopplerTable, DopplerRow>;

Create a DopplerRow.

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

Create a DopplerRow using a copy constructor mechanism.

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

bool asdm::DopplerRow::compareNoAutoInc ( int  sourceId,
int  transitionIndex,
DopplerReferenceCodeMod::DopplerReferenceCode  velDef 
)

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

Parameters:
sourceId
transitionIndex
velDef
bool asdm::DopplerRow::compareNoAutoInc ( int  sourceId,
int  transitionIndex,
DopplerReferenceCodeMod::DopplerReferenceCode  velDef 
)

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

Parameters:
sourceId
transitionIndex
velDef
bool asdm::DopplerRow::compareRequiredValue ( int  transitionIndex,
DopplerReferenceCodeMod::DopplerReferenceCode  velDef 
)

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:
transitionIndex
velDef
bool asdm::DopplerRow::compareRequiredValue ( int  transitionIndex,
DopplerReferenceCodeMod::DopplerReferenceCode  velDef 
)

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:
transitionIndex
velDef
void asdm::DopplerRow::dopplerIdFromText ( const string &  s) [private]
void asdm::DopplerRow::dopplerIdFromText ( const string &  s) [private]

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 DopplerRow whose required attributes of the value part will be compared with those of this.
Returns:
a boolean.

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 DopplerRow whose required attributes of the value part will be compared with those of this.
Returns:
a boolean.
void asdm::DopplerRow::fromText ( const std::string &  attributeName,
const std::string &  t 
) [private]

Return the table to which this row belongs.

Return the table to which this row belongs.

===> Attribute transitionIndex

         

Get transitionIndex.

Returns:
transitionIndex as int

===> Attribute transitionIndex

         

Get transitionIndex.

Returns:
transitionIndex as int
DopplerReferenceCodeMod::DopplerReferenceCode asdm::DopplerRow::getVelDef ( ) const

===> Attribute velDef

         

Get velDef.

Returns:
velDef as DopplerReferenceCodeMod::DopplerReferenceCode
DopplerReferenceCodeMod::DopplerReferenceCode asdm::DopplerRow::getVelDef ( ) const

===> Attribute velDef

         

Get velDef.

Returns:
velDef as DopplerReferenceCodeMod::DopplerReferenceCode
bool asdm::DopplerRow::isAdded ( ) const

Has this row been added to its table ?

Returns:
true if and only if it has been added.
bool asdm::DopplerRow::isAdded ( ) const

Has this row been added to its table ?

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

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

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

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

void asdm::DopplerRow::setDopplerId ( int  dopplerId) [private]

Set dopplerId with the specified int value.

Parameters:
dopplerIdThe int value to which dopplerId is to be set.
Exceptions:
IllegalAccessExceptionIf an attempt is made to change this field after is has been added to the table.
void asdm::DopplerRow::setDopplerId ( int  dopplerId) [private]

Set dopplerId with the specified int value.

Parameters:
dopplerIdThe int value to which dopplerId is to be set.
Exceptions:
IllegalAccessExceptionIf an attempt is made to change this field after is has been added to the table.
void asdm::DopplerRow::setFromIDL ( asdmIDL::DopplerRowIDL  x)

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

Parameters:
xThe IDL struct containing the values used to fill this row.
Exceptions:
ConversionException
void asdm::DopplerRow::setFromIDL ( asdmIDL::DopplerRowIDL  x)

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

Parameters:
xThe IDL struct containing the values used to fill this row.
Exceptions:
ConversionException
void asdm::DopplerRow::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::DopplerRow::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::DopplerRow::setSourceId ( int  sourceId)

Set sourceId with the specified int.

Parameters:
sourceIdThe int value to which sourceId is to be set.
Exceptions:
IllegalAccessExceptionIf an attempt is made to change this field after is has been added to the table.
void asdm::DopplerRow::setSourceId ( int  sourceId)

Set sourceId with the specified int.

Parameters:
sourceIdThe int value to which sourceId is to be set.
Exceptions:
IllegalAccessExceptionIf an attempt is made to change this field after is has been added to the table.
void asdm::DopplerRow::setTransitionIndex ( int  transitionIndex)

Set transitionIndex with the specified int.

Parameters:
transitionIndexThe int value to which transitionIndex is to be set.
void asdm::DopplerRow::setTransitionIndex ( int  transitionIndex)

Set transitionIndex with the specified int.

Parameters:
transitionIndexThe int value to which transitionIndex is to be set.
void asdm::DopplerRow::setVelDef ( DopplerReferenceCodeMod::DopplerReferenceCode  velDef)

Set velDef with the specified DopplerReferenceCodeMod::DopplerReferenceCode.

Parameters:
velDefThe DopplerReferenceCodeMod::DopplerReferenceCode value to which velDef is to be set.
void asdm::DopplerRow::setVelDef ( DopplerReferenceCodeMod::DopplerReferenceCode  velDef)

Set velDef with the specified DopplerReferenceCodeMod::DopplerReferenceCode.

Parameters:
velDefThe DopplerReferenceCodeMod::DopplerReferenceCode value to which velDef is to be set.
void asdm::DopplerRow::sourceIdFromText ( const string &  s) [private]
void asdm::DopplerRow::sourceIdFromText ( const string &  s) [private]
void asdm::DopplerRow::toBin ( EndianOSStream eoss) [private]

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

Parameters:
eossthe EndianOSStream to be written to
void asdm::DopplerRow::toBin ( EndianOSStream eoss) [private]

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

Parameters:
eossthe EndianOSStream to be written to
asdmIDL::DopplerRowIDL* asdm::DopplerRow::toIDL ( ) const

Return this row in the form of an IDL struct.

Returns:
The values of this row as a DopplerRowIDL struct.
asdmIDL::DopplerRowIDL* asdm::DopplerRow::toIDL ( ) const

Return this row in the form of an IDL struct.

Returns:
The values of this row as a DopplerRowIDL struct.
void asdm::DopplerRow::toIDL ( asdmIDL::DopplerRowIDL &  x) const

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

Parameters:
xa reference to the DopplerRowIDL struct to be set.
std::string asdm::DopplerRow::toXML ( ) const

Return this row in the form of an XML string.

Returns:
The values of this row as an XML string.
std::string asdm::DopplerRow::toXML ( ) const

Return this row in the form of an XML string.

Returns:
The values of this row as an XML string.
void asdm::DopplerRow::transitionIndexFromText ( const string &  s) [private]
void asdm::DopplerRow::transitionIndexFromText ( const string &  s) [private]
void asdm::DopplerRow::velDefFromText ( const string &  s) [private]
void asdm::DopplerRow::velDefFromText ( const string &  s) [private]

Friends And Related Function Documentation

Definition at line 94 of file DopplerRow.h.

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

Definition at line 95 of file DopplerRow.h.


Member Data Documentation

Definition at line 118 of file DopplerRow.h.

Definition at line 202 of file DopplerRow.h.

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

Definition at line 488 of file DopplerRow.h.

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

Definition at line 500 of file DopplerRow.h.

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

Definition at line 374 of file DopplerRow.h.

Definition at line 241 of file DopplerRow.h.

The table to which this row belongs.

Definition at line 370 of file DopplerRow.h.

===> Attribute transitionIndex

         

Definition at line 441 of file DopplerRow.h.

DopplerReferenceCodeMod::DopplerReferenceCode asdm::DopplerRow::velDef [private]

===> Attribute velDef

         

Definition at line 452 of file DopplerRow.h.


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