asdm::PointingTable Class Reference

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

#include <PointingTable.h>

Inheritance diagram for asdm::PointingTable:
asdm::Representable

List of all members.

Public Member Functions

virtual ~PointingTable ()
ASDMgetContainer () 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 Pointing (PointingTable.xsd).
asdmIDL::PointingTableIDL * toIDL ()
 Conversion Methods.
void toIDL (asdmIDL::PointingTableIDL &x) const
 Fills the CORBA data structure passed in parameter with the content of this table.
void fromIDL (asdmIDL::PointingTableIDL x)
 Populate this table from the content of a PointingTableIDL Corba structure.
PointingRownewRow ()
 ====> Row creation.
PointingRownewRow (Tag antennaId, ArrayTimeInterval timeInterval, int numSample, vector< vector< Angle > > encoder, bool pointingTracking, bool usePolynomials, ArrayTime timeOrigin, int numTerm, vector< vector< Angle > > pointingDirection, vector< vector< Angle > > target, vector< vector< Angle > > offset, int pointingModelId)
 Create a new row initialized to the specified values.
PointingRownewRow (PointingRow *row)
 Create a new row using a copy constructor mechanism.
PointingRowadd (PointingRow *x)
 ====> Append a row to its table.
std::vector< PointingRow * > get ()
 ====> Methods returning rows.
const std::vector< PointingRow * > & get () const
 Get a const reference on the collection of rows pointers internally hold by the table.
std::vector< PointingRow * > * getByContext (Tag antennaId)
 Returns all the rows sorted by ascending startTime for a given context.
PointingRowgetRowByKey (Tag antennaId, ArrayTimeInterval timeInterval)
 Returns a PointingRow* given a key.
PointingRowlookup (Tag antennaId, ArrayTimeInterval timeInterval, int numSample, vector< vector< Angle > > encoder, bool pointingTracking, bool usePolynomials, ArrayTime timeOrigin, int numTerm, vector< vector< Angle > > pointingDirection, vector< vector< Angle > > target, vector< vector< Angle > > offset, int pointingModelId)
 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)
BinaryAttributeReaderFunctorgetUnknownAttributeBinaryReader (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
< PointingRow * > 
TIME_ROWS

Private Member Functions

 PointingTable (ASDM &container)
 Create a PointingTable.
PointingRowcheckAndAdd (PointingRow *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 (PointingRow *x)
 Brutally append an PointingRow x to the collection of rows already stored in this table.
void addWithoutCheckingUnique (PointingRow *x)
 Brutally append an PointingRow x to the collection of rows already stored in this table.
PointingRowinsertByStartTime (PointingRow *x, std::vector< PointingRow * > &row)
 Insert a PointingRow* in a vector of PointingRow* so that it's ordered by ascending time.
std::string Key (Tag antennaId)
 Returns a string built by concatenating the ascii representation of the parameters values suffixed with a "_" character.
void getByKeyNoAutoIncNoTime (std::vector< PointingRow * > &vin, std::vector< PointingRow * > &vout, Tag antennaId)
 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 Pointing (PointingTable.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 Pointing 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 PointingTable as those produced by the toFile method.

Private Attributes

ASDMcontainer
bool archiveAsBin
bool fileAsBin
std::string version
Entity entity
std::vector< PointingRow * > privateRows
 A data structure to store the pointers on the table's rows.
std::map< std::string, TIME_ROWScontext
std::map< std::string,
BinaryAttributeReaderFunctor * > 
unknownAttributes2Functors
bool loadInProgress
 Load the table in memory if necessary.

Friends

class ASDM

Detailed Description

The PointingTable class is an Alma table.


Role
Antenna pointing information.

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

Attributes of Pointing

Name

Type

Expected shape

Comment

Key

antennaId

Tag

 

 refers to a unique row in AntennaTable.

timeInterval

ArrayTimeInterval

 

 the time interval of validity of the row's content.

Value
(Mandatory)

numSample

int

 

 the number of time samples.

encoder

vector<vector<Angle > >

numSample, 2

 Encoder values

pointingTracking

bool

 

 the antenna was in tracking mode (true) or not (false).

usePolynomials

bool

 

 use polynomials expansions (true) or not (false).

timeOrigin

ArrayTime

 

 the value used as origin in the polynomials expansions.

numTerm

int

 

 the number of terms of the polynomials.

pointingDirection

vector<vector<Angle > >

numTerm, 2

 the commanded pointing direction.

target

vector<vector<Angle > >

numTerm, 2

 the direction of the target.

offset

vector<vector<Angle > >

numTerm, 2

 Horizon mapping offsets

pointingModelId

int

 

 refers to a collection of rows in PointingModelTable.

Value
(Optional)

overTheTop

bool

 

  pointing ar elevations larger than 90 degrees (true) or lower (false).

sourceOffset

vector<vector<Angle > >

numTerm, 2

  sources offsets (one pair per term of the polynomial).

sourceOffsetReferenceCode

DirectionReferenceCodeMod::DirectionReferenceCode

 

  the direction reference code associated to the source offset.

sourceOffsetEquinox

ArrayTime

 

  the equinox information (if needed by sourceReferenceCode).

sampledTimeInterval

vector<ArrayTimeInterval >

numSample

  an array of ArrayTimeInterval which must be given explicitly as soon as the data are irregularily sampled.

atmosphericCorrection

vector<vector<Angle > >

numTerm, 2

  This is the correction applied to the commanded position to take into account refraction and any other atmospheric effects. This term will always be zero if there is no atmosphere. For ALMA this is the atmospheric refraction correction and will result in a correction in just the elevation axis.

Definition at line 277 of file PointingTable.h.


Member Typedef Documentation

typedef std::vector<PointingRow* > asdm::PointingTable::TIME_ROWS [private]

Definition at line 644 of file PointingTable.h.


Constructor & Destructor Documentation

virtual asdm::PointingTable::~PointingTable (  )  [virtual]
asdm::PointingTable::PointingTable ( ASDM container  )  [private]

Create a PointingTable.

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

PointingRow* asdm::PointingTable::add ( PointingRow x  ) 

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

Add a row.

Parameters:
x a pointer to the PointingRow to be added.
Returns:
a pointer to a PointingRow. If the table contains a PointingRow whose attributes (key and mandatory values) are equal to x ones then returns a pointer on that PointingRow, otherwise returns x.
Exceptions:
DuplicateKey { thrown when the table contains a PointingRow 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 ( antennaId ) are stored by ascending time.
See also:
method getByContext.
void asdm::PointingTable::addWithoutCheckingUnique ( PointingRow x  )  [private]

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

No uniqueness check is done !

Parameters:
PointingRow* x a pointer onto the PointingRow to be appended.
void asdm::PointingTable::append ( PointingRow x  )  [private]

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

No uniqueness check is done !

Parameters:
PointingRow* x a pointer onto the PointingRow to be appended.
PointingRow* asdm::PointingTable::checkAndAdd ( PointingRow 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::PointingTable::checkPresenceInMemory (  )  [inline, private]
static const std::vector<std::string>& asdm::PointingTable::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::PointingTable::error (  )  [private]
void asdm::PointingTable::fromIDL ( asdmIDL::PointingTableIDL  x  ) 

Populate this table from the content of a PointingTableIDL 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::PointingTable::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 Pointing (PointingTable.xsd).

Exceptions:
ConversionException 
const std::vector<PointingRow *>& asdm::PointingTable::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 PointingRow. The elements of this vector are stored in the order in which they have been added to the PointingTable.
std::vector<PointingRow *> asdm::PointingTable::get (  ) 

====> Methods returning rows.

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

Returns:
Alls rows in a vector of pointers of PointingRow. The elements of this vector are stored in the order in which they have been added to the PointingTable.
static const std::vector<std::string>& asdm::PointingTable::getAttributesNames (  )  [static]

Return the names of the attributes of this table.

Returns:
a vector of string
std::vector<PointingRow*>* asdm::PointingTable::getByContext ( Tag  antennaId  ) 

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

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

Returns:
a pointer on a vector<PointingRow *>. A null returned value means that the table contains no PointingRow for the given ( antennaId ).
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::PointingTable::getByKeyNoAutoIncNoTime ( std::vector< PointingRow * > &  vin,
std::vector< PointingRow * > &  vout,
Tag  antennaId 
) [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::PointingTable::getContainer (  )  const

Return the container to which this table belongs.

Returns:
the ASDM containing this table.

Referenced by checkPresenceInMemory().

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

Return this table's Entity.

Implements asdm::Representable.

static const std::vector<std::string>& asdm::PointingTable::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::PointingTable::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.

PointingRow* asdm::PointingTable::getRowByKey ( Tag  antennaId,
ArrayTimeInterval  timeInterval 
)

Returns a PointingRow* 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:
antennaId 
timeInterval 
BinaryAttributeReaderFunctor* asdm::PointingTable::getUnknownAttributeBinaryReader ( const std::string &  attributeName  )  const
std::string asdm::PointingTable::getVersion (  )  const

Return the version information about this table.

PointingRow* asdm::PointingTable::insertByStartTime ( PointingRow x,
std::vector< PointingRow * > &  row 
) [private]

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

Parameters:
PointingRow* x . The pointer to be inserted.
vector <PointingRow*>& row . A reference to the vector where to insert x.
std::string asdm::PointingTable::Key ( Tag  antennaId  )  [private]

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

PointingRow* asdm::PointingTable::lookup ( Tag  antennaId,
ArrayTimeInterval  timeInterval,
int  numSample,
vector< vector< Angle > >  encoder,
bool  pointingTracking,
bool  usePolynomials,
ArrayTime  timeOrigin,
int  numTerm,
vector< vector< Angle > >  pointingDirection,
vector< vector< Angle > >  target,
vector< vector< Angle > >  offset,
int  pointingModelId 
)

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:
antennaId 
timeInterval 
numSample 
encoder 
pointingTracking 
usePolynomials 
timeOrigin 
numTerm 
pointingDirection 
target 
offset 
pointingModelId 
std::string asdm::PointingTable::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::PointingTable::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.
PointingRow* asdm::PointingTable::newRow ( PointingRow row  ) 

Create a new row using a copy constructor mechanism.

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

Parameters:
row the row which is to be copied.
PointingRow* asdm::PointingTable::newRow ( Tag  antennaId,
ArrayTimeInterval  timeInterval,
int  numSample,
vector< vector< Angle > >  encoder,
bool  pointingTracking,
bool  usePolynomials,
ArrayTime  timeOrigin,
int  numTerm,
vector< vector< Angle > >  pointingDirection,
vector< vector< Angle > >  target,
vector< vector< Angle > >  offset,
int  pointingModelId 
)

Create a new row initialized to the specified values.

Returns:
a pointer on the created and initialized row.
Parameters:
antennaId 
timeInterval 
numSample 
encoder 
pointingTracking 
usePolynomials 
timeOrigin 
numTerm 
pointingDirection 
target 
offset 
pointingModelId 
PointingRow* asdm::PointingTable::newRow (  ) 

====> Row creation.

Create a new row with default values.

Returns:
a pointer on a PointingRow
void asdm::PointingTable::setEntity ( Entity  e  )  [virtual]

Set this table's Entity.

Parameters:
e An entity.

Implements asdm::Representable.

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

Reads and parses a file containing a representation of a PointingTable 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::PointingTable::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::PointingTable::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 Pointing table.

void asdm::PointingTable::setFromXMLFile ( const std::string &  directory  )  [private]
void asdm::PointingTable::setUnknownAttributeBinaryReader ( const std::string &  attributeName,
BinaryAttributeReaderFunctor barFctr 
)
unsigned int asdm::PointingTable::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::PointingTable::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 "Pointing.bin" or an XML representation (fileAsBin==false) will be saved in a file "Pointing.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::PointingTable::toIDL ( asdmIDL::PointingTableIDL &  x  )  const

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

Parameters:
x a reference to the asdmIDL::PointingTableIDL to be populated with the content of this.
asdmIDL::PointingTableIDL* asdm::PointingTable::toIDL (  ) 

Conversion Methods.

Convert this table into a PointingTableIDL CORBA structure.

Returns:
a pointer to a PointingTableIDL
std::string asdm::PointingTable::toMIME ( const asdm::ByteOrder byteOrder = asdm::ByteOrder::Machine_Endianity  )  [private]

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

Returns:
a string containing the MIME message.
Parameters:
byteOrder a const pointer to a static instance of the class ByteOrder.
std::string asdm::PointingTable::toXML (  )  [virtual]

Produces an XML representation conform to the schema defined for Pointing (PointingTable.xsd).

Returns:
a string containing the XML representation.
Exceptions:
ConversionException 

Implements asdm::Representable.


Friends And Related Function Documentation

friend class ASDM [friend]

Reimplemented from asdm::Representable.

Definition at line 278 of file PointingTable.h.


Member Data Documentation

Definition at line 584 of file PointingTable.h.

Definition at line 582 of file PointingTable.h.

std::map<std::string, TIME_ROWS > asdm::PointingTable::context [private]

Definition at line 645 of file PointingTable.h.

Definition at line 589 of file PointingTable.h.

Definition at line 585 of file PointingTable.h.

Load the table in memory if necessary.

Reimplemented from asdm::Representable.

Definition at line 725 of file PointingTable.h.

Referenced by checkPresenceInMemory().

std::vector<PointingRow * > asdm::PointingTable::privateRows [private]

A data structure to store the pointers on the table's rows.

In all cases we maintain a private vector of PointingRow s.

Definition at line 635 of file PointingTable.h.

Definition at line 676 of file PointingTable.h.

std::string asdm::PointingTable::version [private]

Definition at line 587 of file PointingTable.h.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

Generated on 31 Aug 2016 for casa by  doxygen 1.6.1