asdm::ExecBlockTable Class Reference

#include <ExecBlockTable.h>

Detailed Description

The ExecBlockTable class is an Alma table.

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

Attributes of ExecBlock
Name Type Comment

Key

execBlockId Tag

Value
(Mandarory)

antennaId vector<Tag> numAntenna

execBlockNum int

telescopeName string

configName string

numAntenna int

baseRangeMin Length

baseRangeMax Length

baseRmsMinor Length

baseRmsMajor Length

basePa Angle

timeInterval ArrayTimeInterval

observerName string

observingLog vector<string >

schedulerMode vector<string >

projectId EntityRef

siteLongitude Angle

siteLatitude Angle

siteAltitude Length

flagRow bool

execBlockUID EntityRef

aborted bool

Value
(Optional)

releaseDate ArrayTime

Attributes of ExecBlock
Name	Type	Comment
Key
execBlockId	Tag
Value (Mandarory)
antennaId	vector<Tag>	numAntenna
execBlockNum	int
telescopeName	string
configName	string
numAntenna	int
baseRangeMin	Length
baseRangeMax	Length
baseRmsMinor	Length
baseRmsMajor	Length
basePa	Angle
timeInterval	ArrayTimeInterval
observerName	string
observingLog	vector<string >
schedulerMode	vector<string >
projectId	EntityRef
siteLongitude	Angle
siteLatitude	Angle
siteAltitude	Length
flagRow	bool
execBlockUID	EntityRef
aborted	bool
Value (Optional)
releaseDate	ArrayTime

Public Member Functions

ASDM & getContainer () const

unsigned int size ()

string getName () const

Entity getEntity () const

void setEntity (Entity e)

ExecBlockRow * newRow ()

ExecBlockRow * newRowEmpty ()

ExecBlockRow * newRow (vector< Tag > antennaId, int execBlockNum, string telescopeName, string configName, int numAntenna, Length baseRangeMin, Length baseRangeMax, Length baseRmsMinor, Length baseRmsMajor, Angle basePa, ArrayTimeInterval timeInterval, string observerName, vector< string > observingLog, vector< string > schedulerMode, EntityRef projectId, Angle siteLongitude, Angle siteLatitude, Length siteAltitude, bool flagRow, EntityRef execBlockUID, bool aborted)

ExecBlockRow * newRowFull (vector< Tag > antennaId, int execBlockNum, string telescopeName, string configName, int numAntenna, Length baseRangeMin, Length baseRangeMax, Length baseRmsMinor, Length baseRmsMajor, Angle basePa, ArrayTimeInterval timeInterval, string observerName, vector< string > observingLog, vector< string > schedulerMode, EntityRef projectId, Angle siteLongitude, Angle siteLatitude, Length siteAltitude, bool flagRow, EntityRef execBlockUID, bool aborted)

ExecBlockRow * newRow (ExecBlockRow *row)

ExecBlockRow * newRowCopy (ExecBlockRow *row)

ExecBlockRow * add (ExecBlockRow *x)

vector< ExecBlockRow * > get ()

ExecBlockRow * ExecBlockTable::getRowByKey (Tag execBlockId)

ExecBlockRow * lookup (vector< Tag > antennaId, int execBlockNum, string telescopeName, string configName, int numAntenna, Length baseRangeMin, Length baseRangeMax, Length baseRmsMinor, Length baseRmsMajor, Angle basePa, ArrayTimeInterval timeInterval, string observerName, vector< string > observingLog, vector< string > schedulerMode, EntityRef projectId, Angle siteLongitude, Angle siteLatitude, Length siteAltitude, bool flagRow, EntityRef execBlockUID, bool aborted)

ExecBlockTableIDL * toIDL ()

void fromIDL (ExecBlockTableIDL 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::ExecBlockTable::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::ExecBlockTable::getContainer ( ) const

Return the container to which this table belongs.

Returns:: the ASDM containing this table.

unsigned int asdm::ExecBlockTable::size ( ) [virtual]

Return the number of rows in the table.

Returns:: the number of rows in an unsigned int.

Implements asdm::Representable.

string asdm::ExecBlockTable::getName ( ) const [virtual]

Return the name of this table.

Returns:: the name of this table in a string.

Implements asdm::Representable.

Entity asdm::ExecBlockTable::getEntity ( ) const [virtual]

Return this table's Entity.

Implements asdm::Representable.

void asdm::ExecBlockTable::setEntity ( Entity e ) [virtual]

Set this table's Entity.

Parameters:

An entity.

Implements asdm::Representable.

ExecBlockRow* asdm::ExecBlockTable::newRow ( )

Create a new row with default values.

Returns:: a pointer on a ExecBlockRow

ExecBlockRow* asdm::ExecBlockTable::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.

ExecBlockRow* asdm::ExecBlockTable::newRow	(	vector< Tag >	antennaId,
		int	execBlockNum,
		string	telescopeName,
		string	configName,
		int	numAntenna,
		Length	baseRangeMin,
		Length	baseRangeMax,
		Length	baseRmsMinor,
		Length	baseRmsMajor,
		Angle	basePa,
		ArrayTimeInterval	timeInterval,
		string	observerName,
		vector< string >	observingLog,
		vector< string >	schedulerMode,
		EntityRef	projectId,
		Angle	siteLongitude,
		Angle	siteLatitude,
		Length	siteAltitude,
		bool	flagRow,
		EntityRef	execBlockUID,
		bool	aborted
	)

Create a new row initialized to the specified values.

Returns:: a pointer on the created and initialized row.

Parameters:

	antennaId.
	execBlockNum.
	telescopeName.
	configName.
	numAntenna.
	baseRangeMin.
	baseRangeMax.
	baseRmsMinor.
	baseRmsMajor.
	basePa.
	timeInterval.
	observerName.
	observingLog.
	schedulerMode.
	projectId.
	siteLongitude.
	siteLatitude.
	siteAltitude.
	flagRow.
	execBlockUID.
	aborted.

ExecBlockRow* asdm::ExecBlockTable::newRowFull	(	vector< Tag >	antennaId,
		int	execBlockNum,
		string	telescopeName,
		string	configName,
		int	numAntenna,
		Length	baseRangeMin,
		Length	baseRangeMax,
		Length	baseRmsMinor,
		Length	baseRmsMajor,
		Angle	basePa,
		ArrayTimeInterval	timeInterval,
		string	observerName,
		vector< string >	observingLog,
		vector< string >	schedulerMode,
		EntityRef	projectId,
		Angle	siteLongitude,
		Angle	siteLatitude,
		Length	siteAltitude,
		bool	flagRow,
		EntityRef	execBlockUID,
		bool	aborted
	)

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.

ExecBlockRow* asdm::ExecBlockTable::newRow ( ExecBlockRow * row )

Create a new row using a copy constructor mechanism.

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

Parameters:

row

the row which is to be copied.

ExecBlockRow* asdm::ExecBlockTable::newRowCopy ( ExecBlockRow * 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.

ExecBlockRow* asdm::ExecBlockTable::add ( ExecBlockRow * 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:

A pointer on the row to be added.

Returns:: a ExecBlockRow pointer.

vector<ExecBlockRow *> asdm::ExecBlockTable::get ( )

Get all rows.

Returns:: Alls rows as a vector of pointers of ExecBlockRow. The elements of this vector are stored in the order in which they have been added to the ExecBlockTable.

ExecBlockRow* asdm::ExecBlockTable::ExecBlockTable::getRowByKey ( Tag execBlockId )

Returns a ExecBlockRow* 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.

ExecBlockRow* asdm::ExecBlockTable::lookup	(	vector< Tag >	antennaId,
		int	execBlockNum,
		string	telescopeName,
		string	configName,
		int	numAntenna,
		Length	baseRangeMin,
		Length	baseRangeMax,
		Length	baseRmsMinor,
		Length	baseRmsMajor,
		Angle	basePa,
		ArrayTimeInterval	timeInterval,
		string	observerName,
		vector< string >	observingLog,
		vector< string >	schedulerMode,
		EntityRef	projectId,
		Angle	siteLongitude,
		Angle	siteLatitude,
		Length	siteAltitude,
		bool	flagRow,
		EntityRef	execBlockUID,
		bool	aborted
	)

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:

	antennaId.
	execBlockNum.
	telescopeName.
	configName.
	numAntenna.
	baseRangeMin.
	baseRangeMax.
	baseRmsMinor.
	baseRmsMajor.
	basePa.
	timeInterval.
	observerName.
	observingLog.
	schedulerMode.
	projectId.
	siteLongitude.
	siteLatitude.
	siteAltitude.
	flagRow.
	execBlockUID.
	aborted.

ExecBlockTableIDL* asdm::ExecBlockTable::toIDL ( )

Convert this table into a ExecBlockTableIDL CORBA structure.

Returns:: a pointer to a ExecBlockTableIDL

void asdm::ExecBlockTable::fromIDL ( ExecBlockTableIDL x ) throw (DuplicateKey,ConversionException)

Populate this table from the content of a ExecBlockTableIDL 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::ExecBlockTable::toFITS ( ) const throw (ConversionException) [virtual]

To be implemented

Implements asdm::Representable.

void asdm::ExecBlockTable::fromFITS ( char * fits ) throw (ConversionException) [virtual]

To be implemented

Implements asdm::Representable.

string asdm::ExecBlockTable::toVOTable ( ) const throw (ConversionException) [virtual]

To be implemented

Implements asdm::Representable.

void asdm::ExecBlockTable::fromVOTable ( string vo ) throw (ConversionException) [virtual]

To be implemented

Implements asdm::Representable.

string asdm::ExecBlockTable::toXML ( ) throw (ConversionException) [virtual]

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

Returns:: a string containing the XML representation.

Implements asdm::Representable.

void asdm::ExecBlockTable::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 ExecBlock (ExecBlockTable.xsd).

Implements asdm::Representable.

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

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

ExecBlockTable.h

Generated on Thu Nov 29 16:46:49 2007 for ASDM C++ Implementation by

1.5.1


Public Member Functions
ASDM &	getContainer () const
unsigned int	size ()
string	getName () const
Entity	getEntity () const
void	setEntity (Entity e)
ExecBlockRow *	newRow ()
ExecBlockRow *	newRowEmpty ()
ExecBlockRow *	newRow (vector< Tag > antennaId, int execBlockNum, string telescopeName, string configName, int numAntenna, Length baseRangeMin, Length baseRangeMax, Length baseRmsMinor, Length baseRmsMajor, Angle basePa, ArrayTimeInterval timeInterval, string observerName, vector< string > observingLog, vector< string > schedulerMode, EntityRef projectId, Angle siteLongitude, Angle siteLatitude, Length siteAltitude, bool flagRow, EntityRef execBlockUID, bool aborted)
ExecBlockRow *	newRowFull (vector< Tag > antennaId, int execBlockNum, string telescopeName, string configName, int numAntenna, Length baseRangeMin, Length baseRangeMax, Length baseRmsMinor, Length baseRmsMajor, Angle basePa, ArrayTimeInterval timeInterval, string observerName, vector< string > observingLog, vector< string > schedulerMode, EntityRef projectId, Angle siteLongitude, Angle siteLatitude, Length siteAltitude, bool flagRow, EntityRef execBlockUID, bool aborted)
ExecBlockRow *	newRow (ExecBlockRow *row)
ExecBlockRow *	newRowCopy (ExecBlockRow *row)
ExecBlockRow *	add (ExecBlockRow *x)
vector< ExecBlockRow * >	get ()
ExecBlockRow *	ExecBlockTable::getRowByKey (Tag execBlockId)
ExecBlockRow *	lookup (vector< Tag > antennaId, int execBlockNum, string telescopeName, string configName, int numAntenna, Length baseRangeMin, Length baseRangeMax, Length baseRmsMinor, Length baseRmsMajor, Angle basePa, ArrayTimeInterval timeInterval, string observerName, vector< string > observingLog, vector< string > schedulerMode, EntityRef projectId, Angle siteLongitude, Angle siteLatitude, Length siteAltitude, bool flagRow, EntityRef execBlockUID, bool aborted)
ExecBlockTableIDL *	toIDL ()
void	fromIDL (ExecBlockTableIDL 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