asdm::DataDescriptionTable Class Reference

#include <DataDescriptionTable.h>

Inherits asdm::Representable.

List of all members.

---

Detailed Description

The DataDescriptionTable class is an Alma table.

Attributes of DataDescription

Name	Type	Comment
Key
dataDescriptionId	<U> Tag</U>
Value (Mandarory)
polOrHoloId	Tag
spectralWindowId	Tag
Value (Optional)
flagRow	bool

Public Member Functions
ASDM &	getContainer () const
unsigned int	size ()
string	getName () const
Entity	getEntity () const
void	setEntity (Entity e)
DataDescriptionRow *	newRow ()
DataDescriptionRow *	newRowEmpty ()
DataDescriptionRow *	newRow (Tag polOrHoloId, Tag spectralWindowId)
DataDescriptionRow *	newRowFull (Tag polOrHoloId, Tag spectralWindowId)
DataDescriptionRow *	newRow (DataDescriptionRow *row)
DataDescriptionRow *	newRowCopy (DataDescriptionRow *row)
DataDescriptionRow *	add (DataDescriptionRow *x)
vector< DataDescriptionRow * >	get ()
DataDescriptionRow *	DataDescriptionTable::getRowByKey (Tag dataDescriptionId)
DataDescriptionRow *	lookup (Tag polarizationId, Tag spectralWindowId)
DataDescriptionTableIDL *	toIDL ()
void	fromIDL (DataDescriptionTableIDL 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::DataDescriptionTable::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::DataDescriptionTable::getContainer

(

)

const

Return the container to which this table belongs.

Returns:

the ASDM containing this table.

unsigned int asdm::DataDescriptionTable::size

(

)

[virtual]

Return the number of rows in the table.

Returns:

the number of rows in an unsigned int.

Implements asdm::Representable.

string asdm::DataDescriptionTable::getName

(

)

const [virtual]

Return the name of this table.

Returns:

the name of this table in a string.

Implements asdm::Representable.

Entity asdm::DataDescriptionTable::getEntity

(

)

const [virtual]

Return this table's Entity.

Implements asdm::Representable.

void asdm::DataDescriptionTable::setEntity

(

Entity

e

)

[virtual]

Set this table's Entity.

Parameters:

e

An entity.

Implements asdm::Representable.

DataDescriptionRow* asdm::DataDescriptionTable::newRow

(

)

Create a new row with default values.

Returns:

a pointer on a DataDescriptionRow

DataDescriptionRow* asdm::DataDescriptionTable::newRowEmpty

(

)

Same as the newRow method with the same signature. Defined to facilitate the call from Python.

DataDescriptionRow* asdm::DataDescriptionTable::newRow	(	Tag	polOrHoloId,
		Tag	spectralWindowId
	)

Create a new row initialized to the specified values.

Returns:

a pointer on the created and initialized row.

Parameters:

	polOrHoloId.
	spectralWindowId.

DataDescriptionRow* asdm::DataDescriptionTable::newRowFull	(	Tag	polOrHoloId,
		Tag	spectralWindowId
	)

Same as the newRow method with the same signature. Defined to facilitate the call from Python.

DataDescriptionRow* asdm::DataDescriptionTable::newRow

(

DataDescriptionRow *

row

)

Create a new row using a copy constructor mechanism.

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

Parameters:

row

the row which is to be copied.

DataDescriptionRow* asdm::DataDescriptionTable::newRowCopy

(

DataDescriptionRow *

row

)

Same definition as the newRow method with the same signature. Defined to facilitate the call from Python.

DataDescriptionRow* asdm::DataDescriptionTable::add

(

DataDescriptionRow *

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 DataDescriptionRow pointer.

vector<DataDescriptionRow *> asdm::DataDescriptionTable::get

(

)

Get all rows.

Returns:

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

DataDescriptionRow* asdm::DataDescriptionTable::DataDescriptionTable::getRowByKey

(

Tag

dataDescriptionId

)

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

dataDescriptionId.

DataDescriptionRow* asdm::DataDescriptionTable::lookup	(	Tag	polarizationId,
		Tag	spectralWindowId
	)

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:

	polarizationId.
	spectralWindowId.

DataDescriptionTableIDL* asdm::DataDescriptionTable::toIDL

(

)

Convert this table into a DataDescriptionTableIDL CORBA structure.

Returns:

a pointer to a DataDescriptionTableIDL

void asdm::DataDescriptionTable::fromIDL

(

DataDescriptionTableIDL

x

)

throw (DuplicateKey,ConversionException)

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

(

)

const throw (ConversionException) [virtual]

To be implemented

Implements asdm::Representable.

void asdm::DataDescriptionTable::fromFITS

(

char *

fits

)

throw (ConversionException) [virtual]

To be implemented

Implements asdm::Representable.

string asdm::DataDescriptionTable::toVOTable

(

)

const throw (ConversionException) [virtual]

To be implemented

Implements asdm::Representable.

void asdm::DataDescriptionTable::fromVOTable

(

string

vo

)

throw (ConversionException) [virtual]

To be implemented

Implements asdm::Representable.

string asdm::DataDescriptionTable::toXML

(

)

throw (ConversionException) [virtual]

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

Returns:

a string containing the XML representation.

Implements asdm::Representable.

void asdm::DataDescriptionTable::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 DataDescription (DataDescriptionTable.xsd).

Implements asdm::Representable.

string asdm::DataDescriptionTable::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::DataDescriptionTable::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::DataDescriptionTable::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 "DataDescription.bin" or an XML representation (fileAsBin==false) will be saved in a file "DataDescription.xml". The file is always written in a directory whose name is passed as a parameter.

void asdm::DataDescriptionTable::setFromFile

(

const string &

directory

)

Reads and parses a collection of files 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 files.

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:

• DataDescriptionTable.h

---