asdm::HistoryTable Class Reference

#include <HistoryTable.h>

Inherits asdm::Representable.

List of all members.

---

Detailed Description

The HistoryTable class is an Alma table.

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

Attributes of History

Name	Type	Comment
Key
execBlockId	Tag
time	ArrayTime
Value (Mandarory)
message	string
priority	string
origin	string
objectId	string
application	string
cliCommand	string
appParms	string

Public Member Functions
ASDM &	getContainer () const
unsigned int	size ()
string	getName () const
Entity	getEntity () const
void	setEntity (Entity e)
HistoryRow *	newRow ()
HistoryRow *	newRowEmpty ()
HistoryRow *	newRow (Tag execBlockId, ArrayTime time, string message, string priority, string origin, string objectId, string application, string cliCommand, string appParms)
HistoryRow *	newRowFull (Tag execBlockId, ArrayTime time, string message, string priority, string origin, string objectId, string application, string cliCommand, string appParms)
HistoryRow *	newRow (HistoryRow *row)
HistoryRow *	newRowCopy (HistoryRow *row)
HistoryRow *	add (HistoryRow *x)
vector< HistoryRow * >	get ()
vector< HistoryRow * > *	getByContext (Tag execBlockId)
HistoryRow *	HistoryTable::getRowByKey (Tag execBlockId, ArrayTime time)
HistoryRow *	lookup (Tag execBlockId, ArrayTime time, string message, string priority, string origin, string objectId, string application, string cliCommand, string appParms)
HistoryTableIDL *	toIDL ()
void	fromIDL (HistoryTableIDL x) throw (DuplicateKey,ConversionException)
char *	toFITS () const throw (ConversionException)
void	fromFITS (char *fits) throw (ConversionException)
string	toVOTable () const throw (ConversionException)
void	fromVOTable (string vo) throw (ConversionException)
string	toXML () throw (ConversionException)
void	fromXML (string xmlDoc) throw (ConversionException)
string	toMIME ()
void	setFromMIME (const string &mimeMsg)
void	toFile (string directory)
void	setFromFile (const string &directory)
Static Public Member Functions
static vector< string >	getKeyName ()
Friends
class	asdm::ASDM

---

Member Function Documentation

static vector<string> asdm::HistoryTable::getKeyName

(

)

[static]

Return the list of field names that make up key key as an array of strings.

Returns:

a vector of string.

ASDM& asdm::HistoryTable::getContainer

(

)

const

Return the container to which this table belongs.

Returns:

the ASDM containing this table.

unsigned int asdm::HistoryTable::size

(

)

[virtual]

Return the number of rows in the table.

Returns:

the number of rows in an unsigned int.

Implements asdm::Representable.

string asdm::HistoryTable::getName

(

)

const [virtual]

Return the name of this table.

Returns:

the name of this table in a string.

Implements asdm::Representable.

Entity asdm::HistoryTable::getEntity

(

)

const [virtual]

Return this table's Entity.

Implements asdm::Representable.

void asdm::HistoryTable::setEntity

(

Entity

e

)

[virtual]

Set this table's Entity.

Parameters:

e

An entity.

Implements asdm::Representable.

HistoryRow* asdm::HistoryTable::newRow

(

)

Create a new row with default values.

Returns:

a pointer on a HistoryRow

HistoryRow* asdm::HistoryTable::newRowEmpty

(

)

Has the same definition than the newRow method with the same signature. Provided to facilitate the call from Python, otherwise the newRow method will be preferred.

HistoryRow* asdm::HistoryTable::newRow	(	Tag	execBlockId,
		ArrayTime	time,
		string	message,
		string	priority,
		string	origin,
		string	objectId,
		string	application,
		string	cliCommand,
		string	appParms
	)

Create a new row initialized to the specified values.

Returns:

a pointer on the created and initialized row.

Parameters:

	execBlockId.
	time.
	message.
	priority.
	origin.
	objectId.
	application.
	cliCommand.
	appParms.

HistoryRow* asdm::HistoryTable::newRowFull	(	Tag	execBlockId,
		ArrayTime	time,
		string	message,
		string	priority,
		string	origin,
		string	objectId,
		string	application,
		string	cliCommand,
		string	appParms
	)

Has the same definition than the newRow method with the same signature. Provided to facilitate the call from Python, otherwise the newRow method will be preferred.

HistoryRow* asdm::HistoryTable::newRow

(

HistoryRow *

row

)

Create a new row using a copy constructor mechanism.

The method creates a new HistoryRow owned by this. Each attribute of the created row is a (deep) copy of the corresponding attribute of row. The method does not add the created row to this, its simply parents it to this, 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 new HistoryRow with default values for its attributes.

Parameters:

row

the row which is to be copied.

HistoryRow* asdm::HistoryTable::newRowCopy

(

HistoryRow *

row

)

Has the same definition than the newRow method with the same signature. Provided to facilitate the call from Python, otherwise the newRow method will be preferred.

HistoryRow* asdm::HistoryTable::add

(

HistoryRow *

x

)

Add a row.

Parameters:

x

a pointer to the HistoryRow to be added.

Returns:

a pointer to a HistoryRow. If the table contains a HistoryRow whose attributes (key and mandatory values) are equal to x ones then returns a pointer on that HistoryRow, otherwise returns x.

Exceptions:

DuplicateKey

{ thrown when the table contains a HistoryRow with a key equal to the x one but having and a value section different from x one }

Note:

The row is inserted in the table in such a way that all the rows having the same value of ( execBlockId ) are stored by ascending time.

See also:

method getByContext.

vector<HistoryRow *> asdm::HistoryTable::get

(

)

Get all rows.

Returns:

Alls rows as a vector of pointers of HistoryRow. The elements of this vector are stored in the order in which they have been added to the HistoryTable.

vector<HistoryRow*>* asdm::HistoryTable::getByContext

(

Tag

execBlockId

)

Returns all the rows sorted by ascending startTime for a given context. The context is defined by a value of ( execBlockId ).

Returns:

a pointer on a vector<HistoryRow *>. A null returned value means that the table contains no HistoryRow for the given ( execBlockId ).

HistoryRow* asdm::HistoryTable::HistoryTable::getRowByKey	(	Tag	execBlockId,
		ArrayTime	time
	)

Returns a HistoryRow* given a key.

Returns:

a pointer to the row having the key whose values are passed as parameters, or 0 if no row exists for that key.

Parameters:

	execBlockId.
	time.

HistoryRow* asdm::HistoryTable::lookup	(	Tag	execBlockId,
		ArrayTime	time,
		string	message,
		string	priority,
		string	origin,
		string	objectId,
		string	application,
		string	cliCommand,
		string	appParms
	)

Look up the table for a row whose all attributes are equal to the corresponding parameters of the method.

Returns:

a pointer on this row if any, null otherwise.

Parameters:

	execBlockId.
	time.
	message.
	priority.
	origin.
	objectId.
	application.
	cliCommand.
	appParms.

HistoryTableIDL* asdm::HistoryTable::toIDL

(

)

Convert this table into a HistoryTableIDL CORBA structure.

Returns:

a pointer to a HistoryTableIDL

void asdm::HistoryTable::fromIDL

(

HistoryTableIDL

x

)

throw (DuplicateKey,ConversionException)

Populate this table from the content of a HistoryTableIDL Corba structure.

Exceptions:

	DuplicateKey	Thrown if the method tries to add a row having a key that is already in the table.
	ConversionException

char* asdm::HistoryTable::toFITS

(

)

const throw (ConversionException) [virtual]

To be implemented

Implements asdm::Representable.

void asdm::HistoryTable::fromFITS

(

char *

fits

)

throw (ConversionException) [virtual]

To be implemented

Implements asdm::Representable.

string asdm::HistoryTable::toVOTable

(

)

const throw (ConversionException) [virtual]

To be implemented

Implements asdm::Representable.

void asdm::HistoryTable::fromVOTable

(

string

vo

)

throw (ConversionException) [virtual]

To be implemented

Implements asdm::Representable.

string asdm::HistoryTable::toXML

(

)

throw (ConversionException) [virtual]

Translate this table to an XML representation conform to the schema defined for History (HistoryTable.xsd).

Returns:

a string containing the XML representation.

Implements asdm::Representable.

void asdm::HistoryTable::fromXML

(

string

xmlDoc

)

throw (ConversionException) [virtual]

Populate this table from the content of a XML document that is required to be conform to the XML schema defined for a History (HistoryTable.xsd).

Implements asdm::Representable.

string asdm::HistoryTable::toMIME

(

)

Serialize this into a stream of bytes and encapsulates that stream into a MIME message.

Returns:

a string containing the MIME message.

void asdm::HistoryTable::setFromMIME

(

const string &

mimeMsg

)

Extracts the binary part of a MIME message and deserialize its content to fill this with the result of the deserialization.

Parameters:

mimeMsg

the string containing the MIME message.

Exceptions:

ConversionException

void asdm::HistoryTable::toFile

(

string

directory

)

Stores a representation (binary or XML) of this table into a file.

Depending on the boolean value of its private field fileAsBin a binary serialization of this (fileAsBin==true) will be saved in a file "History.bin" or an XML representation (fileAsBin==false) will be saved in a file "History.xml". The file is always written in a directory whose name is passed as a parameter.

Parameters:

directory

The name of directory where the file containing the table's representation will be saved.

void asdm::HistoryTable::setFromFile

(

const string &

directory

)

Reads and parses a file containing a representation of a HistoryTable as those produced by the toFile method. This table is populated with the result of the parsing.

Parameters:

directory

The name of the directory containing the file te be read and parsed.

Exceptions:

ConversionException

If any error occurs while reading the files in the directory or parsing them.

---

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

• HistoryTable.h

---