asdm::FlagCmdTable Class Reference

#include <FlagCmdTable.h>

Inherits asdm::Representable.

List of all members.

---

Detailed Description

The FlagCmdTable class is an Alma table.

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

Attributes of FlagCmd

Name	Type	Comment
Key
timeInterval	ArrayTimeInterval
Value (Mandarory)
type	string
reason	string
level	int
severity	int
applied	bool
command	string

Public Member Functions
ASDM &	getContainer () const
unsigned int	size ()
string	getName () const
Entity	getEntity () const
void	setEntity (Entity e)
FlagCmdRow *	newRow ()
FlagCmdRow *	newRowEmpty ()
FlagCmdRow *	newRow (ArrayTimeInterval timeInterval, string type, string reason, int level, int severity, bool applied, string command)
FlagCmdRow *	newRowFull (ArrayTimeInterval timeInterval, string type, string reason, int level, int severity, bool applied, string command)
FlagCmdRow *	newRow (FlagCmdRow *row)
FlagCmdRow *	newRowCopy (FlagCmdRow *row)
FlagCmdRow *	add (FlagCmdRow *x)
vector< FlagCmdRow * >	get ()
vector< FlagCmdRow * > *	getByContext ()
FlagCmdRow *	FlagCmdTable::getRowByKey (ArrayTimeInterval timeInterval)
FlagCmdRow *	lookup (ArrayTimeInterval timeInterval, string type, string reason, int level, int severity, bool applied, string command)
FlagCmdTableIDL *	toIDL ()
void	fromIDL (FlagCmdTableIDL 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::FlagCmdTable::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::FlagCmdTable::getContainer

(

)

const

Return the container to which this table belongs.

Returns:

the ASDM containing this table.

unsigned int asdm::FlagCmdTable::size

(

)

[virtual]

Return the number of rows in the table.

Returns:

the number of rows in an unsigned int.

Implements asdm::Representable.

string asdm::FlagCmdTable::getName

(

)

const [virtual]

Return the name of this table.

Returns:

the name of this table in a string.

Implements asdm::Representable.

Entity asdm::FlagCmdTable::getEntity

(

)

const [virtual]

Return this table's Entity.

Implements asdm::Representable.

void asdm::FlagCmdTable::setEntity

(

Entity

e

)

[virtual]

Set this table's Entity.

Parameters:

e

An entity.

Implements asdm::Representable.

FlagCmdRow* asdm::FlagCmdTable::newRow

(

)

Create a new row with default values.

Returns:

a pointer on a FlagCmdRow

FlagCmdRow* asdm::FlagCmdTable::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.

FlagCmdRow* asdm::FlagCmdTable::newRow	(	ArrayTimeInterval	timeInterval,
		string	type,
		string	reason,
		int	level,
		int	severity,
		bool	applied,
		string	command
	)

Create a new row initialized to the specified values.

Returns:

a pointer on the created and initialized row.

Parameters:

	timeInterval.
	type.
	reason.
	level.
	severity.
	applied.
	command.

FlagCmdRow* asdm::FlagCmdTable::newRowFull	(	ArrayTimeInterval	timeInterval,
		string	type,
		string	reason,
		int	level,
		int	severity,
		bool	applied,
		string	command
	)

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.

FlagCmdRow* asdm::FlagCmdTable::newRow

(

FlagCmdRow *

row

)

Create a new row using a copy constructor mechanism.

The method creates a new FlagCmdRow 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 FlagCmdRow with default values for its attributes.

Parameters:

row

the row which is to be copied.

FlagCmdRow* asdm::FlagCmdTable::newRowCopy

(

FlagCmdRow *

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.

FlagCmdRow* asdm::FlagCmdTable::add

(

FlagCmdRow *

x

)

Add a row.

Parameters:

x

a pointer to the FlagCmdRow to be added.

Returns:

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

Exceptions:

DuplicateKey

{ thrown when the table contains a FlagCmdRow 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 ( ) are stored by ascending time.

See also:

method getByContext.

vector<FlagCmdRow *> asdm::FlagCmdTable::get

(

)

Get all rows.

Returns:

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

vector<FlagCmdRow*>* asdm::FlagCmdTable::getByContext

(

)

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

Returns:

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

FlagCmdRow* asdm::FlagCmdTable::FlagCmdTable::getRowByKey

(

ArrayTimeInterval

timeInterval

)

Returns a FlagCmdRow* 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:

timeInterval.

FlagCmdRow* asdm::FlagCmdTable::lookup	(	ArrayTimeInterval	timeInterval,
		string	type,
		string	reason,
		int	level,
		int	severity,
		bool	applied,
		string	command
	)

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:

	timeInterval.
	type.
	reason.
	level.
	severity.
	applied.
	command.

FlagCmdTableIDL* asdm::FlagCmdTable::toIDL

(

)

Convert this table into a FlagCmdTableIDL CORBA structure.

Returns:

a pointer to a FlagCmdTableIDL

void asdm::FlagCmdTable::fromIDL

(

FlagCmdTableIDL

x

)

throw (DuplicateKey,ConversionException)

Populate this table from the content of a FlagCmdTableIDL 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::FlagCmdTable::toFITS

(

)

const throw (ConversionException) [virtual]

To be implemented

Implements asdm::Representable.

void asdm::FlagCmdTable::fromFITS

(

char *

fits

)

throw (ConversionException) [virtual]

To be implemented

Implements asdm::Representable.

string asdm::FlagCmdTable::toVOTable

(

)

const throw (ConversionException) [virtual]

To be implemented

Implements asdm::Representable.

void asdm::FlagCmdTable::fromVOTable

(

string

vo

)

throw (ConversionException) [virtual]

To be implemented

Implements asdm::Representable.

string asdm::FlagCmdTable::toXML

(

)

throw (ConversionException) [virtual]

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

Returns:

a string containing the XML representation.

Implements asdm::Representable.

void asdm::FlagCmdTable::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 FlagCmd (FlagCmdTable.xsd).

Implements asdm::Representable.

string asdm::FlagCmdTable::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::FlagCmdTable::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::FlagCmdTable::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 "FlagCmd.bin" or an XML representation (fileAsBin==false) will be saved in a file "FlagCmd.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::FlagCmdTable::setFromFile

(

const string &

directory

)

Reads and parses a file containing a representation of a FlagCmdTable 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:

• FlagCmdTable.h

---