asdm::HistoryRow Class Reference

#include <HistoryRow.h>

List of all members.

---

Detailed Description

The HistoryRow class is a row of a HistoryTable.

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

Public Member Functions
HistoryTable &	getTable () const
HistoryRowIDL *	toIDL () const
void	setFromIDL (HistoryRowIDL x) throw (ConversionException)
string	toXML () const
void	setFromXML (string rowDoc) throw (ConversionException)
ArrayTime	getTime () const
void	setTime (ArrayTime time) throw (IllegalAccessException)
string	getMessage () const
void	setMessage (string message)
string	getPriority () const
void	setPriority (string priority)
string	getOrigin () const
void	setOrigin (string origin)
string	getObjectId () const
void	setObjectId (string objectId)
string	getApplication () const
void	setApplication (string application)
string	getCliCommand () const
void	setCliCommand (string cliCommand)
string	getAppParms () const
void	setAppParms (string appParms)
Tag	getExecBlockId () const
void	setExecBlockId (Tag execBlockId) throw (IllegalAccessException)
ExecBlockRow *	getExecBlockUsingExecBlockId ()
bool	compareNoAutoInc (Tag execBlockId, ArrayTime time, string message, string priority, string origin, string objectId, string application, string cliCommand, string appParms)
bool	compareRequiredValue (string message, string priority, string origin, string objectId, string application, string cliCommand, string appParms)
bool	equalByRequiredValue (HistoryRow *x)
Friends
class	asdm::HistoryTable

---

Member Function Documentation

HistoryTable& asdm::HistoryRow::getTable

(

)

const

Return the table to which this row belongs.

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

(

HistoryRowIDL

x

)

throw (ConversionException)

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

Parameters:

x

The IDL struct containing the values used to fill this row.

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.

void asdm::HistoryRow::setFromXML

(

string

rowDoc

)

throw (ConversionException)

Fill the values of this row from an XML string that was produced by the toXML() method.

Parameters:

x

The XML string being used to set the values of this row.

ArrayTime asdm::HistoryRow::getTime

(

)

const

Get time.

Returns:

time as ArrayTime

void asdm::HistoryRow::setTime

(

ArrayTime

time

)

throw (IllegalAccessException)

Set time with the specified ArrayTime.

Parameters:

time

The ArrayTime value to which time is to be set.

Exceptions:

IllegalAccessException

If an attempt is made to change this field after is has been added to the table.

string asdm::HistoryRow::getMessage

(

)

const

Get message.

Returns:

message as string

void asdm::HistoryRow::setMessage

(

string

message

)

Set message with the specified string.

Parameters:

message

The string value to which message is to be set.

string asdm::HistoryRow::getPriority

(

)

const

Get priority.

Returns:

priority as string

void asdm::HistoryRow::setPriority

(

string

priority

)

Set priority with the specified string.

Parameters:

priority

The string value to which priority is to be set.

string asdm::HistoryRow::getOrigin

(

)

const

Get origin.

Returns:

origin as string

void asdm::HistoryRow::setOrigin

(

string

origin

)

Set origin with the specified string.

Parameters:

origin

The string value to which origin is to be set.

string asdm::HistoryRow::getObjectId

(

)

const

Get objectId.

Returns:

objectId as string

void asdm::HistoryRow::setObjectId

(

string

objectId

)

Set objectId with the specified string.

Parameters:

objectId

The string value to which objectId is to be set.

string asdm::HistoryRow::getApplication

(

)

const

Get application.

Returns:

application as string

void asdm::HistoryRow::setApplication

(

string

application

)

Set application with the specified string.

Parameters:

application

The string value to which application is to be set.

string asdm::HistoryRow::getCliCommand

(

)

const

Get cliCommand.

Returns:

cliCommand as string

void asdm::HistoryRow::setCliCommand

(

string

cliCommand

)

Set cliCommand with the specified string.

Parameters:

cliCommand

The string value to which cliCommand is to be set.

string asdm::HistoryRow::getAppParms

(

)

const

Get appParms.

Returns:

appParms as string

void asdm::HistoryRow::setAppParms

(

string

appParms

)

Set appParms with the specified string.

Parameters:

appParms

The string value to which appParms is to be set.

Tag asdm::HistoryRow::getExecBlockId

(

)

const

Get execBlockId.

Returns:

execBlockId as Tag

void asdm::HistoryRow::setExecBlockId

(

Tag

execBlockId

)

throw (IllegalAccessException)

Set execBlockId with the specified Tag.

Parameters:

execBlockId

The Tag value to which execBlockId is to be set.

Exceptions:

IllegalAccessException

If an attempt is made to change this field after is has been added to the table.

ExecBlockRow* asdm::HistoryRow::getExecBlockUsingExecBlockId

(

)

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

Returns:

a ExecBlockRow*

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.

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:

x

a pointer on the HistoryRow whose required attributes of the value part will be compared with those of this.

Returns:

a boolean.

---

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

• HistoryRow.h

---