asdm::SourceParameterTable Class Reference

#include <SourceParameterTable.h>

Inherits asdm::Representable.

List of all members.

Detailed Description

The SourceParameterTable class is an Alma table.

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

Attributes of SourceParameter
Name Type Comment

Key

sourceParameterId int  

sourceId int  

timeInterval ArrayTimeInterval  

Value
(Mandarory)

numFreq int  

numStokes int  

numDep int  

stokesParameter vector<StokesParameterMod::StokesParameter > numStokes

flux vector<vector<Flux > > numFreq, numStokes

frequency vector<Frequency > numFreq

frequencyInterval vector<Frequency > numFreq

fluxErr vector<vector<Flux > > numFreq, numStokes

Value
(Optional)

size vector<vector<Angle > > numFreq, 2

positionAngle vector<Angle > numFreq

sizeErr vector<vector<Angle > > numFreq, 2

positionAngleErr vector<Angle > numFreq

depSourceParameterId vector<int > numDep


Public Member Functions

ASDM & getContainer () const
unsigned int size ()
string getName () const
Entity getEntity () const
void setEntity (Entity e)
SourceParameterRow * newRow ()
SourceParameterRow * newRowEmpty ()
SourceParameterRow * newRow (int sourceId, ArrayTimeInterval timeInterval, int numFreq, int numStokes, int numDep, vector< StokesParameterMod::StokesParameter > stokesParameter, vector< vector< Flux > > flux, vector< Frequency > frequency, vector< Frequency > frequencyInterval, vector< vector< Flux > > fluxErr)
SourceParameterRow * newRowFull (int sourceId, ArrayTimeInterval timeInterval, int numFreq, int numStokes, int numDep, vector< StokesParameterMod::StokesParameter > stokesParameter, vector< vector< Flux > > flux, vector< Frequency > frequency, vector< Frequency > frequencyInterval, vector< vector< Flux > > fluxErr)
SourceParameterRow * newRow (SourceParameterRow *row)
SourceParameterRow * newRowCopy (SourceParameterRow *row)
SourceParameterRow * add (SourceParameterRow *x)
vector< SourceParameterRow * > get ()
SourceParameterRow * getRowByKey (int sourceParameterId, int sourceId, ArrayTimeInterval timeInterval)
vector< SourceParameterRow * > getRowBySourceParameterId (int)
SourceParameterRow * lookup (int sourceId, ArrayTimeInterval timeInterval, int numFreq, int numStokes, int numDep, vector< StokesParameterMod::StokesParameter > stokesParameter, vector< vector< Flux > > flux, vector< Frequency > frequency, vector< Frequency > frequencyInterval, vector< vector< Flux > > fluxErr)
SourceParameterTableIDL * toIDL ()
void fromIDL (SourceParameterTableIDL 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

vector< string > getKeyName ()

Member Function Documentation

SourceParameterRow* asdm::SourceParameterTable::add (  SourceParameterRow *  x  ) 
 

Add a row. If there table contains a row whose key's fields except² sourceParameterId 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 SourceParameterRow pointer.

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

To be implemented

Implements asdm::Representable.

void asdm::SourceParameterTable::fromIDL (  SourceParameterTableIDL  x  )  throw (DuplicateKey,ConversionException)
 

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

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

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

To be implemented

Implements asdm::Representable.

void asdm::SourceParameterTable::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 SourceParameter (SourceParameterTable.xsd).

Implements asdm::Representable.

vector<SourceParameterRow *> asdm::SourceParameterTable::get (   ) 
 

Get all rows.

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

ASDM& asdm::SourceParameterTable::getContainer (   )  const
 

Return the container to which this table belongs.

Returns:
the ASDM containing this table.

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

Return this table's Entity.

Implements asdm::Representable.

vector<string> asdm::SourceParameterTable::getKeyName (   )  [static]
 

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

Returns:
a vector of string.

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

Return the name of this table.

Returns:
the name of this table in a string.

Implements asdm::Representable.

SourceParameterRow* asdm::SourceParameterTable::getRowByKey (  int  sourceParameterId,
int  sourceId,
ArrayTimeInterval  timeInterval
) 
 

Returns a SourceParameterRow* 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:
sourceParameterId. 
sourceId. 
timeInterval. 

vector<SourceParameterRow *> asdm::SourceParameterTable::getRowBySourceParameterId (  int   ) 
 

Returns a vector of pointers on rows whose key element <<autoincrementableattribute>> sourceParameterId is equal to the parameter <<autoincrementableattribute>> sourceParameterId.

Returns:
a vector of vector <SourceParameterRow *>. A returned vector of size 0 means that no row has been found.
Parameters:
sourceParameterId int contains the value of the autoincrementable attribute that is looked up in the table.

SourceParameterRow* asdm::SourceParameterTable::lookup (  int  sourceId,
ArrayTimeInterval  timeInterval,
int  numFreq,
int  numStokes,
int  numDep,
vector< StokesParameterMod::StokesParameter >  stokesParameter,
vector< vector< Flux > >  flux,
vector< Frequency >  frequency,
vector< Frequency >  frequencyInterval,
vector< vector< Flux > >  fluxErr
) 
 

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:
sourceId. 
timeInterval. 
numFreq. 
numStokes. 
numDep. 
stokesParameter. 
flux. 
frequency. 
frequencyInterval. 
fluxErr. 

SourceParameterRow* asdm::SourceParameterTable::newRow (  SourceParameterRow *  row  ) 
 

Create a new row using a copy constructor mechanism.

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

Parameters:
row the row which is to be copied.

SourceParameterRow* asdm::SourceParameterTable::newRow (  int  sourceId,
ArrayTimeInterval  timeInterval,
int  numFreq,
int  numStokes,
int  numDep,
vector< StokesParameterMod::StokesParameter >  stokesParameter,
vector< vector< Flux > >  flux,
vector< Frequency >  frequency,
vector< Frequency >  frequencyInterval,
vector< vector< Flux > >  fluxErr
) 
 

Create a new row initialized to the specified values.

Returns:
a pointer on the created and initialized row.
Parameters:
sourceId. 
timeInterval. 
numFreq. 
numStokes. 
numDep. 
stokesParameter. 
flux. 
frequency. 
frequencyInterval. 
fluxErr. 

SourceParameterRow* asdm::SourceParameterTable::newRow (   ) 
 

Create a new row with default values.

Returns:
a pointer on a SourceParameterRow

SourceParameterRow* asdm::SourceParameterTable::newRowCopy (  SourceParameterRow *  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.

SourceParameterRow* asdm::SourceParameterTable::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.

SourceParameterRow* asdm::SourceParameterTable::newRowFull (  int  sourceId,
ArrayTimeInterval  timeInterval,
int  numFreq,
int  numStokes,
int  numDep,
vector< StokesParameterMod::StokesParameter >  stokesParameter,
vector< vector< Flux > >  flux,
vector< Frequency >  frequency,
vector< Frequency >  frequencyInterval,
vector< vector< Flux > >  fluxErr
) 
 

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.

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

Set this table's Entity.

Parameters:
e An entity.

Implements asdm::Representable.

void asdm::SourceParameterTable::setFromFile (  const string &  directory  ) 
 

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

void asdm::SourceParameterTable::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 

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

Return the number of rows in the table.

Returns:
the number of rows in an unsigned int.

Implements asdm::Representable.

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

char* asdm::SourceParameterTable::toFITS (   )  const throw (ConversionException) [virtual]
 

To be implemented

Implements asdm::Representable.

SourceParameterTableIDL* asdm::SourceParameterTable::toIDL (   ) 
 

Convert this table into a SourceParameterTableIDL CORBA structure.

Returns:
a pointer to a SourceParameterTableIDL

string asdm::SourceParameterTable::toMIME (   ) 
 

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

Returns:
a string containing the MIME message.

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

To be implemented

Implements asdm::Representable.

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

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

Returns:
a string containing the XML representation.

Implements asdm::Representable.

The documentation for this class was generated from the following file:
Generated on Tue Nov 18 17:43:47 2008 for ASDM C++ Implementation by doxygen 1.3.8