asdm::EphemerisTable Class Reference

The EphemerisTable class is an Alma table. More...

#include <EphemerisTable.h>

Inheritance diagram for asdm::EphemerisTable:

Public Member Functions
virtual	~EphemerisTable ()
ASDM &	getContainer () const
	Return the container to which this table belongs.
unsigned int	size () const
	Return the number of rows in the table.
std::string	getName () const
	Return the name of this table.
std::string	getVersion () const
	Return the version information about this table.
Entity	getEntity () const
	Return this table's Entity.
void	setEntity (Entity e)
	Set this table's Entity.
std::string	toXML ()
	Produces an XML representation conform to the schema defined for Ephemeris (EphemerisTable.xsd).
asdmIDL::EphemerisTableIDL *	toIDL ()
	Conversion Methods.
void	toIDL (asdmIDL::EphemerisTableIDL &x) const
	Fills the CORBA data structure passed in parameter with the content of this table.
void	fromIDL (asdmIDL::EphemerisTableIDL x)
	Populate this table from the content of a EphemerisTableIDL Corba structure.
EphemerisRow *	newRow ()
	====> Row creation.
EphemerisRow *	newRow (ArrayTimeInterval timeInterval, int ephemerisId, vector< double > observerLocation, double equinoxEquator, int numPolyDir, vector< vector< double > > dir, int numPolyDist, vector< double > distance, ArrayTime timeOrigin, string origin)
	Create a new row initialized to the specified values.
EphemerisRow *	newRow (EphemerisRow *row)
	Create a new row using a copy constructor mechanism.
EphemerisRow *	add (EphemerisRow *x)
	====> Append a row to its table.
std::vector< EphemerisRow * >	get ()
	====> Methods returning rows.
const std::vector < EphemerisRow * > &	get () const
	Get a const reference on the collection of rows pointers internally hold by the table.
std::vector< EphemerisRow * > *	getByContext (int ephemerisId)
	Returns all the rows sorted by ascending startTime for a given context.
EphemerisRow *	getRowByKey (ArrayTimeInterval timeInterval, int ephemerisId)
	Returns a EphemerisRow* given a key.
EphemerisRow *	lookup (ArrayTimeInterval timeInterval, int ephemerisId, vector< double > observerLocation, double equinoxEquator, int numPolyDir, vector< vector< double > > dir, int numPolyDist, vector< double > distance, ArrayTime timeOrigin, string origin)
	Look up the table for a row whose all attributes are equal to the corresponding parameters of the method.
void	setUnknownAttributeBinaryReader (const std::string &attributeName, BinaryAttributeReaderFunctor *barFctr)
BinaryAttributeReaderFunctor *	getUnknownAttributeBinaryReader (const std::string &attributeName) const
Static Public Member Functions
static const std::vector < std::string > &	getKeyName ()
	Return the list of field names that make up key key as an array of strings.
static std::string	name ()
	Return the name of this table.
static const std::vector < std::string > &	getAttributesNames ()
	Return the names of the attributes of this table.
static const std::vector < std::string > &	defaultAttributesNamesInBin ()
	Return the default sorted list of attributes names in the binary representation of the table.
Private Types
typedef std::vector < EphemerisRow * >	TIME_ROWS
Private Member Functions
	EphemerisTable (ASDM &container)
	Create a EphemerisTable.
EphemerisRow *	checkAndAdd (EphemerisRow *x, bool skipCheckUniqueness=false)
	If this table has an autoincrementable attribute then check if *x verifies the rule of uniqueness and throw exception if not.
void	append (EphemerisRow *x)
	Brutally append an EphemerisRow x to the collection of rows already stored in this table.
void	addWithoutCheckingUnique (EphemerisRow *x)
	Brutally append an EphemerisRow x to the collection of rows already stored in this table.
EphemerisRow *	insertByStartTime (EphemerisRow x, std::vector< EphemerisRow > &row)
	Insert a EphemerisRow* in a vector of EphemerisRow* so that it's ordered by ascending time.
std::string	Key (int ephemerisId)
	Returns a string built by concatenating the ascii representation of the parameters values suffixed with a "_" character.
void	getByKeyNoAutoIncNoTime (std::vector< EphemerisRow * > &vin, std::vector< EphemerisRow * > &vout, int ephemerisId)
	Fills the vector vout (passed by reference) with pointers on elements of vin whose attributes are equal to the corresponding parameters of the method.
void	error ()
void	fromXML (std::string &xmlDoc)
	Populate this table from the content of a XML document that is required to be conform to the XML schema defined for a Ephemeris (EphemerisTable.xsd).
void	setFromMIMEFile (const std::string &directory)
	Private methods involved during the build of this table out of the content of file(s) containing an external representation of a Ephemeris table.
void	setFromXMLFile (const std::string &directory)
std::string	toMIME (const asdm::ByteOrder *byteOrder=asdm::ByteOrder::Machine_Endianity)
	Serialize this into a stream of bytes and encapsulates that stream into a MIME message.
void	setFromMIME (const std::string &mimeMsg)
	Extracts the binary part of a MIME message and deserialize its content to fill this with the result of the deserialization.
std::string	MIMEXMLPart (const asdm::ByteOrder *byteOrder=asdm::ByteOrder::Machine_Endianity)
	Private methods involved during the export of this table into disk file(s).
void	toFile (std::string directory)
	Stores a representation (binary or XML) of this table into a file.
void	checkPresenceInMemory ()
void	setFromFile (const std::string &directory)
	Reads and parses a file containing a representation of a EphemerisTable as those produced by the toFile method.
Private Attributes
ASDM &	container
bool	archiveAsBin
bool	fileAsBin
std::string	version
Entity	entity
std::vector< EphemerisRow * >	privateRows
	A data structure to store the pointers on the table's rows.
std::map< std::string, TIME_ROWS >	context
std::map< std::string, BinaryAttributeReaderFunctor * >	unknownAttributes2Functors
bool	loadInProgress
	Load the table in memory if necessary.
Friends
class	ASDM

Detailed Description

The EphemerisTable class is an Alma table.

Role

Generated from model's revision "-1", branch ""

Attributes of Ephemeris
Name	Type	Expected shape	Comment
Key
timeInterval	ArrayTimeInterval		interval of time during which the data are relevant.
ephemerisId	int		identifies a collection of rows in the table.
Value (Mandatory)
observerLocation	vector<double >	3	a triple of double precision values defining the observer location. This triple contains in that order the longitude, the latitude and the altitude of the observer : the longitude is expressed in radian. An east (resp. west) longitude is denoted as a positive (resp. negative) quantity. the latitude is expressed in radian. A north (resp. south) latitude is denoted as a positive (resp. negative) quantity. the altitude is expressed in meter. It's the altitude above the reference ellipsoid. A triple with all its elements equal to 0.0 will mean that a geocentric coordinate system is in use instead of a topocentric one.
equinoxEquator	double		epoch at which equator and equinox were calculated for ephemeris. Expresses a year as a decimal value (J2000 would be represented as 2000.0).
numPolyDir	int		the number of coefficients of the polynomial stored in phaseDir. It has to be $\ge 1$ .
dir	vector<vector<double > >	numPolyDir, 2	the ephemeris direction expressed in radian. The nominal entry in the phaseDir, delayDir, or ReferenceDir in the Field table serves as additional offset to the direction described by "dir". The actual direction is obtained by composition, e.g. actual phase direction = [phasDir value from Field table] + [dir]. The direction described by dir is the result of the sum $dir_{0,i} + dir_{1,i}dt + dir_{2,i}dt^2 + ... + dir_{numPolyDir-1,i}*dt^{numPolyDir-1}, \forall i \in \{0,1\}$ where $dt = t - timeOrigin$
numPolyDist	int		the number of coefficients of the polynomial stored in distance. It has to be $\ge 1$ .
distance	vector<double >	numPolyDist	the coefficiens of the polynomial used to calculate the distance, expressed in meter, to the object from the position of the antenna along the given direction. This distance is the result of the sum : $distance_0 + distance_1dt + distance_2dt^2 + ... + distance_{numPolyDist-1}*dt^{numPolyDist-1}$ where $dt = t - timeOrigin$ .
timeOrigin	ArrayTime		the time origin used in the evaluation of the polynomial expressions.
origin	string		the origin of the ephemeris information.
Value (Optional)
numPolyRadVel	int		the number of coefficients of the polynomial stored in radVel . It has to be $\ge 1$ .
radVel	vector<double >	numPolyRadVel	the coefficients of a polynomial expressing a radial velocity as a function of the time expressed in m/s. The time origin used to tabulate the polynomial is stored in timeOrigin.

Definition at line 239 of file EphemerisTable.h.

Member Typedef Documentation

typedef std::vector<EphemerisRow* > asdm::EphemerisTable::TIME_ROWS [private]

Definition at line 598 of file EphemerisTable.h.

Constructor & Destructor Documentation

virtual asdm::EphemerisTable::~EphemerisTable ( ) [virtual]

asdm::EphemerisTable::EphemerisTable ( ASDM & container ) [private]

Create a EphemerisTable.

This constructor is private because only the container can create tables. All tables must know the container to which they belong.

Parameters:

container

The container to which this table belongs.

Member Function Documentation

EphemerisRow* asdm::EphemerisTable::add ( EphemerisRow * x )

====> Append a row to its table.

Add a row.

Parameters:

x

a pointer to the EphemerisRow to be added.

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

Exceptions:

DuplicateKey

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

See also:: method getByContext.

void asdm::EphemerisTable::addWithoutCheckingUnique ( EphemerisRow * x ) [private]

Brutally append an EphemerisRow x to the collection of rows already stored in this table.

No uniqueness check is done !

Parameters:

EphemerisRow*

x a pointer onto the EphemerisRow to be appended.

void asdm::EphemerisTable::append ( EphemerisRow * x ) [private]

Brutally append an EphemerisRow x to the collection of rows already stored in this table.

No uniqueness check is done !

Parameters:

EphemerisRow*

x a pointer onto the EphemerisRow to be appended.

EphemerisRow* asdm::EphemerisTable::checkAndAdd	(	EphemerisRow *	x,
		bool	skipCheckUniqueness = `false`
	)			`[private]`

If this table has an autoincrementable attribute then check if *x verifies the rule of uniqueness and throw exception if not.

Check if *x verifies the key uniqueness rule and throw an exception if not. Append x to its table.

Exceptions:

DuplicateKey

void asdm::EphemerisTable::checkPresenceInMemory ( ) [inline, private]

Definition at line 680 of file EphemerisTable.h.

References getContainer(), loadInProgress, asdm::Representable::presentInMemory, and setFromFile().

static const std::vector<std::string>& asdm::EphemerisTable::defaultAttributesNamesInBin ( ) [static]

Return the default sorted list of attributes names in the binary representation of the table.

Returns:: a const reference to a vector of string

void asdm::EphemerisTable::error ( ) [private]

void asdm::EphemerisTable::fromIDL ( asdmIDL::EphemerisTableIDL x )

Populate this table from the content of a EphemerisTableIDL 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::EphemerisTable::fromXML ( std::string & xmlDoc ) [private]

Populate this table from the content of a XML document that is required to be conform to the XML schema defined for a Ephemeris (EphemerisTable.xsd).

Exceptions:

ConversionException

const std::vector<EphemerisRow *>& asdm::EphemerisTable::get ( ) const

Get a const reference on the collection of rows pointers internally hold by the table.

Returns:: A const reference of a vector of pointers of EphemerisRow. The elements of this vector are stored in the order in which they have been added to the EphemerisTable.

std::vector<EphemerisRow *> asdm::EphemerisTable::get ( )

====> Methods returning rows.

Get a collection of pointers on the rows of the table.

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

static const std::vector<std::string>& asdm::EphemerisTable::getAttributesNames ( ) [static]

Return the names of the attributes of this table.

Returns:: a vector of string

std::vector<EphemerisRow*>* asdm::EphemerisTable::getByContext ( int ephemerisId )

Returns all the rows sorted by ascending startTime for a given context.

The context is defined by a value of ( ephemerisId ).

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

Exceptions:

IllegalAccessException

when a call is done to this method when it's called while the dataset has been imported with the option checkRowUniqueness set to false.

void asdm::EphemerisTable::getByKeyNoAutoIncNoTime	(	std::vector< EphemerisRow * > &	vin,
		std::vector< EphemerisRow * > &	vout,
		int	ephemerisId
	)			`[private]`

Fills the vector vout (passed by reference) with pointers on elements of vin whose attributes are equal to the corresponding parameters of the method.

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

Return the container to which this table belongs.

Returns:: the ASDM containing this table.

Referenced by checkPresenceInMemory().

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

Return this table's Entity.

Implements asdm::Representable.

static const std::vector<std::string>& asdm::EphemerisTable::getKeyName ( ) [static]

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

Returns:: a vector of string.

std::string asdm::EphemerisTable::getName ( ) const [virtual]

Return the name of this table.

This is a instance method of the class.

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

Implements asdm::Representable.

EphemerisRow* asdm::EphemerisTable::getRowByKey	(	ArrayTimeInterval	timeInterval,
		int	ephemerisId
	)

Returns a EphemerisRow* 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
	ephemerisId

BinaryAttributeReaderFunctor* asdm::EphemerisTable::getUnknownAttributeBinaryReader ( const std::string & attributeName ) const

std::string asdm::EphemerisTable::getVersion ( ) const

Return the version information about this table.

EphemerisRow* asdm::EphemerisTable::insertByStartTime	(	EphemerisRow *	x,
		std::vector< EphemerisRow * > &	row
	)			`[private]`

Insert a EphemerisRow* in a vector of EphemerisRow* so that it's ordered by ascending time.

Parameters:

	EphemerisRow*	x . The pointer to be inserted.
	vector	<EphemerisRow*>& row . A reference to the vector where to insert x.

std::string asdm::EphemerisTable::Key ( int ephemerisId ) [private]

Returns a string built by concatenating the ascii representation of the parameters values suffixed with a "_" character.

EphemerisRow* asdm::EphemerisTable::lookup	(	ArrayTimeInterval	timeInterval,
		int	ephemerisId,
		vector< double >	observerLocation,
		double	equinoxEquator,
		int	numPolyDir,
		vector< vector< double > >	dir,
		int	numPolyDist,
		vector< double >	distance,
		ArrayTime	timeOrigin,
		string	origin
	)

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
	ephemerisId
	observerLocation
	equinoxEquator
	numPolyDir
	dir
	numPolyDist
	distance
	timeOrigin
	origin

std::string asdm::EphemerisTable::MIMEXMLPart ( const asdm::ByteOrder * byteOrder = asdm::ByteOrder::Machine_Endianity ) [private]

Private methods involved during the export of this table into disk file(s).

static std::string asdm::EphemerisTable::name ( ) [static]

Return the name of this table.

This is a static method of the class.

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

EphemerisRow* asdm::EphemerisTable::newRow ( EphemerisRow * row )

Create a new row using a copy constructor mechanism.

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

Parameters:

row

the row which is to be copied.

EphemerisRow* asdm::EphemerisTable::newRow	(	ArrayTimeInterval	timeInterval,
		int	ephemerisId,
		vector< double >	observerLocation,
		double	equinoxEquator,
		int	numPolyDir,
		vector< vector< double > >	dir,
		int	numPolyDist,
		vector< double >	distance,
		ArrayTime	timeOrigin,
		string	origin
	)

Create a new row initialized to the specified values.

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

Parameters:

	timeInterval
	ephemerisId
	observerLocation
	equinoxEquator
	numPolyDir
	dir
	numPolyDist
	distance
	timeOrigin
	origin

EphemerisRow* asdm::EphemerisTable::newRow ( )

====> Row creation.

Create a new row with default values.

Returns:: a pointer on a EphemerisRow

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

Set this table's Entity.

Parameters:

e

An entity.

Implements asdm::Representable.

void asdm::EphemerisTable::setFromFile ( const std::string & directory ) [private]

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

Referenced by checkPresenceInMemory().

void asdm::EphemerisTable::setFromMIME ( const std::string & mimeMsg ) [private]

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::EphemerisTable::setFromMIMEFile ( const std::string & directory ) [private]

Private methods involved during the build of this table out of the content of file(s) containing an external representation of a Ephemeris table.

void asdm::EphemerisTable::setFromXMLFile ( const std::string & directory ) [private]

void asdm::EphemerisTable::setUnknownAttributeBinaryReader	(	const std::string &	attributeName,
		BinaryAttributeReaderFunctor *	barFctr
	)

unsigned int asdm::EphemerisTable::size ( ) const [virtual]

Return the number of rows in the table.

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

Implements asdm::Representable.

void asdm::EphemerisTable::toFile ( std::string directory ) [private]

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 "Ephemeris.bin" or an XML representation (fileAsBin==false) will be saved in a file "Ephemeris.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::EphemerisTable::toIDL ( asdmIDL::EphemerisTableIDL & x ) const

Fills the CORBA data structure passed in parameter with the content of this table.

Parameters:

x

a reference to the asdmIDL::EphemerisTableIDL to be populated with the content of this.

asdmIDL::EphemerisTableIDL* asdm::EphemerisTable::toIDL ( )

Conversion Methods.

Convert this table into a EphemerisTableIDL CORBA structure.