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

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

#include <HistoryRow.h>

Public Member Functions

virtual ~HistoryRow ()
 friend class asdm::TableStreamReader<HistoryTable, HistoryRow>; More...
 
HistoryTablegetTable () const
 Return the table to which this row belongs. More...
 
bool isAdded () const
 Has this row been added to its table ? More...
 
void setTime (ArrayTime time)
 Set time with the specified ArrayTime. More...
 
std::string getMessage () const
 ===> Attribute message More...
 
void setMessage (std::string message)
 Set message with the specified std::string. More...
 
std::string getPriority () const
 ===> Attribute priority More...
 
void setPriority (std::string priority)
 Set priority with the specified std::string. More...
 
std::string getOrigin () const
 ===> Attribute origin More...
 
void setOrigin (std::string origin)
 Set origin with the specified std::string. More...
 
std::string getObjectId () const
 ===> Attribute objectId More...
 
void setObjectId (std::string objectId)
 Set objectId with the specified std::string. More...
 
std::string getApplication () const
 ===> Attribute application More...
 
void setApplication (std::string application)
 Set application with the specified std::string. More...
 
std::string getCliCommand () const
 ===> Attribute cliCommand More...
 
void setCliCommand (std::string cliCommand)
 Set cliCommand with the specified std::string. More...
 
std::string getAppParms () const
 ===> Attribute appParms More...
 
void setAppParms (std::string appParms)
 Set appParms with the specified std::string. More...
 
void setExecBlockId (Tag execBlockId)
 Set execBlockId with the specified Tag. More...
 
Links *ExecBlockRowgetExecBlockUsingExecBlockId ()
 execBlockId pointer to the row in the ExecBlock table having ExecBlock.execBlockId == execBlockId More...
 
bool compareNoAutoInc (Tag execBlockId, ArrayTime time, std::string message, std::string priority, std::string origin, std::string objectId, std::string application, std::string cliCommand, std::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. More...
 
bool compareRequiredValue (std::string message, std::string priority, std::string origin, std::string objectId, std::string application, std::string cliCommand, std::string appParms)
 Compare each mandatory value (i.e. More...
 
bool equalByRequiredValue (HistoryRow *x)
 Return true if all required attributes of the value part are equal to their homologues in x and false otherwise. More...
 
asdmIDL::HistoryRowIDL * toIDL () const
 Return this row in the form of an IDL struct. More...
 
void toIDL (asdmIDL::HistoryRowIDL &x) const
 Define the content of a HistoryRowIDL struct from the values found in this row. More...
 
void setFromIDL (asdmIDL::HistoryRowIDL x)
 Fill the values of this row from the IDL struct HistoryRowIDL. 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
 

Private Member Functions

void isAdded (bool added)
 This method is used by the Table class when this row is added to the table. More...
 
 HistoryRow (HistoryTable &table)
 Create a HistoryRow. More...
 
 HistoryRow (HistoryTable &table, HistoryRow *row)
 Create a HistoryRow using a copy constructor mechanism. More...
 
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 std::string &s)
 
void timeFromText (const std::string &s)
 
void messageFromText (const std::string &s)
 
void priorityFromText (const std::string &s)
 
void originFromText (const std::string &s)
 
void objectIdFromText (const std::string &s)
 
void applicationFromText (const std::string &s)
 
void cliCommandFromText (const std::string &s)
 
void appParmsFromText (const std::string &s)
 
void toBin (EndianOSStream &eoss)
 Serialize this into a stream of bytes written to an EndianOSStream. More...
 

Private Attributes

HistoryTabletable
 The table to which this row belongs. More...
 
bool hasBeenAdded
 Whether this row has been added to the table or not. More...
 
std::string message
 ===> Attribute message More...
 
std::string priority
 ===> Attribute priority More...
 
std::string origin
 ===> Attribute origin More...
 
std::string objectId
 ===> Attribute objectId More...
 
std::string application
 ===> Attribute application More...
 
std::string cliCommand
 ===> Attribute cliCommand More...
 
std::string appParms
 ===> Attribute appParms More...
 
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", branch ""

Definition at line 109 of file HistoryRow.h.

Constructor & Destructor Documentation

virtual asdm::HistoryRow::~HistoryRow ( )
virtual

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

asdm::HistoryRow::HistoryRow ( HistoryTable table)
private

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::applicationFromBin ( EndianIStream eis)
private
void asdm::HistoryRow::applicationFromText ( const std::string &  s)
private
void asdm::HistoryRow::appParmsFromBin ( EndianIStream eis)
private
void asdm::HistoryRow::appParmsFromText ( const std::string &  s)
private
void asdm::HistoryRow::cliCommandFromBin ( EndianIStream eis)
private
void asdm::HistoryRow::cliCommandFromText ( const std::string &  s)
private
bool asdm::HistoryRow::compareNoAutoInc ( Tag  execBlockId,
ArrayTime  time,
std::string  message,
std::string  priority,
std::string  origin,
std::string  objectId,
std::string  application,
std::string  cliCommand,
std::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 ( std::string  message,
std::string  priority,
std::string  origin,
std::string  objectId,
std::string  application,
std::string  cliCommand,
std::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::equalByRequiredValue ( HistoryRow 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 HistoryRow whose required attributes of the value part will be compared with those of this.
Returns
a boolean.
void asdm::HistoryRow::execBlockIdFromBin ( EndianIStream eis)
private
void asdm::HistoryRow::execBlockIdFromText ( const std::string &  s)
private
std::string asdm::HistoryRow::getApplication ( ) const

===> Attribute application

Get application.

Returns
application as std::string
std::string asdm::HistoryRow::getAppParms ( ) const

===> Attribute appParms

Get appParms.

Returns
appParms as std::string
std::string asdm::HistoryRow::getCliCommand ( ) const

===> Attribute cliCommand

Get cliCommand.

Returns
cliCommand as std::string
Links* ExecBlockRow* asdm::HistoryRow::getExecBlockUsingExecBlockId ( )

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

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

===> Attribute message

Get message.

Returns
message as std::string
std::string asdm::HistoryRow::getObjectId ( ) const

===> Attribute objectId

Get objectId.

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

===> Attribute origin

Get origin.

Returns
origin as std::string
std::string asdm::HistoryRow::getPriority ( ) const

===> Attribute priority

Get priority.

Returns
priority as std::string
HistoryTable& asdm::HistoryRow::getTable ( ) const

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.
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::messageFromBin ( EndianIStream eis)
private
void asdm::HistoryRow::messageFromText ( const std::string &  s)
private
void asdm::HistoryRow::objectIdFromBin ( EndianIStream eis)
private
void asdm::HistoryRow::objectIdFromText ( const std::string &  s)
private
void asdm::HistoryRow::originFromBin ( EndianIStream eis)
private
void asdm::HistoryRow::originFromText ( const std::string &  s)
private
void asdm::HistoryRow::priorityFromBin ( EndianIStream eis)
private
void asdm::HistoryRow::priorityFromText ( const std::string &  s)
private
void asdm::HistoryRow::setApplication ( std::string  application)

Set application with the specified std::string.

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

Set appParms with the specified std::string.

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

Set cliCommand with the specified std::string.

Parameters
cliCommandThe std::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::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::setMessage ( std::string  message)

Set message with the specified std::string.

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

Set objectId with the specified std::string.

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

Set origin with the specified std::string.

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

Set priority with the specified std::string.

Parameters
priorityThe std::string value to which priority is to be set.
void asdm::HistoryRow::setTime ( ArrayTime  time)

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::timeFromText ( const std::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
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.

Friends And Related Function Documentation

friend class asdm::HistoryTable
friend

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

std::string asdm::HistoryRow::application
private

===> Attribute application

Definition at line 676 of file HistoryRow.h.

std::string asdm::HistoryRow::appParms
private

===> Attribute appParms

Definition at line 698 of file HistoryRow.h.

Extrinsic Table asdm::HistoryRow::Attributes

Definition at line 134 of file HistoryRow.h.

Extrinsic Table asdm::HistoryRow::Attributes

Definition at line 380 of file HistoryRow.h.

std::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.

bool asdm::HistoryRow::hasBeenAdded
private

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

Definition at line 577 of file HistoryRow.h.

std::string asdm::HistoryRow::message
private

===> Attribute message

Definition at line 632 of file HistoryRow.h.

std::string asdm::HistoryRow::objectId
private

===> Attribute objectId

Definition at line 665 of file HistoryRow.h.

std::string asdm::HistoryRow::origin
private

===> Attribute origin

Definition at line 654 of file HistoryRow.h.

std::string asdm::HistoryRow::priority
private

===> Attribute priority

Definition at line 643 of file HistoryRow.h.

HistoryTable& asdm::HistoryRow::table
private

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 file: