asdm::PointingRow Class Reference

#include <PointingRow.h>

List of all members.


Detailed Description

The PointingRow class is a row of a PointingTable.


Public Member Functions

PointingTablegetTable () const
PointingRowIDL * toIDL () const
void setFromIDL (PointingRowIDL x) throw (ConversionException)
string toXML () const
void setFromXML (string rowDoc) throw (ConversionException)
void toBin (EndianOSStream &eoss)
ArrayTimeInterval getTimeInterval () const
void setTimeInterval (ArrayTimeInterval timeInterval) throw (IllegalAccessException)
bool isNameExists () const
string getName () const throw (IllegalAccessException)
void setName (string name)
void clearName ()
int getNumPoly () const
void setNumPoly (int numPoly)
ArrayTime getTimeOrigin () const
void setTimeOrigin (ArrayTime timeOrigin)
vector< vector< Angle > > getPointingDirection () const
void setPointingDirection (vector< vector< Angle > > pointingDirection)
vector< vector< Angle > > getTarget () const
void setTarget (vector< vector< Angle > > target)
vector< vector< Angle > > getOffset () const
void setOffset (vector< vector< Angle > > offset)
bool isSourceOffsetExists () const
vector< vector< Angle > > getSourceOffset () const throw (IllegalAccessException)
void setSourceOffset (vector< vector< Angle > > sourceOffset)
void clearSourceOffset ()
vector< AnglegetEncoder () const
void setEncoder (vector< Angle > encoder)
bool getPointingTracking () const
void setPointingTracking (bool pointingTracking)
bool isPhaseTrackingExists () const
bool getPhaseTracking () const throw (IllegalAccessException)
void setPhaseTracking (bool phaseTracking)
void clearPhaseTracking ()
bool isOverTheTopExists () const
bool getOverTheTop () const throw (IllegalAccessException)
void setOverTheTop (bool overTheTop)
void clearOverTheTop ()
Tag getAntennaId () const
void setAntennaId (Tag antennaId) throw (IllegalAccessException)
int getPointingModelId () const
void setPointingModelId (int pointingModelId)
AntennaRowgetAntennaUsingAntennaId ()
vector< PointingModelRow * > getPointingModels ()
bool compareNoAutoInc (Tag antennaId, ArrayTimeInterval timeInterval, int pointingModelId, int numPoly, ArrayTime timeOrigin, vector< vector< Angle > > pointingDirection, vector< vector< Angle > > target, vector< vector< Angle > > offset, vector< Angle > encoder, bool pointingTracking)
bool compareRequiredValue (int pointingModelId, int numPoly, ArrayTime timeOrigin, vector< vector< Angle > > pointingDirection, vector< vector< Angle > > target, vector< vector< Angle > > offset, vector< Angle > encoder, bool pointingTracking)
bool equalByRequiredValue (PointingRow *x)

Static Public Member Functions

static PointingRowfromBin (EndianISStream &eiss, PointingTable &table)

Friends

class asdm::PointingTable


Member Function Documentation

PointingTable& asdm::PointingRow::getTable (  )  const

Return the table to which this row belongs.

PointingRowIDL* asdm::PointingRow::toIDL (  )  const

Return this row in the form of an IDL struct.

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

void asdm::PointingRow::setFromIDL ( PointingRowIDL  x  )  throw (ConversionException)

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

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

string asdm::PointingRow::toXML (  )  const

Return this row in the form of an XML string.

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

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

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

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

void asdm::PointingRow::toBin ( EndianOSStream &  eoss  ) 

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

Parameters:
eoss the EndianOSStream to be written to

static PointingRow* asdm::PointingRow::fromBin ( EndianISStream &  eiss,
PointingTable table 
) [static]

Deserialize a stream of bytes read from an EndianISStream to build a PointingRow.

Parameters:
eiss the EndianISStream to be read. the PointingTable to which the row built by deserialization will be parented.

ArrayTimeInterval asdm::PointingRow::getTimeInterval (  )  const

Get timeInterval.

Returns:
timeInterval as ArrayTimeInterval

void asdm::PointingRow::setTimeInterval ( ArrayTimeInterval  timeInterval  )  throw (IllegalAccessException)

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.

bool asdm::PointingRow::isNameExists (  )  const

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

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

string asdm::PointingRow::getName (  )  const throw (IllegalAccessException)

Get name, which is optional.

Returns:
name as string
Exceptions:
IllegalAccessException If name does not exist.

void asdm::PointingRow::setName ( string  name  ) 

Set name with the specified string.

Parameters:
name The string value to which name is to be set.

void asdm::PointingRow::clearName (  ) 

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

int asdm::PointingRow::getNumPoly (  )  const

Get numPoly.

Returns:
numPoly as int

void asdm::PointingRow::setNumPoly ( int  numPoly  ) 

Set numPoly with the specified int.

Parameters:
numPoly The int value to which numPoly is to be set.

ArrayTime asdm::PointingRow::getTimeOrigin (  )  const

Get timeOrigin.

Returns:
timeOrigin as ArrayTime

void asdm::PointingRow::setTimeOrigin ( ArrayTime  timeOrigin  ) 

Set timeOrigin with the specified ArrayTime.

Parameters:
timeOrigin The ArrayTime value to which timeOrigin is to be set.

vector<vector<Angle > > asdm::PointingRow::getPointingDirection (  )  const

Get pointingDirection.

Returns:
pointingDirection as vector<vector<Angle > >

void asdm::PointingRow::setPointingDirection ( vector< vector< Angle > >  pointingDirection  ) 

Set pointingDirection with the specified vector<vector<Angle > >.

Parameters:
pointingDirection The vector<vector<Angle > > value to which pointingDirection is to be set.

vector<vector<Angle > > asdm::PointingRow::getTarget (  )  const

Get target.

Returns:
target as vector<vector<Angle > >

void asdm::PointingRow::setTarget ( vector< vector< Angle > >  target  ) 

Set target with the specified vector<vector<Angle > >.

Parameters:
target The vector<vector<Angle > > value to which target is to be set.

vector<vector<Angle > > asdm::PointingRow::getOffset (  )  const

Get offset.

Returns:
offset as vector<vector<Angle > >

void asdm::PointingRow::setOffset ( vector< vector< Angle > >  offset  ) 

Set offset with the specified vector<vector<Angle > >.

Parameters:
offset The vector<vector<Angle > > value to which offset is to be set.

bool asdm::PointingRow::isSourceOffsetExists (  )  const

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

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

vector<vector<Angle > > asdm::PointingRow::getSourceOffset (  )  const throw (IllegalAccessException)

Get sourceOffset, which is optional.

Returns:
sourceOffset as vector<vector<Angle > >
Exceptions:
IllegalAccessException If sourceOffset does not exist.

void asdm::PointingRow::setSourceOffset ( vector< vector< Angle > >  sourceOffset  ) 

Set sourceOffset with the specified vector<vector<Angle > >.

Parameters:
sourceOffset The vector<vector<Angle > > value to which sourceOffset is to be set.

void asdm::PointingRow::clearSourceOffset (  ) 

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

vector<Angle > asdm::PointingRow::getEncoder (  )  const

Get encoder.

Returns:
encoder as vector<Angle >

void asdm::PointingRow::setEncoder ( vector< Angle encoder  ) 

Set encoder with the specified vector<Angle >.

Parameters:
encoder The vector<Angle > value to which encoder is to be set.

bool asdm::PointingRow::getPointingTracking (  )  const

Get pointingTracking.

Returns:
pointingTracking as bool

void asdm::PointingRow::setPointingTracking ( bool  pointingTracking  ) 

Set pointingTracking with the specified bool.

Parameters:
pointingTracking The bool value to which pointingTracking is to be set.

bool asdm::PointingRow::isPhaseTrackingExists (  )  const

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

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

bool asdm::PointingRow::getPhaseTracking (  )  const throw (IllegalAccessException)

Get phaseTracking, which is optional.

Returns:
phaseTracking as bool
Exceptions:
IllegalAccessException If phaseTracking does not exist.

void asdm::PointingRow::setPhaseTracking ( bool  phaseTracking  ) 

Set phaseTracking with the specified bool.

Parameters:
phaseTracking The bool value to which phaseTracking is to be set.

void asdm::PointingRow::clearPhaseTracking (  ) 

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

bool asdm::PointingRow::isOverTheTopExists (  )  const

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

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

bool asdm::PointingRow::getOverTheTop (  )  const throw (IllegalAccessException)

Get overTheTop, which is optional.

Returns:
overTheTop as bool
Exceptions:
IllegalAccessException If overTheTop does not exist.

void asdm::PointingRow::setOverTheTop ( bool  overTheTop  ) 

Set overTheTop with the specified bool.

Parameters:
overTheTop The bool value to which overTheTop is to be set.

void asdm::PointingRow::clearOverTheTop (  ) 

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

Tag asdm::PointingRow::getAntennaId (  )  const

Get antennaId.

Returns:
antennaId as Tag

void asdm::PointingRow::setAntennaId ( Tag  antennaId  )  throw (IllegalAccessException)

Set antennaId with the specified Tag.

Parameters:
antennaId The Tag value to which antennaId is to be set.
Exceptions:
IllegalAccessException If an attempt is made to change this field after is has been added to the table.

int asdm::PointingRow::getPointingModelId (  )  const

Get pointingModelId.

Returns:
pointingModelId as int

void asdm::PointingRow::setPointingModelId ( int  pointingModelId  ) 

Set pointingModelId with the specified int.

Parameters:
pointingModelId The int value to which pointingModelId is to be set.

AntennaRow* asdm::PointingRow::getAntennaUsingAntennaId (  ) 

antennaId pointer to the row in the Antenna table having Antenna.antennaId == antennaId

Returns:
a AntennaRow*

vector<PointingModelRow *> asdm::PointingRow::getPointingModels (  ) 

Get the collection of row in the PointingModel table having pointingModelId == this.pointingModelId

Returns:
a vector of PointingModelRow *

bool asdm::PointingRow::compareNoAutoInc ( Tag  antennaId,
ArrayTimeInterval  timeInterval,
int  pointingModelId,
int  numPoly,
ArrayTime  timeOrigin,
vector< vector< Angle > >  pointingDirection,
vector< vector< Angle > >  target,
vector< vector< Angle > >  offset,
vector< Angle encoder,
bool  pointingTracking 
)

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

bool asdm::PointingRow::equalByRequiredValue ( PointingRow 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 PointingRow whose required attributes of the value part will be compared with those of this.
Returns:
a boolean.


The documentation for this class was generated from the following file:
Generated on Thu Nov 29 16:46:50 2007 for ASDM C++ Implementation by  doxygen 1.5.1