asdm::EphemerisRow Class Reference

The EphemerisRow class is a row of a EphemerisTable. More...

#include <EphemerisRow.h>

List of all members.

Public Member Functions
virtual	~EphemerisRow ()
	friend class asdm::TableStreamReader<EphemerisTable, EphemerisRow>;
EphemerisTable &	getTable () const
	Return the table to which this row belongs.
bool	isAdded () const
	Has this row been added to its table ?
void	setTimeInterval (ArrayTimeInterval timeInterval)
	Set timeInterval with the specified ArrayTimeInterval.
int	getEphemerisId () const
	===> Attribute ephemerisId
void	setEphemerisId (int ephemerisId)
	Set ephemerisId with the specified int.
vector< double >	getObserverLocation () const
	===> Attribute observerLocation
void	setObserverLocation (vector< double > observerLocation)
	Set observerLocation with the specified vector<double >.
double	getEquinoxEquator () const
	===> Attribute equinoxEquator
void	setEquinoxEquator (double equinoxEquator)
	Set equinoxEquator with the specified double.
int	getNumPolyDir () const
	===> Attribute numPolyDir
void	setNumPolyDir (int numPolyDir)
	Set numPolyDir with the specified int.
vector< vector< double > >	getDir () const
	===> Attribute dir
void	setDir (vector< vector< double > > dir)
	Set dir with the specified vector<vector<double > >.
int	getNumPolyDist () const
	===> Attribute numPolyDist
void	setNumPolyDist (int numPolyDist)
	Set numPolyDist with the specified int.
vector< double >	getDistance () const
	===> Attribute distance
void	setDistance (vector< double > distance)
	Set distance with the specified vector<double >.
ArrayTime	getTimeOrigin () const
	===> Attribute timeOrigin
void	setTimeOrigin (ArrayTime timeOrigin)
	Set timeOrigin with the specified ArrayTime.
string	getOrigin () const
	===> Attribute origin
void	setOrigin (string origin)
	Set origin with the specified string.
bool	isNumPolyRadVelExists () const
	===> Attribute numPolyRadVel, which is optional
int	getNumPolyRadVel () const
	Get numPolyRadVel, which is optional.
void	setNumPolyRadVel (int numPolyRadVel)
	Set numPolyRadVel with the specified int.
void	clearNumPolyRadVel ()
	Mark numPolyRadVel, which is an optional field, as non-existent.
bool	isRadVelExists () const
	===> Attribute radVel, which is optional
vector< double >	getRadVel () const
	Get radVel, which is optional.
void	setRadVel (vector< double > radVel)
	Set radVel with the specified vector<double >.
void	clearRadVel ()
	Mark radVel, which is an optional field, as non-existent.
Extrinsic Table Attributes Links *bool	compareNoAutoInc (ArrayTimeInterval timeInterval, int ephemerisId, vector< double > observerLocation, double equinoxEquator, int numPolyDir, vector< vector< double > > dir, int numPolyDist, vector< double > distance, ArrayTime timeOrigin, string origin)
	Compare each mandatory attribute except the autoincrementable one of this EphemerisRow with the corresponding parameters and return true if there is a match and false otherwise.
bool	compareRequiredValue (vector< double > observerLocation, double equinoxEquator, int numPolyDir, vector< vector< double > > dir, int numPolyDist, vector< double > distance, ArrayTime timeOrigin, string origin)
	Compare each mandatory value (i.e.
bool	equalByRequiredValue (EphemerisRow *x)
	Return true if all required attributes of the value part are equal to their homologues in x and false otherwise.
asdmIDL::EphemerisRowIDL *	toIDL () const
	Return this row in the form of an IDL struct.
void	toIDL (asdmIDL::EphemerisRowIDL &x) const
	Define the content of a EphemerisRowIDL struct from the values found in this row.
void	setFromIDL (asdmIDL::EphemerisRowIDL x)
	Fill the values of this row from the IDL struct EphemerisRowIDL.
std::string	toXML () const
	Return this row in the form of an XML string.
void	setFromXML (std::string rowDoc)
	Fill the values of this row from an XML string that was produced by the toXML() method.
Public Attributes
Intrinsic Table	Attributes
Private Member Functions
void	isAdded (bool added)
	This method is used by the Table class when this row is added to the table.
	EphemerisRow (EphemerisTable &table)
	Create a EphemerisRow.
	EphemerisRow (EphemerisTable &table, EphemerisRow &row)
	Create a EphemerisRow using a copy constructor mechanism.
void	timeIntervalFromBin (EndianIStream &eis)
void	ephemerisIdFromBin (EndianIStream &eis)
void	observerLocationFromBin (EndianIStream &eis)
void	equinoxEquatorFromBin (EndianIStream &eis)
void	numPolyDirFromBin (EndianIStream &eis)
void	dirFromBin (EndianIStream &eis)
void	numPolyDistFromBin (EndianIStream &eis)
void	distanceFromBin (EndianIStream &eis)
void	timeOriginFromBin (EndianIStream &eis)
void	originFromBin (EndianIStream &eis)
void	numPolyRadVelFromBin (EndianIStream &eis)
void	radVelFromBin (EndianIStream &eis)
void	timeIntervalFromText (const string &s)
void	ephemerisIdFromText (const string &s)
void	observerLocationFromText (const string &s)
void	equinoxEquatorFromText (const string &s)
void	numPolyDirFromText (const string &s)
void	dirFromText (const string &s)
void	numPolyDistFromText (const string &s)
void	distanceFromText (const string &s)
void	timeOriginFromText (const string &s)
void	originFromText (const string &s)
void	numPolyRadVelFromText (const string &s)
void	radVelFromText (const string &s)
void	toBin (EndianOSStream &eoss)
	Serialize this into a stream of bytes written to an EndianOSStream.
Private Attributes
EphemerisTable &	table
	The table to which this row belongs.
bool	hasBeenAdded
	Whether this row has been added to the table or not.
int	ephemerisId
	===> Attribute ephemerisId
vector< double >	observerLocation
	===> Attribute observerLocation
double	equinoxEquator
	===> Attribute equinoxEquator
int	numPolyDir
	===> Attribute numPolyDir
vector< vector< double > >	dir
	===> Attribute dir
int	numPolyDist
	===> Attribute numPolyDist
vector< double >	distance
	===> Attribute distance
ArrayTime	timeOrigin
	===> Attribute timeOrigin
string	origin
	===> Attribute origin
bool	numPolyRadVelExists
	===> Attribute numPolyRadVel, which is optional
int	numPolyRadVel
bool	radVelExists
	===> Attribute radVel, which is optional
vector< double >	radVel
Extrinsic Table Attributes Links *binary deserialization material from an EndianIStream std::map< std::string, EphemerisAttributeFromBin >	fromBinMethods
*text deserialization material std::map< std::string, EphemerisAttributeFromText >	fromTextMethods
Friends
class	asdm::EphemerisTable
class	asdm::RowTransformer< EphemerisRow >

---

Detailed Description

The EphemerisRow class is a row of a EphemerisTable.

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

Definition at line 114 of file EphemerisRow.h.

---

Constructor & Destructor Documentation

virtual asdm::EphemerisRow::~EphemerisRow

(

)

[virtual]

friend class asdm::TableStreamReader<EphemerisTable, EphemerisRow>;

asdm::EphemerisRow::EphemerisRow

(

EphemerisTable &

table

)

[private]

Create a EphemerisRow.

This constructor is private because only the table can create rows. All rows know the table to which they belong.

Parameters:

table

The table to which this row belongs.

asdm::EphemerisRow::EphemerisRow	(	EphemerisTable &	table,
		EphemerisRow &	row
	)			[private]

Create a EphemerisRow using a copy constructor mechanism.

Given a EphemerisRow row and a EphemerisTable table, the method creates a new EphemerisRow owned by table. Each attribute of the created row is a copy (deep) of the corresponding attribute of row. The method does not add the created row to its table, its simply parents it to table, 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 row with default values for its attributes.

This constructor is private because only the table can create rows. All rows know the table to which they belong.

Parameters:

	table	The table to which this row belongs.
	row	The row which is to be copied.

---

Member Function Documentation

void asdm::EphemerisRow::clearNumPolyRadVel

(

)

Mark numPolyRadVel, which is an optional field, as non-existent.

void asdm::EphemerisRow::clearRadVel

(

)

Mark radVel, which is an optional field, as non-existent.

Extrinsic Table Attributes Links* bool asdm::EphemerisRow::compareNoAutoInc	(	ArrayTimeInterval	timeInterval,
		int	ephemerisId,
		vector< double >	observerLocation,
		double	equinoxEquator,
		int	numPolyDir,
		vector< vector< double > >	dir,
		int	numPolyDist,
		vector< double >	distance,
		ArrayTime	timeOrigin,
		string	origin
	)

Compare each mandatory attribute except the autoincrementable one of this EphemerisRow with the corresponding parameters and return true if there is a match and false otherwise.

Parameters:

	timeInterval
	ephemerisId
	observerLocation
	equinoxEquator
	numPolyDir
	dir
	numPolyDist
	distance
	timeOrigin
	origin

bool asdm::EphemerisRow::compareRequiredValue	(	vector< double >	observerLocation,
		double	equinoxEquator,
		int	numPolyDir,
		vector< vector< double > >	dir,
		int	numPolyDist,
		vector< double >	distance,
		ArrayTime	timeOrigin,
		string	origin
	)

Compare each mandatory value (i.e.

not in the key) attribute with the corresponding parameters and return true if there is a match and false otherwise.

Parameters:

	observerLocation
	equinoxEquator
	numPolyDir
	dir
	numPolyDist
	distance
	timeOrigin
	origin

void asdm::EphemerisRow::dirFromBin

(

EndianIStream &

eis

)

[private]

void asdm::EphemerisRow::dirFromText

(

const string &

s

)

[private]

void asdm::EphemerisRow::distanceFromBin

(

EndianIStream &

eis

)

[private]

void asdm::EphemerisRow::distanceFromText

(

const string &

s

)

[private]

void asdm::EphemerisRow::ephemerisIdFromBin

(

EndianIStream &

eis

)

[private]

void asdm::EphemerisRow::ephemerisIdFromText

(

const string &

s

)

[private]

bool asdm::EphemerisRow::equalByRequiredValue

(

EphemerisRow *

x

)

Return true if all required attributes of the value part are equal to their homologues in x and false otherwise.

Parameters:

x

a pointer on the EphemerisRow whose required attributes of the value part will be compared with those of this.

Returns:

a boolean.

void asdm::EphemerisRow::equinoxEquatorFromBin

(

EndianIStream &

eis

)

[private]

void asdm::EphemerisRow::equinoxEquatorFromText

(

const string &

s

)

[private]

vector<vector<double > > asdm::EphemerisRow::getDir

(

)

const

===> Attribute dir

Get dir.

Returns:

dir as vector<vector<double > >

vector<double > asdm::EphemerisRow::getDistance

(

)

const

===> Attribute distance

Get distance.

Returns:

distance as vector<double >

int asdm::EphemerisRow::getEphemerisId

(

)

const

===> Attribute ephemerisId

Get ephemerisId.

Returns:

ephemerisId as int

double asdm::EphemerisRow::getEquinoxEquator

(

)

const

===> Attribute equinoxEquator

Get equinoxEquator.

Returns:

equinoxEquator as double

int asdm::EphemerisRow::getNumPolyDir

(

)

const

===> Attribute numPolyDir

Get numPolyDir.

Returns:

numPolyDir as int

int asdm::EphemerisRow::getNumPolyDist

(

)

const

===> Attribute numPolyDist

Get numPolyDist.

Returns:

numPolyDist as int

int asdm::EphemerisRow::getNumPolyRadVel

(

)

const

Get numPolyRadVel, which is optional.

Returns:

numPolyRadVel as int

Exceptions:

IllegalAccessException

If numPolyRadVel does not exist.

vector<double > asdm::EphemerisRow::getObserverLocation

(

)

const

===> Attribute observerLocation

Get observerLocation.

Returns:

observerLocation as vector<double >

string asdm::EphemerisRow::getOrigin

(

)

const

===> Attribute origin

Get origin.

Returns:

origin as string

vector<double > asdm::EphemerisRow::getRadVel

(

)

const

Get radVel, which is optional.

Returns:

radVel as vector<double >

Exceptions:

IllegalAccessException

If radVel does not exist.

EphemerisTable& asdm::EphemerisRow::getTable

(

)

const

Return the table to which this row belongs.

ArrayTime asdm::EphemerisRow::getTimeOrigin

(

)

const

===> Attribute timeOrigin

Get timeOrigin.

Returns:

timeOrigin as ArrayTime

void asdm::EphemerisRow::isAdded

(

bool

added

)

[private]

This method is used by the Table class when this row is added to the table.

bool asdm::EphemerisRow::isAdded

(

)

const

Has this row been added to its table ?

Returns:

true if and only if it has been added.

bool asdm::EphemerisRow::isNumPolyRadVelExists

(

)

const

===> Attribute numPolyRadVel, which is optional

The attribute numPolyRadVel is optional. Return true if this attribute exists.

Returns:

true if and only if the numPolyRadVel attribute exists.

bool asdm::EphemerisRow::isRadVelExists

(

)

const

===> Attribute radVel, which is optional

The attribute radVel is optional. Return true if this attribute exists.

Returns:

true if and only if the radVel attribute exists.

void asdm::EphemerisRow::numPolyDirFromBin

(

EndianIStream &

eis

)

[private]

void asdm::EphemerisRow::numPolyDirFromText

(

const string &

s

)

[private]

void asdm::EphemerisRow::numPolyDistFromBin

(

EndianIStream &

eis

)

[private]

void asdm::EphemerisRow::numPolyDistFromText

(

const string &

s

)

[private]

void asdm::EphemerisRow::numPolyRadVelFromBin

(

EndianIStream &

eis

)

[private]

void asdm::EphemerisRow::numPolyRadVelFromText

(

const string &

s

)

[private]

void asdm::EphemerisRow::observerLocationFromBin

(

EndianIStream &

eis

)

[private]

void asdm::EphemerisRow::observerLocationFromText

(

const string &

s

)

[private]

void asdm::EphemerisRow::originFromBin

(

EndianIStream &

eis

)

[private]

void asdm::EphemerisRow::originFromText

(

const string &

s

)

[private]

void asdm::EphemerisRow::radVelFromBin

(

EndianIStream &

eis

)

[private]

void asdm::EphemerisRow::radVelFromText

(

const string &

s

)

[private]

void asdm::EphemerisRow::setDir

(

vector< vector< double > >

dir

)

Set dir with the specified vector<vector<double > >.

Parameters:

dir

The vector<vector<double > > value to which dir is to be set.

void asdm::EphemerisRow::setDistance

(

vector< double >

distance

)

Set distance with the specified vector<double >.

Parameters:

distance

The vector<double > value to which distance is to be set.

void asdm::EphemerisRow::setEphemerisId

(

int

ephemerisId

)

Set ephemerisId with the specified int.

Parameters:

ephemerisId

The int value to which ephemerisId is to be set.

Exceptions:

IllegalAccessException

If an attempt is made to change this field after is has been added to the table.

void asdm::EphemerisRow::setEquinoxEquator

(

double

equinoxEquator

)

Set equinoxEquator with the specified double.

Parameters:

equinoxEquator

The double value to which equinoxEquator is to be set.

void asdm::EphemerisRow::setFromIDL

(

asdmIDL::EphemerisRowIDL

x

)

Fill the values of this row from the IDL struct EphemerisRowIDL.

Parameters:

x

The IDL struct containing the values used to fill this row.

Exceptions:

ConversionException

void asdm::EphemerisRow::setFromXML

(

std::string

rowDoc

)

Fill the values of this row from an XML string that was produced by the toXML() method.

Parameters:

rowDoc

the XML string being used to set the values of this row.

Exceptions:

ConversionException

void asdm::EphemerisRow::setNumPolyDir

(

int

numPolyDir

)

Set numPolyDir with the specified int.

Parameters:

numPolyDir

The int value to which numPolyDir is to be set.

void asdm::EphemerisRow::setNumPolyDist

(

int

numPolyDist

)

Set numPolyDist with the specified int.

Parameters:

numPolyDist

The int value to which numPolyDist is to be set.

void asdm::EphemerisRow::setNumPolyRadVel

(

int

numPolyRadVel

)

Set numPolyRadVel with the specified int.

Parameters:

numPolyRadVel

The int value to which numPolyRadVel is to be set.

void asdm::EphemerisRow::setObserverLocation

(

vector< double >

observerLocation

)

Set observerLocation with the specified vector<double >.

Parameters:

observerLocation

The vector<double > value to which observerLocation is to be set.

void asdm::EphemerisRow::setOrigin

(

string

origin

)

Set origin with the specified string.

Parameters:

origin

The string value to which origin is to be set.

void asdm::EphemerisRow::setRadVel

(

vector< double >

radVel

)

Set radVel with the specified vector<double >.

Parameters:

radVel

The vector<double > value to which radVel is to be set.

void asdm::EphemerisRow::setTimeInterval

(

ArrayTimeInterval

timeInterval

)

Set timeInterval with the specified ArrayTimeInterval.

Parameters:

timeInterval

The ArrayTimeInterval value to which timeInterval is to be set.

Exceptions:

IllegalAccessException

If an attempt is made to change this field after is has been added to the table.

void asdm::EphemerisRow::setTimeOrigin

(

ArrayTime

timeOrigin

)

Set timeOrigin with the specified ArrayTime.

Parameters:

timeOrigin

The ArrayTime value to which timeOrigin is to be set.

void asdm::EphemerisRow::timeIntervalFromBin

(

EndianIStream &

eis

)

[private]

void asdm::EphemerisRow::timeIntervalFromText

(

const string &

s

)

[private]

void asdm::EphemerisRow::timeOriginFromBin

(

EndianIStream &

eis

)

[private]

void asdm::EphemerisRow::timeOriginFromText

(

const string &

s

)

[private]

void asdm::EphemerisRow::toBin

(

EndianOSStream &

eoss

)

[private]

Serialize this into a stream of bytes written to an EndianOSStream.

Parameters:

eoss

the EndianOSStream to be written to

void asdm::EphemerisRow::toIDL

(

asdmIDL::EphemerisRowIDL &

x

)

const

Define the content of a EphemerisRowIDL struct from the values found in this row.

Parameters:

x

a reference to the EphemerisRowIDL struct to be set.

asdmIDL::EphemerisRowIDL* asdm::EphemerisRow::toIDL

(

)

const

Return this row in the form of an IDL struct.

Returns:

The values of this row as a EphemerisRowIDL struct.

std::string asdm::EphemerisRow::toXML

(

)

const

Return this row in the form of an XML string.

Returns:

The values of this row as an XML string.

---

Friends And Related Function Documentation

friend class asdm::EphemerisTable [friend]

Definition at line 115 of file EphemerisRow.h.

friend class asdm::RowTransformer< EphemerisRow > [friend]

Definition at line 116 of file EphemerisRow.h.

---

Member Data Documentation

Intrinsic Table asdm::EphemerisRow::Attributes

Definition at line 139 of file EphemerisRow.h.

vector<vector<double > > asdm::EphemerisRow::dir [private]

===> Attribute dir

Definition at line 785 of file EphemerisRow.h.

vector<double > asdm::EphemerisRow::distance [private]

===> Attribute distance

Definition at line 807 of file EphemerisRow.h.

int asdm::EphemerisRow::ephemerisId [private]

===> Attribute ephemerisId

Definition at line 741 of file EphemerisRow.h.

double asdm::EphemerisRow::equinoxEquator [private]

===> Attribute equinoxEquator

Definition at line 763 of file EphemerisRow.h.

Extrinsic Table Attributes Links* binary deserialization material from an EndianIStream std::map<std::string, EphemerisAttributeFromBin> asdm::EphemerisRow::fromBinMethods [private]

Definition at line 874 of file EphemerisRow.h.

* text deserialization material std::map<std::string, EphemerisAttributeFromText> asdm::EphemerisRow::fromTextMethods [private]

Definition at line 894 of file EphemerisRow.h.

bool asdm::EphemerisRow::hasBeenAdded [private]

Whether this row has been added to the table or not.

Definition at line 686 of file EphemerisRow.h.

int asdm::EphemerisRow::numPolyDir [private]

===> Attribute numPolyDir

Definition at line 774 of file EphemerisRow.h.

int asdm::EphemerisRow::numPolyDist [private]

===> Attribute numPolyDist

Definition at line 796 of file EphemerisRow.h.

int asdm::EphemerisRow::numPolyRadVel [private]

Definition at line 842 of file EphemerisRow.h.

bool asdm::EphemerisRow::numPolyRadVelExists [private]

===> Attribute numPolyRadVel, which is optional

Definition at line 839 of file EphemerisRow.h.

vector<double > asdm::EphemerisRow::observerLocation [private]

===> Attribute observerLocation

Definition at line 752 of file EphemerisRow.h.

string asdm::EphemerisRow::origin [private]

===> Attribute origin

Definition at line 829 of file EphemerisRow.h.

vector<double > asdm::EphemerisRow::radVel [private]

Definition at line 855 of file EphemerisRow.h.

bool asdm::EphemerisRow::radVelExists [private]

===> Attribute radVel, which is optional

Definition at line 852 of file EphemerisRow.h.

EphemerisTable& asdm::EphemerisRow::table [private]

The table to which this row belongs.

Definition at line 682 of file EphemerisRow.h.

ArrayTime asdm::EphemerisRow::timeOrigin [private]

===> Attribute timeOrigin

Definition at line 818 of file EphemerisRow.h.

---

The documentation for this class was generated from the following file:

• code/alma/ASDM/EphemerisRow.h