asdm::StateTable Class Reference

#include <StateTable.h>

Inherits asdm::Representable.

List of all members.

---

Detailed Description

The StateTable class is an Alma table.

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

Attributes of State

Name	Type	Comment
Key
stateId	Tag
Value (Mandarory)
sig	bool
ref	bool
onSky	bool
calDeviceName	CalibrationDevice
flagRow	bool
Value (Optional)
weight	float

Public Member Functions
ASDM &	getContainer () const
unsigned int	size ()
string	getName () const
Entity	getEntity () const
void	setEntity (Entity e)
StateRow *	newRow ()
StateRow *	newRowEmpty ()
StateRow *	newRow (bool sig, bool ref, bool onSky, CalibrationDevice calDeviceName, bool flagRow)
StateRow *	newRowFull (bool sig, bool ref, bool onSky, CalibrationDevice calDeviceName, bool flagRow)
StateRow *	newRow (StateRow *row)
StateRow *	newRowCopy (StateRow *row)
StateRow *	add (StateRow *x)
vector< StateRow * >	get ()
StateRow *	StateTable::getRowByKey (Tag stateId)
StateRow *	lookup (bool sig, bool ref, bool onSky, CalibrationDevice calDeviceName, bool flagRow)
StateTableIDL *	toIDL ()
void	fromIDL (StateTableIDL 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::StateTable::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::StateTable::getContainer

(

)

const

Return the container to which this table belongs.

Returns:

the ASDM containing this table.

unsigned int asdm::StateTable::size

(

)

[virtual]

Return the number of rows in the table.

Returns:

the number of rows in an unsigned int.

Implements asdm::Representable.

string asdm::StateTable::getName

(

)

const [virtual]

Return the name of this table.

Returns:

the name of this table in a string.

Implements asdm::Representable.

Entity asdm::StateTable::getEntity

(

)

const [virtual]

Return this table's Entity.

Implements asdm::Representable.

void asdm::StateTable::setEntity

(

Entity

e

)

[virtual]

Set this table's Entity.

Parameters:

e

An entity.

Implements asdm::Representable.

StateRow* asdm::StateTable::newRow

(

)

Create a new row with default values.

Returns:

a pointer on a StateRow

StateRow* asdm::StateTable::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.

StateRow* asdm::StateTable::newRow	(	bool	sig,
		bool	ref,
		bool	onSky,
		CalibrationDevice	calDeviceName,
		bool	flagRow
	)

Create a new row initialized to the specified values.

Returns:

a pointer on the created and initialized row.

Parameters:

	sig.
	ref.
	onSky.
	calDeviceName.
	flagRow.

StateRow* asdm::StateTable::newRowFull	(	bool	sig,
		bool	ref,
		bool	onSky,
		CalibrationDevice	calDeviceName,
		bool	flagRow
	)

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.

StateRow* asdm::StateTable::newRow

(

StateRow *

row

)

Create a new row using a copy constructor mechanism.

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

Parameters:

row

the row which is to be copied.

StateRow* asdm::StateTable::newRowCopy

(

StateRow *

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.

StateRow* asdm::StateTable::add

(

StateRow *

x

)

Add a row. If there table contains a row whose key's fields are equal to x's ones then return a pointer on this row (i.e. no actual insertion is performed) otherwise add x to the table and return x.

Parameters:

x.

A pointer on the row to be added.

Returns:

a StateRow pointer.

vector<StateRow *> asdm::StateTable::get

(

)

Get all rows.

Returns:

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

StateRow* asdm::StateTable::StateTable::getRowByKey

(

Tag

stateId

)

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

stateId.

StateRow* asdm::StateTable::lookup	(	bool	sig,
		bool	ref,
		bool	onSky,
		CalibrationDevice	calDeviceName,
		bool	flagRow
	)

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

Returns:

a pointer on this row if any, null otherwise.

Parameters:

	sig.
	ref.
	onSky.
	calDeviceName.
	flagRow.

StateTableIDL* asdm::StateTable::toIDL

(

)

Convert this table into a StateTableIDL CORBA structure.

Returns:

a pointer to a StateTableIDL

void asdm::StateTable::fromIDL

(

StateTableIDL

x

)

throw (DuplicateKey,ConversionException)

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

(

)

const throw (ConversionException) [virtual]

To be implemented

Implements asdm::Representable.

void asdm::StateTable::fromFITS

(

char *

fits

)

throw (ConversionException) [virtual]

To be implemented

Implements asdm::Representable.

string asdm::StateTable::toVOTable

(

)

const throw (ConversionException) [virtual]

To be implemented

Implements asdm::Representable.

void asdm::StateTable::fromVOTable

(

string

vo

)

throw (ConversionException) [virtual]

To be implemented

Implements asdm::Representable.

string asdm::StateTable::toXML

(

)

throw (ConversionException) [virtual]

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

Returns:

a string containing the XML representation.

Implements asdm::Representable.

void asdm::StateTable::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 State (StateTable.xsd).

Implements asdm::Representable.

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

(

const string &

directory

)

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

• StateTable.h

---