NRAOCASA: asdm::AnnotationRow Class Reference

Definition at line 150 of file AnnotationRow.h.


Public Member Functions
virtual	~AnnotationRow ()
AnnotationTable &	getTable () const
	Return the table to which this row belongs.
AnnotationRowIDL *	toIDL () const
	Return this row in the form of an IDL struct.
void	setFromIDL (AnnotationRowIDL x) throw (ConversionException)
	Fill the values of this row from the IDL struct AnnotationRowIDL.
string	toXML () const
	Return this row in the form of an XML string.
void	setFromXML (string rowDoc) throw (ConversionException)
	Fill the values of this row from an XML string that was produced by the toXML() method.
void	setTime (ArrayTime time) throw (IllegalAccessException)
	Set time with the specified ArrayTime.
string	getIssue () const
	Get issue.
void	setIssue (string issue) throw (IllegalAccessException)
	Set issue with the specified string.
string	getDetails () const
	Get details.
void	setDetails (string details) throw (IllegalAccessException)
	Set details with the specified string.
bool	isIntervalExists () const
	The attribute interval is optional.
Interval	getInterval () const throw (IllegalAccessException)
	Get interval, which is optional.
void	setInterval (Interval interval)
	Set interval with the specified Interval.
void	clearInterval ()
	Mark interval, which is an optional field, as non-existent.
bool	isNumAntennaExists () const
	The attribute numAntenna is optional.
int	getNumAntenna () const throw (IllegalAccessException)
	Get numAntenna, which is optional.
void	setNumAntenna (int numAntenna)
	Set numAntenna with the specified int.
void	clearNumAntenna ()
	Mark numAntenna, which is an optional field, as non-existent.
bool	isNumBasebandExists () const
	The attribute numBaseband is optional.
int	getNumBaseband () const throw (IllegalAccessException)
	Get numBaseband, which is optional.
void	setNumBaseband (int numBaseband)
	Set numBaseband with the specified int.
void	clearNumBaseband ()
	Mark numBaseband, which is an optional field, as non-existent.
bool	isBasebandNameExists () const
	The attribute basebandName is optional.
vector< BasebandNameMod::BasebandName >	getBasebandName () const throw (IllegalAccessException)
	Get basebandName, which is optional.
void	setBasebandName (vector< BasebandNameMod::BasebandName > basebandName)
	Set basebandName with the specified vector<BasebandNameMod::BasebandName >.
void	clearBasebandName ()
	Mark basebandName, which is an optional field, as non-existent.
bool	isDValueExists () const
	The attribute dValue is optional.
double	getDValue () const throw (IllegalAccessException)
	Get dValue, which is optional.
void	setDValue (double dValue)
	Set dValue with the specified double.
void	clearDValue ()
	Mark dValue, which is an optional field, as non-existent.
bool	isVdValueExists () const
	The attribute vdValue is optional.
vector< double >	getVdValue () const throw (IllegalAccessException)
	Get vdValue, which is optional.
void	setVdValue (vector< double > vdValue)
	Set vdValue with the specified vector<double >.
void	clearVdValue ()
	Mark vdValue, which is an optional field, as non-existent.
bool	isVvdValuesExists () const
	The attribute vvdValues is optional.
vector< vector< double > >	getVvdValues () const throw (IllegalAccessException)
	Get vvdValues, which is optional.
void	setVvdValues (vector< vector< double > > vvdValues)
	Set vvdValues with the specified vector<vector<double > >.
void	clearVvdValues ()
	Mark vvdValues, which is an optional field, as non-existent.
bool	isLlValueExists () const
	The attribute llValue is optional.
long long	getLlValue () const throw (IllegalAccessException)
	Get llValue, which is optional.
void	setLlValue (long long llValue)
	Set llValue with the specified long long.
void	clearLlValue ()
	Mark llValue, which is an optional field, as non-existent.
bool	isVllValueExists () const
	The attribute vllValue is optional.
vector< long long >	getVllValue () const throw (IllegalAccessException)
	Get vllValue, which is optional.
void	setVllValue (vector< long long > vllValue)
	Set vllValue with the specified vector<long long >.
void	clearVllValue ()
	Mark vllValue, which is an optional field, as non-existent.
bool	isVvllValueExists () const
	The attribute vvllValue is optional.
vector< vector< long long > >	getVvllValue () const throw (IllegalAccessException)
	Get vvllValue, which is optional.
void	setVvllValue (vector< vector< long long > > vvllValue)
	Set vvllValue with the specified vector<vector<long long > >.
void	clearVvllValue ()
	Mark vvllValue, which is an optional field, as non-existent.
Tag	getAnnotationId () const
	Get annotationId.
vector< Tag >	getAntennaId () const throw (IllegalAccessException)
	Get antennaId, which is optional.
void	setAntennaId (vector< Tag > antennaId)
	Set antennaId with the specified vector<Tag> .
void	clearAntennaId ()
	Mark antennaId, which is an optional field, as non-existent.
Links *void	setAntennaId (int i, Tag antennaId) throw (IllegalAccessException, OutOfBoundsException)
	Set antennaId[i] with the specified Tag.
void	addAntennaId (Tag id)
	Append a Tag to antennaId.
void	addAntennaId (const vector< Tag > &id)
	Append a vector of Tag to antennaId.
const Tag	getAntennaId (int i)
	Returns the Tag stored in antennaId at position i.
AntennaRow *	getAntenna (int i)
	Returns the AntennaRow linked to this row via the tag stored in antennaId at position i.
vector< AntennaRow * >	getAntennas ()
	Returns the vector of AntennaRow* linked to this row via the Tags stored in antennaId.
bool	compareNoAutoInc (ArrayTime time, string issue, string details)
	Compare each mandatory attribute except the autoincrementable one of this AnnotationRow with the corresponding parameters and return true if there is a match and false otherwise.
bool	compareRequiredValue (ArrayTime time, string issue, string details)
bool	equalByRequiredValue (AnnotationRow *x)
	Return true if all required attributes of the value part are equal to their homologues in x and false otherwise.
Public Attributes
Intrinsic Table	Attributes
Extrinsic Table	Attributes
Private Member Functions
void	isAdded ()
	This method is used by the Table class when this row is added to the table.
	AnnotationRow (AnnotationTable &table)
	Create a AnnotationRow.
	AnnotationRow (AnnotationTable &table, AnnotationRow &row)
	Create a AnnotationRow using a copy constructor mechanism.
void	setAnnotationId (Tag annotationId) throw (IllegalAccessException)
	Set annotationId with the specified Tag value.
Private Attributes
AnnotationTable &	table
	The table to which this row belongs.
bool	hasBeenAdded
	Whether this row has been added to the table or not.
string	issue
	===> Attribute issue
string	details
	===> Attribute details
bool	intervalExists
	===> Attribute interval, which is optional
Interval	interval
bool	numAntennaExists
	===> Attribute numAntenna, which is optional
int	numAntenna
bool	numBasebandExists
	===> Attribute numBaseband, which is optional
int	numBaseband
bool	basebandNameExists
	===> Attribute basebandName, which is optional
vector< BasebandNameMod::BasebandName >	basebandName
bool	dValueExists
	===> Attribute dValue, which is optional
double	dValue
bool	vdValueExists
	===> Attribute vdValue, which is optional
vector< double >	vdValue
bool	vvdValuesExists
	===> Attribute vvdValues, which is optional
vector< vector< double > >	vvdValues
bool	llValueExists
	===> Attribute llValue, which is optional
long long	llValue
bool	vllValueExists
	===> Attribute vllValue, which is optional
vector< long long >	vllValue
bool	vvllValueExists
	===> Attribute vvllValue, which is optional
vector< vector< long long > >	vvllValue
Tag	annotationId
	===> Attribute annotationId
vector< Tag >	antennaId
Friends
class	asdm::AnnotationTable

Constructor & Destructor Documentation

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

asdm::AnnotationRow::AnnotationRow ( AnnotationTable & table ) [private]

Create a AnnotationRow.

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::AnnotationRow::AnnotationRow	(	AnnotationTable &	table,
		AnnotationRow &	row
	)			`[private]`

Create a AnnotationRow using a copy constructor mechanism.

Given a AnnotationRow row and a AnnotationTable table, the method creates a new AnnotationRow 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

AnnotationTable& asdm::AnnotationRow::getTable ( ) const

Return the table to which this row belongs.

AnnotationRowIDL* asdm::AnnotationRow::toIDL ( ) const

Return this row in the form of an IDL struct.

Returns:: The values of this row as a AnnotationRowIDL struct.

void asdm::AnnotationRow::setFromIDL ( AnnotationRowIDL x ) throw (ConversionException)

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

Parameters:

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

string asdm::AnnotationRow::toXML ( ) const

Return this row in the form of an XML string.

Returns:: The values of this row as an XML string.

void asdm::AnnotationRow::setFromXML ( string rowDoc ) throw (ConversionException)

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

Parameters:

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

void asdm::AnnotationRow::setTime ( ArrayTime time ) throw (IllegalAccessException)

Set time with the specified ArrayTime.

Parameters:

time

The ArrayTime value to which time is to be set.

Exceptions:

IllegalAccessException

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

string asdm::AnnotationRow::getIssue ( ) const

Get issue.

Returns:: issue as string

void asdm::AnnotationRow::setIssue ( string issue ) throw (IllegalAccessException)

Set issue with the specified string.

Parameters:

issue

The string value to which issue is to be set.

Exceptions:

IllegalAccessException

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

string asdm::AnnotationRow::getDetails ( ) const

Get details.

Returns:: details as string

void asdm::AnnotationRow::setDetails ( string details ) throw (IllegalAccessException)

Set details with the specified string.

Parameters:

details

The string value to which details is to be set.

Exceptions:

IllegalAccessException

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

bool asdm::AnnotationRow::isIntervalExists ( ) const

The attribute interval is optional.

Return true if this attribute exists.

Returns:: true if and only if the interval attribute exists.

Interval asdm::AnnotationRow::getInterval ( ) const throw (IllegalAccessException)

Get interval, which is optional.

Returns:: interval as Interval

Exceptions:

IllegalAccessException

If interval does not exist.

void asdm::AnnotationRow::setInterval ( Interval interval )

Set interval with the specified Interval.

Parameters:

interval

The Interval value to which interval is to be set.

void asdm::AnnotationRow::clearInterval ( )

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

bool asdm::AnnotationRow::isNumAntennaExists ( ) const

The attribute numAntenna is optional.

Return true if this attribute exists.

Returns:: true if and only if the numAntenna attribute exists.

int asdm::AnnotationRow::getNumAntenna ( ) const throw (IllegalAccessException)

Get numAntenna, which is optional.

Returns:: numAntenna as int

Exceptions:

IllegalAccessException

If numAntenna does not exist.

void asdm::AnnotationRow::setNumAntenna ( int numAntenna )

Set numAntenna with the specified int.

Parameters:

numAntenna

The int value to which numAntenna is to be set.

void asdm::AnnotationRow::clearNumAntenna ( )

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

bool asdm::AnnotationRow::isNumBasebandExists ( ) const

The attribute numBaseband is optional.

Return true if this attribute exists.

Returns:: true if and only if the numBaseband attribute exists.

int asdm::AnnotationRow::getNumBaseband ( ) const throw (IllegalAccessException)

Get numBaseband, which is optional.

Returns:: numBaseband as int

Exceptions:

IllegalAccessException

If numBaseband does not exist.

void asdm::AnnotationRow::setNumBaseband ( int numBaseband )

Set numBaseband with the specified int.

Parameters:

numBaseband

The int value to which numBaseband is to be set.

void asdm::AnnotationRow::clearNumBaseband ( )

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

bool asdm::AnnotationRow::isBasebandNameExists ( ) const

The attribute basebandName is optional.

Return true if this attribute exists.

Returns:: true if and only if the basebandName attribute exists.

vector<BasebandNameMod::BasebandName > asdm::AnnotationRow::getBasebandName ( ) const throw (IllegalAccessException)

Get basebandName, which is optional.

Returns:: basebandName as vector<BasebandNameMod::BasebandName >

Exceptions:

IllegalAccessException

If basebandName does not exist.

void asdm::AnnotationRow::setBasebandName ( vector< BasebandNameMod::BasebandName > basebandName )

Set basebandName with the specified vector<BasebandNameMod::BasebandName >.

Parameters:

basebandName

The vector<BasebandNameMod::BasebandName > value to which basebandName is to be set.

void asdm::AnnotationRow::clearBasebandName ( )

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

bool asdm::AnnotationRow::isDValueExists ( ) const

The attribute dValue is optional.

Return true if this attribute exists.

Returns:: true if and only if the dValue attribute exists.

double asdm::AnnotationRow::getDValue ( ) const throw (IllegalAccessException)

Get dValue, which is optional.

Returns:: dValue as double

Exceptions:

IllegalAccessException

If dValue does not exist.

void asdm::AnnotationRow::setDValue ( double dValue )

Set dValue with the specified double.

Parameters:

dValue

The double value to which dValue is to be set.

void asdm::AnnotationRow::clearDValue ( )

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

bool asdm::AnnotationRow::isVdValueExists ( ) const

The attribute vdValue is optional.

Return true if this attribute exists.

Returns:: true if and only if the vdValue attribute exists.

vector<double > asdm::AnnotationRow::getVdValue ( ) const throw (IllegalAccessException)

Get vdValue, which is optional.

Returns:: vdValue as vector<double >

Exceptions:

IllegalAccessException

If vdValue does not exist.

void asdm::AnnotationRow::setVdValue ( vector< double > vdValue )

Set vdValue with the specified vector<double >.

Parameters:

vdValue

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

void asdm::AnnotationRow::clearVdValue ( )

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

bool asdm::AnnotationRow::isVvdValuesExists ( ) const

The attribute vvdValues is optional.

Return true if this attribute exists.

Returns:: true if and only if the vvdValues attribute exists.

vector<vector<double > > asdm::AnnotationRow::getVvdValues ( ) const throw (IllegalAccessException)

Get vvdValues, which is optional.

Returns:: vvdValues as vector<vector<double > >

Exceptions:

IllegalAccessException

If vvdValues does not exist.

void asdm::AnnotationRow::setVvdValues ( vector< vector< double > > vvdValues )

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

Parameters:

vvdValues

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

void asdm::AnnotationRow::clearVvdValues ( )

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

bool asdm::AnnotationRow::isLlValueExists ( ) const

The attribute llValue is optional.

Return true if this attribute exists.

Returns:: true if and only if the llValue attribute exists.

long long asdm::AnnotationRow::getLlValue ( ) const throw (IllegalAccessException)

Get llValue, which is optional.

Returns:: llValue as long long

Exceptions:

IllegalAccessException

If llValue does not exist.

void asdm::AnnotationRow::setLlValue ( long long llValue )

Set llValue with the specified long long.

Parameters:

llValue

The long long value to which llValue is to be set.

void asdm::AnnotationRow::clearLlValue ( )

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

bool asdm::AnnotationRow::isVllValueExists ( ) const

The attribute vllValue is optional.

Return true if this attribute exists.

Returns:: true if and only if the vllValue attribute exists.

vector<long long > asdm::AnnotationRow::getVllValue ( ) const throw (IllegalAccessException)

Get vllValue, which is optional.

Returns:: vllValue as vector<long long >

Exceptions:

IllegalAccessException

If vllValue does not exist.

void asdm::AnnotationRow::setVllValue ( vector< long long > vllValue )

Set vllValue with the specified vector<long long >.

Parameters:

vllValue

The vector<long long > value to which vllValue is to be set.

void asdm::AnnotationRow::clearVllValue ( )

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

bool asdm::AnnotationRow::isVvllValueExists ( ) const

The attribute vvllValue is optional.

Return true if this attribute exists.

Returns:: true if and only if the vvllValue attribute exists.

vector<vector<long long > > asdm::AnnotationRow::getVvllValue ( ) const throw (IllegalAccessException)

Get vvllValue, which is optional.

Returns:: vvllValue as vector<vector<long long > >

Exceptions:

IllegalAccessException

If vvllValue does not exist.

void asdm::AnnotationRow::setVvllValue ( vector< vector< long long > > vvllValue )

Set vvllValue with the specified vector<vector<long long > >.

Parameters:

vvllValue

The vector<vector<long long > > value to which vvllValue is to be set.

void asdm::AnnotationRow::clearVvllValue ( )

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

Tag asdm::AnnotationRow::getAnnotationId ( ) const

Get annotationId.

Returns:: annotationId as Tag

vector<Tag> asdm::AnnotationRow::getAntennaId ( ) const throw (IllegalAccessException)

Get antennaId, which is optional.

Returns:: antennaId as vector<Tag>

Exceptions:

IllegalAccessException

If antennaId does not exist.

void asdm::AnnotationRow::setAntennaId ( vector< Tag > antennaId )

Set antennaId with the specified vector<Tag> .

Parameters:

antennaId

The vector<Tag> value to which antennaId is to be set.

void asdm::AnnotationRow::clearAntennaId ( )

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

Links* void asdm::AnnotationRow::setAntennaId	(	int	i,
		Tag	antennaId
	)			throw (IllegalAccessException, OutOfBoundsException)

Set antennaId[i] with the specified Tag.

Parameters:

	i	The index in antennaId where to set the Tag value.
	antennaId	The Tag value to which antennaId[i] is to be set.

Exceptions:

	IllegalException
	IndexOutOfBoundsException

void asdm::AnnotationRow::addAntennaId ( Tag id )

Append a Tag to antennaId.

Parameters:

the Tag to be appended to antennaId

void asdm::AnnotationRow::addAntennaId ( const vector< Tag > & id )

Append a vector of Tag to antennaId.

Parameters:

an array of Tag to be appended to antennaId

const Tag asdm::AnnotationRow::getAntennaId ( int i )

Returns the Tag stored in antennaId at position i.

Parameters:

the position in antennaId where the Tag is retrieved.

Returns:: the Tag stored at position i in antennaId.

AntennaRow* asdm::AnnotationRow::getAntenna ( int i )

Returns the AntennaRow linked to this row via the tag stored in antennaId at position i.

Parameters:

the position in antennaId.

Returns:: a pointer on a AntennaRow whose key (a Tag) is equal to the Tag stored at position i in the antennaId.

vector<AntennaRow *> asdm::AnnotationRow::getAntennas ( )

Returns the vector of AntennaRow* linked to this row via the Tags stored in antennaId.

Returns:: an array of pointers on AntennaRow.

bool asdm::AnnotationRow::compareNoAutoInc	(	ArrayTime	time,
		string	issue,
		string	details
	)

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