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::ScaleRow Class Reference

The ScaleRow class is a row of a ScaleTable. More...

#include <ScaleRow.h>

List of all members.

Public Member Functions

virtual ~ScaleRow ()
 friend class asdm::TableStreamReader<ScaleTable, ScaleRow>;
ScaleTablegetTable () const
 Return the table to which this row belongs.
bool isAdded () const
 Has this row been added to its table ?
TimeScaleMod::TimeScale getTimeScale () const
 ===> Attribute timeScale
void setTimeScale (TimeScaleMod::TimeScale timeScale)
 Set timeScale with the specified TimeScaleMod::TimeScale.
DataScaleMod::DataScale getCrossDataScale () const
 ===> Attribute crossDataScale
void setCrossDataScale (DataScaleMod::DataScale crossDataScale)
 Set crossDataScale with the specified DataScaleMod::DataScale.
DataScaleMod::DataScale getAutoDataScale () const
 ===> Attribute autoDataScale
void setAutoDataScale (DataScaleMod::DataScale autoDataScale)
 Set autoDataScale with the specified DataScaleMod::DataScale.
WeightTypeMod::WeightType getWeightType () const
 ===> Attribute weightType
void setWeightType (WeightTypeMod::WeightType weightType)
 Set weightType with the specified WeightTypeMod::WeightType.
Extrinsic Table Attributes
Links *bool 
compareNoAutoInc (TimeScaleMod::TimeScale timeScale, DataScaleMod::DataScale crossDataScale, DataScaleMod::DataScale autoDataScale, WeightTypeMod::WeightType weightType)
 Compare each mandatory attribute except the autoincrementable one of this ScaleRow with the corresponding parameters and return true if there is a match and false otherwise.
bool compareRequiredValue (TimeScaleMod::TimeScale timeScale, DataScaleMod::DataScale crossDataScale, DataScaleMod::DataScale autoDataScale, WeightTypeMod::WeightType weightType)
 Compare each mandatory value (i.e.
bool equalByRequiredValue (ScaleRow *x)
 Return true if all required attributes of the value part are equal to their homologues in x and false otherwise.
asdmIDL::ScaleRowIDL * toIDL () const
 Return this row in the form of an IDL struct.
void toIDL (asdmIDL::ScaleRowIDL &x) const
 Define the content of a ScaleRowIDL struct from the values found in this row.
void setFromIDL (asdmIDL::ScaleRowIDL x)
 Fill the values of this row from the IDL struct ScaleRowIDL.
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 ~ScaleRow ()
 friend class asdm::TableStreamReader<ScaleTable, ScaleRow>;
ScaleTablegetTable () const
 Return the table to which this row belongs.
bool isAdded () const
 Has this row been added to its table ?
TimeScaleMod::TimeScale getTimeScale () const
 ===> Attribute timeScale
void setTimeScale (TimeScaleMod::TimeScale timeScale)
 Set timeScale with the specified TimeScaleMod::TimeScale.
DataScaleMod::DataScale getCrossDataScale () const
 ===> Attribute crossDataScale
void setCrossDataScale (DataScaleMod::DataScale crossDataScale)
 Set crossDataScale with the specified DataScaleMod::DataScale.
DataScaleMod::DataScale getAutoDataScale () const
 ===> Attribute autoDataScale
void setAutoDataScale (DataScaleMod::DataScale autoDataScale)
 Set autoDataScale with the specified DataScaleMod::DataScale.
WeightTypeMod::WeightType getWeightType () const
 ===> Attribute weightType
void setWeightType (WeightTypeMod::WeightType weightType)
 Set weightType with the specified WeightTypeMod::WeightType.
Extrinsic Table Attributes
Links *bool 
compareNoAutoInc (TimeScaleMod::TimeScale timeScale, DataScaleMod::DataScale crossDataScale, DataScaleMod::DataScale autoDataScale, WeightTypeMod::WeightType weightType)
 Compare each mandatory attribute except the autoincrementable one of this ScaleRow with the corresponding parameters and return true if there is a match and false otherwise.
bool compareRequiredValue (TimeScaleMod::TimeScale timeScale, DataScaleMod::DataScale crossDataScale, DataScaleMod::DataScale autoDataScale, WeightTypeMod::WeightType weightType)
 Compare each mandatory value (i.e.
bool equalByRequiredValue (ScaleRow *x)
 Return true if all required attributes of the value part are equal to their homologues in x and false otherwise.
asdmIDL::ScaleRowIDL * toIDL () const
 Return this row in the form of an IDL struct.
void setFromIDL (asdmIDL::ScaleRowIDL x)
 Fill the values of this row from the IDL struct ScaleRowIDL.
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

Private Member Functions

void isAdded (bool added)
 This method is used by the Table class when this row is added to the table.
 ScaleRow (ScaleTable &table)
 Create a ScaleRow.
 ScaleRow (ScaleTable &table, ScaleRow &row)
 Create a ScaleRow using a copy constructor mechanism.
void setScaleId (Tag scaleId)
 Set scaleId with the specified Tag value.
void scaleIdFromBin (EndianIStream &eis)
void timeScaleFromBin (EndianIStream &eis)
void crossDataScaleFromBin (EndianIStream &eis)
void autoDataScaleFromBin (EndianIStream &eis)
void weightTypeFromBin (EndianIStream &eis)
void scaleIdFromText (const string &s)
void timeScaleFromText (const string &s)
void crossDataScaleFromText (const string &s)
void autoDataScaleFromText (const string &s)
void weightTypeFromText (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.
 ScaleRow (ScaleTable &table)
 Create a ScaleRow.
 ScaleRow (ScaleTable &table, ScaleRow &row)
 Create a ScaleRow using a copy constructor mechanism.
void setScaleId (Tag scaleId)
 Set scaleId with the specified Tag value.
void scaleIdFromBin (EndianIStream &eis)
void timeScaleFromBin (EndianIStream &eis)
void crossDataScaleFromBin (EndianIStream &eis)
void autoDataScaleFromBin (EndianIStream &eis)
void weightTypeFromBin (EndianIStream &eis)
void scaleIdFromText (const string &s)
void timeScaleFromText (const string &s)
void crossDataScaleFromText (const string &s)
void autoDataScaleFromText (const string &s)
void weightTypeFromText (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

ScaleTabletable
 The table to which this row belongs.
bool hasBeenAdded
 Whether this row has been added to the table or not.
TimeScaleMod::TimeScale timeScale
 ===> Attribute timeScale
DataScaleMod::DataScale crossDataScale
 ===> Attribute crossDataScale
DataScaleMod::DataScale autoDataScale
 ===> Attribute autoDataScale
WeightTypeMod::WeightType weightType
 ===> Attribute weightType
Extrinsic Table Attributes
Links *binary deserialization
material from an EndianIStream
std::map< std::string,
ScaleAttributeFromBin
fromBinMethods
*text deserialization material
std::map< std::string,
ScaleAttributeFromText
fromTextMethods

Friends

class asdm::ScaleTable
class asdm::RowTransformer< ScaleRow >

Detailed Description

The ScaleRow class is a row of a ScaleTable.

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

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

Definition at line 104 of file ScaleRow.h.


Constructor & Destructor Documentation

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

friend class asdm::TableStreamReader<ScaleTable, ScaleRow>;

asdm::ScaleRow::ScaleRow ( ScaleTable table) [private]

Create a ScaleRow.

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

Create a ScaleRow using a copy constructor mechanism.

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

friend class asdm::TableStreamReader<ScaleTable, ScaleRow>;

asdm::ScaleRow::ScaleRow ( ScaleTable table) [private]

Create a ScaleRow.

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

Create a ScaleRow using a copy constructor mechanism.

Given a ScaleRow row and a ScaleTable table, the method creates a new ScaleRow 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::ScaleRow::autoDataScaleFromText ( const string &  s) [private]
void asdm::ScaleRow::autoDataScaleFromText ( const string &  s) [private]
Extrinsic Table Attributes Links* bool asdm::ScaleRow::compareNoAutoInc ( TimeScaleMod::TimeScale  timeScale,
DataScaleMod::DataScale  crossDataScale,
DataScaleMod::DataScale  autoDataScale,
WeightTypeMod::WeightType  weightType 
)

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

Parameters:
timeScale
crossDataScale
autoDataScale
weightType
Extrinsic Table Attributes Links* bool asdm::ScaleRow::compareNoAutoInc ( TimeScaleMod::TimeScale  timeScale,
DataScaleMod::DataScale  crossDataScale,
DataScaleMod::DataScale  autoDataScale,
WeightTypeMod::WeightType  weightType 
)

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

Parameters:
timeScale
crossDataScale
autoDataScale
weightType
bool asdm::ScaleRow::compareRequiredValue ( TimeScaleMod::TimeScale  timeScale,
DataScaleMod::DataScale  crossDataScale,
DataScaleMod::DataScale  autoDataScale,
WeightTypeMod::WeightType  weightType 
)

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:
timeScale
crossDataScale
autoDataScale
weightType
bool asdm::ScaleRow::compareRequiredValue ( TimeScaleMod::TimeScale  timeScale,
DataScaleMod::DataScale  crossDataScale,
DataScaleMod::DataScale  autoDataScale,
WeightTypeMod::WeightType  weightType 
)

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:
timeScale
crossDataScale
autoDataScale
weightType
void asdm::ScaleRow::crossDataScaleFromText ( const string &  s) [private]
void asdm::ScaleRow::crossDataScaleFromText ( 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 ScaleRow 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 ScaleRow whose required attributes of the value part will be compared with those of this.
Returns:
a boolean.
void asdm::ScaleRow::fromText ( const std::string &  attributeName,
const std::string &  t 
) [private]
DataScaleMod::DataScale asdm::ScaleRow::getAutoDataScale ( ) const

===> Attribute autoDataScale

         

Get autoDataScale.

Returns:
autoDataScale as DataScaleMod::DataScale
DataScaleMod::DataScale asdm::ScaleRow::getAutoDataScale ( ) const

===> Attribute autoDataScale

         

Get autoDataScale.

Returns:
autoDataScale as DataScaleMod::DataScale
DataScaleMod::DataScale asdm::ScaleRow::getCrossDataScale ( ) const

===> Attribute crossDataScale

         

Get crossDataScale.

Returns:
crossDataScale as DataScaleMod::DataScale
DataScaleMod::DataScale asdm::ScaleRow::getCrossDataScale ( ) const

===> Attribute crossDataScale

         

Get crossDataScale.

Returns:
crossDataScale as DataScaleMod::DataScale

Return the table to which this row belongs.

Return the table to which this row belongs.

TimeScaleMod::TimeScale asdm::ScaleRow::getTimeScale ( ) const

===> Attribute timeScale

         

Get timeScale.

Returns:
timeScale as TimeScaleMod::TimeScale
TimeScaleMod::TimeScale asdm::ScaleRow::getTimeScale ( ) const

===> Attribute timeScale

         

Get timeScale.

Returns:
timeScale as TimeScaleMod::TimeScale
WeightTypeMod::WeightType asdm::ScaleRow::getWeightType ( ) const

===> Attribute weightType

         

Get weightType.

Returns:
weightType as WeightTypeMod::WeightType
WeightTypeMod::WeightType asdm::ScaleRow::getWeightType ( ) const

===> Attribute weightType

         

Get weightType.

Returns:
weightType as WeightTypeMod::WeightType
bool asdm::ScaleRow::isAdded ( ) const

Has this row been added to its table ?

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

Has this row been added to its table ?

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

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

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

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

void asdm::ScaleRow::scaleIdFromBin ( EndianIStream eis) [private]
void asdm::ScaleRow::scaleIdFromBin ( EndianIStream eis) [private]
void asdm::ScaleRow::scaleIdFromText ( const string &  s) [private]
void asdm::ScaleRow::scaleIdFromText ( const string &  s) [private]
void asdm::ScaleRow::setAutoDataScale ( DataScaleMod::DataScale  autoDataScale)

Set autoDataScale with the specified DataScaleMod::DataScale.

Parameters:
autoDataScaleThe DataScaleMod::DataScale value to which autoDataScale is to be set.
void asdm::ScaleRow::setAutoDataScale ( DataScaleMod::DataScale  autoDataScale)

Set autoDataScale with the specified DataScaleMod::DataScale.

Parameters:
autoDataScaleThe DataScaleMod::DataScale value to which autoDataScale is to be set.
void asdm::ScaleRow::setCrossDataScale ( DataScaleMod::DataScale  crossDataScale)

Set crossDataScale with the specified DataScaleMod::DataScale.

Parameters:
crossDataScaleThe DataScaleMod::DataScale value to which crossDataScale is to be set.
void asdm::ScaleRow::setCrossDataScale ( DataScaleMod::DataScale  crossDataScale)

Set crossDataScale with the specified DataScaleMod::DataScale.

Parameters:
crossDataScaleThe DataScaleMod::DataScale value to which crossDataScale is to be set.
void asdm::ScaleRow::setFromIDL ( asdmIDL::ScaleRowIDL  x)

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

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

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

Parameters:
xThe IDL struct containing the values used to fill this row.
Exceptions:
ConversionException
void asdm::ScaleRow::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::ScaleRow::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::ScaleRow::setScaleId ( Tag  scaleId) [private]

Set scaleId with the specified Tag value.

Parameters:
scaleIdThe Tag value to which scaleId is to be set.
Exceptions:
IllegalAccessExceptionIf an attempt is made to change this field after is has been added to the table.
void asdm::ScaleRow::setScaleId ( Tag  scaleId) [private]

Set scaleId with the specified Tag value.

Parameters:
scaleIdThe Tag value to which scaleId is to be set.
Exceptions:
IllegalAccessExceptionIf an attempt is made to change this field after is has been added to the table.
void asdm::ScaleRow::setTimeScale ( TimeScaleMod::TimeScale  timeScale)

Set timeScale with the specified TimeScaleMod::TimeScale.

Parameters:
timeScaleThe TimeScaleMod::TimeScale value to which timeScale is to be set.
void asdm::ScaleRow::setTimeScale ( TimeScaleMod::TimeScale  timeScale)

Set timeScale with the specified TimeScaleMod::TimeScale.

Parameters:
timeScaleThe TimeScaleMod::TimeScale value to which timeScale is to be set.
void asdm::ScaleRow::setWeightType ( WeightTypeMod::WeightType  weightType)

Set weightType with the specified WeightTypeMod::WeightType.

Parameters:
weightTypeThe WeightTypeMod::WeightType value to which weightType is to be set.
void asdm::ScaleRow::setWeightType ( WeightTypeMod::WeightType  weightType)

Set weightType with the specified WeightTypeMod::WeightType.

Parameters:
weightTypeThe WeightTypeMod::WeightType value to which weightType is to be set.
void asdm::ScaleRow::timeScaleFromText ( const string &  s) [private]
void asdm::ScaleRow::timeScaleFromText ( const string &  s) [private]
void asdm::ScaleRow::toBin ( EndianOSStream eoss) [private]

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

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

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

Parameters:
eossthe EndianOSStream to be written to
asdmIDL::ScaleRowIDL* asdm::ScaleRow::toIDL ( ) const

Return this row in the form of an IDL struct.

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

Return this row in the form of an IDL struct.

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

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

Parameters:
xa reference to the ScaleRowIDL struct to be set.
std::string asdm::ScaleRow::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::ScaleRow::toXML ( ) const

Return this row in the form of an XML string.

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

Friends And Related Function Documentation

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

Definition at line 106 of file ScaleRow.h.

asdm::ScaleTable [friend]

Definition at line 105 of file ScaleRow.h.


Member Data Documentation

Intrinsic Table asdm::ScaleRow::Attributes

Definition at line 129 of file ScaleRow.h.

DataScaleMod::DataScale asdm::ScaleRow::autoDataScale [private]

===> Attribute autoDataScale

         

Definition at line 492 of file ScaleRow.h.

DataScaleMod::DataScale asdm::ScaleRow::crossDataScale [private]

===> Attribute crossDataScale

         

Definition at line 481 of file ScaleRow.h.

Extrinsic Table Attributes Links *binary deserialization material from an EndianIStream std::map< std::string, ScaleAttributeFromBin > asdm::ScaleRow::fromBinMethods [private]

Definition at line 522 of file ScaleRow.h.

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

Definition at line 535 of file ScaleRow.h.

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

Definition at line 403 of file ScaleRow.h.

The table to which this row belongs.

Definition at line 399 of file ScaleRow.h.

TimeScaleMod::TimeScale asdm::ScaleRow::timeScale [private]

===> Attribute timeScale

         

Definition at line 470 of file ScaleRow.h.

WeightTypeMod::WeightType asdm::ScaleRow::weightType [private]

===> Attribute weightType

         

Definition at line 503 of file ScaleRow.h.


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