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

The HistoryRow class is a row of a HistoryTable. More...

#include <HistoryRow.h>

List of all members.

Public Member Functions

virtual ~HistoryRow ()
 friend class asdm::TableStreamReader<HistoryTable, HistoryRow>;
HistoryTablegetTable () const
 Return the table to which this row belongs.
bool isAdded () const
 Has this row been added to its table ?
void setTime (ArrayTime time)
 Set time with the specified ArrayTime.
string getMessage () const
 ===> Attribute message
void setMessage (string message)
 Set message with the specified string.
string getPriority () const
 ===> Attribute priority
void setPriority (string priority)
 Set priority with the specified string.
string getOrigin () const
 ===> Attribute origin
void setOrigin (string origin)
 Set origin with the specified string.
string getObjectId () const
 ===> Attribute objectId
void setObjectId (string objectId)
 Set objectId with the specified string.
string getApplication () const
 ===> Attribute application
void setApplication (string application)
 Set application with the specified string.
string getCliCommand () const
 ===> Attribute cliCommand
void setCliCommand (string cliCommand)
 Set cliCommand with the specified string.
string getAppParms () const
 ===> Attribute appParms
void setAppParms (string appParms)
 Set appParms with the specified string.
void setExecBlockId (Tag execBlockId)
 Set execBlockId with the specified Tag.
Links *ExecBlockRowgetExecBlockUsingExecBlockId ()
 execBlockId pointer to the row in the ExecBlock table having ExecBlock.execBlockId == execBlockId
bool compareNoAutoInc (Tag execBlockId, ArrayTime time, string message, string priority, string origin, string objectId, string application, string cliCommand, string appParms)
 Compare each mandatory attribute except the autoincrementable one of this HistoryRow with the corresponding parameters and return true if there is a match and false otherwise.
bool compareRequiredValue (string message, string priority, string origin, string objectId, string application, string cliCommand, string appParms)
 Compare each mandatory value (i.e.
bool equalByRequiredValue (HistoryRow *x)
 Return true if all required attributes of the value part are equal to their homologues in x and false otherwise.
asdmIDL::HistoryRowIDL * toIDL () const
 Return this row in the form of an IDL struct.
void toIDL (asdmIDL::HistoryRowIDL &x) const
 Define the content of a HistoryRowIDL struct from the values found in this row.
void setFromIDL (asdmIDL::HistoryRowIDL x)
 Fill the values of this row from the IDL struct HistoryRowIDL.
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 ~HistoryRow ()
 friend class asdm::TableStreamReader<HistoryTable, HistoryRow>;
HistoryTablegetTable () const
 Return the table to which this row belongs.
bool isAdded () const
 Has this row been added to its table ?
void setTime (ArrayTime time)
 Set time with the specified ArrayTime.
string getMessage () const
 ===> Attribute message
void setMessage (string message)
 Set message with the specified string.
string getPriority () const
 ===> Attribute priority
void setPriority (string priority)
 Set priority with the specified string.
string getOrigin () const
 ===> Attribute origin
void setOrigin (string origin)
 Set origin with the specified string.
string getObjectId () const
 ===> Attribute objectId
void setObjectId (string objectId)
 Set objectId with the specified string.
string getApplication () const
 ===> Attribute application
void setApplication (string application)
 Set application with the specified string.
string getCliCommand () const
 ===> Attribute cliCommand
void setCliCommand (string cliCommand)
 Set cliCommand with the specified string.
string getAppParms () const
 ===> Attribute appParms
void setAppParms (string appParms)
 Set appParms with the specified string.
void setExecBlockId (Tag execBlockId)
 Set execBlockId with the specified Tag.
Links *ExecBlockRowgetExecBlockUsingExecBlockId ()
 execBlockId pointer to the row in the ExecBlock table having ExecBlock.execBlockId == execBlockId
bool compareNoAutoInc (Tag execBlockId, ArrayTime time, string message, string priority, string origin, string objectId, string application, string cliCommand, string appParms)
 Compare each mandatory attribute except the autoincrementable one of this HistoryRow with the corresponding parameters and return true if there is a match and false otherwise.
bool compareRequiredValue (string message, string priority, string origin, string objectId, string application, string cliCommand, string appParms)
 Compare each mandatory value (i.e.
bool equalByRequiredValue (HistoryRow *x)
 Return true if all required attributes of the value part are equal to their homologues in x and false otherwise.
asdmIDL::HistoryRowIDL * toIDL () const
 Return this row in the form of an IDL struct.
void setFromIDL (asdmIDL::HistoryRowIDL x)
 Fill the values of this row from the IDL struct HistoryRowIDL.
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.
 HistoryRow (HistoryTable &table)
 Create a HistoryRow.
 HistoryRow (HistoryTable &table, HistoryRow &row)
 Create a HistoryRow using a copy constructor mechanism.
void execBlockIdFromBin (EndianIStream &eis)
void timeFromBin (EndianIStream &eis)
void messageFromBin (EndianIStream &eis)
void priorityFromBin (EndianIStream &eis)
void originFromBin (EndianIStream &eis)
void objectIdFromBin (EndianIStream &eis)
void applicationFromBin (EndianIStream &eis)
void cliCommandFromBin (EndianIStream &eis)
void appParmsFromBin (EndianIStream &eis)
void execBlockIdFromText (const string &s)
void timeFromText (const string &s)
void messageFromText (const string &s)
void priorityFromText (const string &s)
void originFromText (const string &s)
void objectIdFromText (const string &s)
void applicationFromText (const string &s)
void cliCommandFromText (const string &s)
void appParmsFromText (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.
 HistoryRow (HistoryTable &table)
 Create a HistoryRow.
 HistoryRow (HistoryTable &table, HistoryRow &row)
 Create a HistoryRow using a copy constructor mechanism.
void execBlockIdFromBin (EndianIStream &eis)
void timeFromBin (EndianIStream &eis)
void messageFromBin (EndianIStream &eis)
void priorityFromBin (EndianIStream &eis)
void originFromBin (EndianIStream &eis)
void objectIdFromBin (EndianIStream &eis)
void applicationFromBin (EndianIStream &eis)
void cliCommandFromBin (EndianIStream &eis)
void appParmsFromBin (EndianIStream &eis)
void execBlockIdFromText (const string &s)
void timeFromText (const string &s)
void messageFromText (const string &s)
void priorityFromText (const string &s)
void originFromText (const string &s)
void objectIdFromText (const string &s)
void applicationFromText (const string &s)
void cliCommandFromText (const string &s)
void appParmsFromText (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

HistoryTabletable
 The table to which this row belongs.
bool hasBeenAdded
 Whether this row has been added to the table or not.
string message
 ===> Attribute message
string priority
 ===> Attribute priority
string origin
 ===> Attribute origin
string objectId
 ===> Attribute objectId
string application
 ===> Attribute application
string cliCommand
 ===> Attribute cliCommand
string appParms
 ===> Attribute appParms
Links *binary deserialization
material from an EndianIStream
std::map< std::string,
HistoryAttributeFromBin
fromBinMethods
*text deserialization material
std::map< std::string,
HistoryAttributeFromText
fromTextMethods

Friends

class asdm::HistoryTable
class asdm::RowTransformer< HistoryRow >

Detailed Description

The HistoryRow class is a row of a HistoryTable.

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

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

Definition at line 109 of file HistoryRow.h.


Constructor & Destructor Documentation

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

friend class asdm::TableStreamReader<HistoryTable, HistoryRow>;

Create a HistoryRow.

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

Create a HistoryRow using a copy constructor mechanism.

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

friend class asdm::TableStreamReader<HistoryTable, HistoryRow>;

Create a HistoryRow.

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

Create a HistoryRow using a copy constructor mechanism.

Given a HistoryRow row and a HistoryTable table, the method creates a new HistoryRow 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::HistoryRow::applicationFromText ( const string &  s) [private]
void asdm::HistoryRow::applicationFromText ( const string &  s) [private]
void asdm::HistoryRow::appParmsFromText ( const string &  s) [private]
void asdm::HistoryRow::appParmsFromText ( const string &  s) [private]
void asdm::HistoryRow::cliCommandFromText ( const string &  s) [private]
void asdm::HistoryRow::cliCommandFromText ( const string &  s) [private]
bool asdm::HistoryRow::compareNoAutoInc ( Tag  execBlockId,
ArrayTime  time,
string  message,
string  priority,
string  origin,
string  objectId,
string  application,
string  cliCommand,
string  appParms 
)

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

Parameters:
execBlockId
time
message
priority
origin
objectId
application
cliCommand
appParms
bool asdm::HistoryRow::compareNoAutoInc ( Tag  execBlockId,
ArrayTime  time,
string  message,
string  priority,
string  origin,
string  objectId,
string  application,
string  cliCommand,
string  appParms 
)

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

Parameters:
execBlockId
time
message
priority
origin
objectId
application
cliCommand
appParms
bool asdm::HistoryRow::compareRequiredValue ( string  message,
string  priority,
string  origin,
string  objectId,
string  application,
string  cliCommand,
string  appParms 
)

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:
message
priority
origin
objectId
application
cliCommand
appParms
bool asdm::HistoryRow::compareRequiredValue ( string  message,
string  priority,
string  origin,
string  objectId,
string  application,
string  cliCommand,
string  appParms 
)

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:
message
priority
origin
objectId
application
cliCommand
appParms

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

===> Attribute application

         

Get application.

Returns:
application as string

===> Attribute application

         

Get application.

Returns:
application as string

===> Attribute appParms

         

Get appParms.

Returns:
appParms as string

===> Attribute appParms

         

Get appParms.

Returns:
appParms as string

===> Attribute cliCommand

         

Get cliCommand.

Returns:
cliCommand as string

===> Attribute cliCommand

         

Get cliCommand.

Returns:
cliCommand as string

execBlockId pointer to the row in the ExecBlock table having ExecBlock.execBlockId == execBlockId

Returns:
a ExecBlockRow*

execBlockId pointer to the row in the ExecBlock table having ExecBlock.execBlockId == execBlockId

Returns:
a ExecBlockRow*
string asdm::HistoryRow::getMessage ( ) const

===> Attribute message

         

Get message.

Returns:
message as string
string asdm::HistoryRow::getMessage ( ) const

===> Attribute message

         

Get message.

Returns:
message as string

===> Attribute objectId

         

Get objectId.

Returns:
objectId as string

===> Attribute objectId

         

Get objectId.

Returns:
objectId as string
string asdm::HistoryRow::getOrigin ( ) const

===> Attribute origin

         

Get origin.

Returns:
origin as string
string asdm::HistoryRow::getOrigin ( ) const

===> Attribute origin

         

Get origin.

Returns:
origin as string

===> Attribute priority

         

Get priority.

Returns:
priority as string

===> Attribute priority

         

Get priority.

Returns:
priority as string

Return the table to which this row belongs.

Return the table to which this row belongs.

bool asdm::HistoryRow::isAdded ( ) const

Has this row been added to its table ?

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

Has this row been added to its table ?

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

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

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

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

void asdm::HistoryRow::messageFromText ( const string &  s) [private]
void asdm::HistoryRow::messageFromText ( const string &  s) [private]
void asdm::HistoryRow::objectIdFromText ( const string &  s) [private]
void asdm::HistoryRow::objectIdFromText ( const string &  s) [private]
void asdm::HistoryRow::originFromText ( const string &  s) [private]
void asdm::HistoryRow::originFromText ( const string &  s) [private]
void asdm::HistoryRow::priorityFromText ( const string &  s) [private]
void asdm::HistoryRow::priorityFromText ( const string &  s) [private]
void asdm::HistoryRow::setApplication ( string  application)

Set application with the specified string.

Parameters:
applicationThe string value to which application is to be set.
void asdm::HistoryRow::setApplication ( string  application)

Set application with the specified string.

Parameters:
applicationThe string value to which application is to be set.
void asdm::HistoryRow::setAppParms ( string  appParms)

Set appParms with the specified string.

Parameters:
appParmsThe string value to which appParms is to be set.
void asdm::HistoryRow::setAppParms ( string  appParms)

Set appParms with the specified string.

Parameters:
appParmsThe string value to which appParms is to be set.
void asdm::HistoryRow::setCliCommand ( string  cliCommand)

Set cliCommand with the specified string.

Parameters:
cliCommandThe string value to which cliCommand is to be set.
void asdm::HistoryRow::setCliCommand ( string  cliCommand)

Set cliCommand with the specified string.

Parameters:
cliCommandThe string value to which cliCommand is to be set.
void asdm::HistoryRow::setExecBlockId ( Tag  execBlockId)

Set execBlockId with the specified Tag.

Parameters:
execBlockIdThe Tag value to which execBlockId is to be set.
Exceptions:
IllegalAccessExceptionIf an attempt is made to change this field after is has been added to the table.
void asdm::HistoryRow::setExecBlockId ( Tag  execBlockId)

Set execBlockId with the specified Tag.

Parameters:
execBlockIdThe Tag value to which execBlockId is to be set.
Exceptions:
IllegalAccessExceptionIf an attempt is made to change this field after is has been added to the table.
void asdm::HistoryRow::setFromIDL ( asdmIDL::HistoryRowIDL  x)

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

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

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

Parameters:
xThe IDL struct containing the values used to fill this row.
Exceptions:
ConversionException
void asdm::HistoryRow::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::HistoryRow::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::HistoryRow::setMessage ( string  message)

Set message with the specified string.

Parameters:
messageThe string value to which message is to be set.
void asdm::HistoryRow::setMessage ( string  message)

Set message with the specified string.

Parameters:
messageThe string value to which message is to be set.
void asdm::HistoryRow::setObjectId ( string  objectId)

Set objectId with the specified string.

Parameters:
objectIdThe string value to which objectId is to be set.
void asdm::HistoryRow::setObjectId ( string  objectId)

Set objectId with the specified string.

Parameters:
objectIdThe string value to which objectId is to be set.
void asdm::HistoryRow::setOrigin ( string  origin)

Set origin with the specified string.

Parameters:
originThe string value to which origin is to be set.
void asdm::HistoryRow::setOrigin ( string  origin)

Set origin with the specified string.

Parameters:
originThe string value to which origin is to be set.
void asdm::HistoryRow::setPriority ( string  priority)

Set priority with the specified string.

Parameters:
priorityThe string value to which priority is to be set.
void asdm::HistoryRow::setPriority ( string  priority)

Set priority with the specified string.

Parameters:
priorityThe string value to which priority is to be set.

Set time with the specified ArrayTime.

Parameters:
timeThe ArrayTime value to which time is to be set.
Exceptions:
IllegalAccessExceptionIf an attempt is made to change this field after is has been added to the table.

Set time with the specified ArrayTime.

Parameters:
timeThe ArrayTime value to which time is to be set.
Exceptions:
IllegalAccessExceptionIf an attempt is made to change this field after is has been added to the table.
void asdm::HistoryRow::timeFromBin ( EndianIStream eis) [private]
void asdm::HistoryRow::timeFromBin ( EndianIStream eis) [private]
void asdm::HistoryRow::timeFromText ( const string &  s) [private]
void asdm::HistoryRow::timeFromText ( const string &  s) [private]
void asdm::HistoryRow::toBin ( EndianOSStream eoss) [private]

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

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

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

Parameters:
eossthe EndianOSStream to be written to
asdmIDL::HistoryRowIDL* asdm::HistoryRow::toIDL ( ) const

Return this row in the form of an IDL struct.

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

Return this row in the form of an IDL struct.

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

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

Parameters:
xa reference to the HistoryRowIDL struct to be set.
std::string asdm::HistoryRow::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::HistoryRow::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

Definition at line 110 of file HistoryRow.h.

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

Definition at line 111 of file HistoryRow.h.


Member Data Documentation

===> Attribute application

         

Definition at line 676 of file HistoryRow.h.

string asdm::HistoryRow::appParms [private]

===> Attribute appParms

         

Definition at line 698 of file HistoryRow.h.

Definition at line 134 of file HistoryRow.h.

Definition at line 380 of file HistoryRow.h.

string asdm::HistoryRow::cliCommand [private]

===> Attribute cliCommand

         

Definition at line 687 of file HistoryRow.h.

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

Definition at line 735 of file HistoryRow.h.

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

Definition at line 752 of file HistoryRow.h.

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

Definition at line 577 of file HistoryRow.h.

string asdm::HistoryRow::message [private]

===> Attribute message

         

Definition at line 632 of file HistoryRow.h.

string asdm::HistoryRow::objectId [private]

===> Attribute objectId

         

Definition at line 665 of file HistoryRow.h.

string asdm::HistoryRow::origin [private]

===> Attribute origin

         

Definition at line 654 of file HistoryRow.h.

string asdm::HistoryRow::priority [private]

===> Attribute priority

         

Definition at line 643 of file HistoryRow.h.

The table to which this row belongs.

Definition at line 573 of file HistoryRow.h.


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