casa  $Rev:20696$
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Public Member Functions | Static Public Member Functions | Private Types | Private Member Functions | Static Private Member Functions | Private Attributes | Static Private Attributes | Friends
asdm::FocusTable Class Reference

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

#include <FocusTable.h>

Inheritance diagram for asdm::FocusTable:
asdm::Representable asdm::Representable

List of all members.

Public Member Functions

virtual ~FocusTable ()
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 Focus (FocusTable.xsd).
asdmIDL::FocusTableIDL * toIDL ()
 Conversion Methods.
void toIDL (asdmIDL::FocusTableIDL &x) const
 Fills the CORBA data structure passed in parameter with the content of this table.
void fromIDL (asdmIDL::FocusTableIDL x)
 Populate this table from the content of a FocusTableIDL Corba structure.
FocusRownewRow ()
 ====> Row creation.
FocusRownewRow (Tag antennaId, ArrayTimeInterval timeInterval, bool focusTracking, vector< Length > focusOffset, vector< Angle > focusRotationOffset, int focusModelId)
 Create a new row initialized to the specified values.
FocusRownewRow (FocusRow *row)
 Create a new row using a copy constructor mechanism.
FocusRowadd (FocusRow *x)
 ====> Append a row to its table.
std::vector< FocusRow * > get ()
 ====> Methods returning rows.
const std::vector< FocusRow * > & get () const
 Get a const reference on the collection of rows pointers internally hold by the table.
std::vector< FocusRow * > * getByContext (Tag antennaId)
 Returns all the rows sorted by ascending startTime for a given context.
FocusRowgetRowByKey (Tag antennaId, ArrayTimeInterval timeInterval)
 Returns a FocusRow* given a key.
FocusRowlookup (Tag antennaId, ArrayTimeInterval timeInterval, bool focusTracking, vector< Length > focusOffset, vector< Angle > focusRotationOffset, int focusModelId)
 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
virtual ~FocusTable ()
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 Focus (FocusTable.xsd).
asdmIDL::FocusTableIDL * toIDL ()
 Conversion Methods.
void fromIDL (asdmIDL::FocusTableIDL x)
 Populate this table from the content of a FocusTableIDL Corba structure.
FocusRownewRow ()
 ====> Row creation.
FocusRownewRow (Tag antennaId, ArrayTimeInterval timeInterval, bool focusTracking, vector< Length > focusOffset, vector< Angle > focusRotationOffset, int focusModelId)
 Create a new row initialized to the specified values.
FocusRownewRow (FocusRow *row)
 Create a new row using a copy constructor mechanism.
FocusRowadd (FocusRow *x)
 ====> Append a row to its table.
std::vector< FocusRow * > get ()
 ====> Methods returning rows.
const std::vector< FocusRow * > & get () const
 Get a const reference on the collection of rows pointers internally hold by the table.
std::vector< FocusRow * > * getByContext (Tag antennaId)
 Returns all the rows sorted by ascending startTime for a given context.
FocusRowgetRowByKey (Tag antennaId, ArrayTimeInterval timeInterval)
 Returns a FocusRow* given a key.
FocusRowlookup (Tag antennaId, ArrayTimeInterval timeInterval, bool focusTracking, vector< Length > focusOffset, vector< Angle > focusRotationOffset, int focusModelId)
 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.
static 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< FocusRow * > TIME_ROWS
typedef std::vector< FocusRow * > TIME_ROWS

Private Member Functions

 FocusTable (ASDM &container)
 Create a FocusTable.
FocusRowcheckAndAdd (FocusRow *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 (FocusRow *x)
 Brutally append an FocusRow x to the collection of rows already stored in this table.
void addWithoutCheckingUnique (FocusRow *x)
 Brutally append an FocusRow x to the collection of rows already stored in this table.
FocusRowinsertByStartTime (FocusRow *x, std::vector< FocusRow * > &row)
 Insert a FocusRow* in a vector of FocusRow* 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< FocusRow * > &vin, std::vector< FocusRow * > &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 Focus (FocusTable.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 Focus 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 FocusTable as those produced by the toFile method.
 FocusTable (ASDM &container)
 Create a FocusTable.
FocusRowcheckAndAdd (FocusRow *x)
 If this table has an autoincrementable attribute then check if *x verifies the rule of uniqueness and throw exception if not.
void append (FocusRow *x)
 Brutally append an FocusRow x to the collection of rows already stored in this table.
void addWithoutCheckingUnique (FocusRow *x)
 Brutally append an FocusRow x to the collection of rows already stored in this table.
FocusRowinsertByStartTime (FocusRow *x, std::vector< FocusRow * > &row)
 Insert a FocusRow* in a vector of FocusRow* 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< FocusRow * > &vin, std::vector< FocusRow * > &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 Focus (FocusTable.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 Focus 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 FocusTable as those produced by the toFile method.

Static Private Member Functions

static bool initAttributesNames ()
 A method to fill attributesNames and attributesNamesInBin;.

Private Attributes

ASDMcontainer
bool archiveAsBin
bool fileAsBin
std::string version
Entity entity
std::vector< FocusRow * > 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.
static bool initAttributesNamesDone

Static Private Attributes

static std::string itsName
 The name of this table.
static std::vector< std::string > attributesNames
 The attributes names.
static std::vector< std::string > attributesNamesInBin
 The attributes names in the order in which they appear in the binary representation of the table.
static std::vector< std::string > key
 The list of field names that make up key key.

Friends

class ASDM

Detailed Description

The FocusTable class is an Alma table.


Role
Contains the focus information.

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

Attributes of Focus
Name Type Expected shape

Comment

Key

antennaId

Tag  

 refers to a unique row in AntennaTable.

timeInterval

ArrayTimeInterval  

 time interval for which the row's content is valid.

Value
(Mandatory)

focusTracking bool  

 the focus motions have been tracked (true) or not tracked (false).

focusOffset vector<Length > 3

 focus offset relative to the tracked position (a triple ).

focusRotationOffset vector<Angle > 2

 focus rotation offset relative to the tracked position (tip, tilt).

focusModelId int  

 refers to a collection of rows in FocusModelTable.

Value
(Optional)

measuredFocusPosition vector<Length > 3

  the measured focus position.

measuredFocusRotation vector<Angle > 2

  the measured focus rotation (tip, tilt).


Role
Contains the focus information.

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

Attributes of Focus
Name Type Expected shape

Comment

Key

antennaId

Tag  

 refers to a unique row in AntennaTable.

timeInterval

ArrayTimeInterval  

 time interval for which the row's content is valid.

Value
(Mandatory)

focusTracking bool  

 the focus motions have been tracked (true) or not tracked (false).

focusOffset vector<Length > 3

 focus offset relative to the tracked position (a triple ).

focusRotationOffset vector<Angle > 2

 focus rotation offset relative to the tracked position (tip, tilt).

focusModelId int  

 refers to a collection of rows in FocusModelTable.

Value
(Optional)

measuredFocusPosition vector<Length > 3

  the measured focus position.

measuredFocusRotation vector<Angle > 2

  the measured focus rotation (tip, tilt).

Definition at line 185 of file FocusTable.h.


Member Typedef Documentation

typedef std::vector<FocusRow* > asdm::FocusTable::TIME_ROWS [private]

Definition at line 528 of file FocusTable.h.

typedef std::vector<FocusRow* > asdm::FocusTable::TIME_ROWS [private]

Definition at line 544 of file FocusTable.h.


Constructor & Destructor Documentation

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

Create a FocusTable.

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

Parameters:
containerThe container to which this table belongs.
virtual asdm::FocusTable::~FocusTable ( ) [virtual]
asdm::FocusTable::FocusTable ( ASDM container) [private]

Create a FocusTable.

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

Parameters:
containerThe container to which this table belongs.

Member Function Documentation

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

Add a row.

Parameters:
xa pointer to the FocusRow to be added.
Returns:
a pointer to a FocusRow. If the table contains a FocusRow whose attributes (key and mandatory values) are equal to x ones then returns a pointer on that FocusRow, otherwise returns x.
Exceptions:
DuplicateKey{ thrown when the table contains a FocusRow 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.

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

Add a row.

Parameters:
xa pointer to the FocusRow to be added.
Returns:
a pointer to a FocusRow. If the table contains a FocusRow whose attributes (key and mandatory values) are equal to x ones then returns a pointer on that FocusRow, otherwise returns x.
Exceptions:
DuplicateKey{ thrown when the table contains a FocusRow 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.

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

No uniqueness check is done !

Parameters:
FocusRow*x a pointer onto the FocusRow to be appended.

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

No uniqueness check is done !

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

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

No uniqueness check is done !

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

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

No uniqueness check is done !

Parameters:
FocusRow*x a pointer onto the FocusRow to be appended.
FocusRow* asdm::FocusTable::checkAndAdd ( FocusRow 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

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::FocusTable::checkPresenceInMemory ( ) [inline, private]
void asdm::FocusTable::checkPresenceInMemory ( ) [inline, private]
static const std::vector<std::string>& asdm::FocusTable::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
static const std::vector<std::string>& asdm::FocusTable::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::FocusTable::error ( ) [private]
void asdm::FocusTable::error ( ) [private]
void asdm::FocusTable::fromIDL ( asdmIDL::FocusTableIDL  x)

Populate this table from the content of a FocusTableIDL Corba structure.

Exceptions:
DuplicateKeyThrown if the method tries to add a row having a key that is already in the table.
ConversionException
void asdm::FocusTable::fromIDL ( asdmIDL::FocusTableIDL  x)

Populate this table from the content of a FocusTableIDL Corba structure.

Exceptions:
DuplicateKeyThrown if the method tries to add a row having a key that is already in the table.
ConversionException
void asdm::FocusTable::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 Focus (FocusTable.xsd).

Exceptions:
ConversionException
void asdm::FocusTable::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 Focus (FocusTable.xsd).

Exceptions:
ConversionException
std::vector<FocusRow *> asdm::FocusTable::get ( )

====> Methods returning rows.

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

Returns:
Alls rows in a vector of pointers of FocusRow. The elements of this vector are stored in the order in which they have been added to the FocusTable.
const std::vector<FocusRow *>& asdm::FocusTable::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 FocusRow. The elements of this vector are stored in the order in which they have been added to the FocusTable.
std::vector<FocusRow *> asdm::FocusTable::get ( )

====> Methods returning rows.

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

Returns:
Alls rows in a vector of pointers of FocusRow. The elements of this vector are stored in the order in which they have been added to the FocusTable.
const std::vector<FocusRow *>& asdm::FocusTable::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 FocusRow. The elements of this vector are stored in the order in which they have been added to the FocusTable.
static const std::vector<std::string>& asdm::FocusTable::getAttributesNames ( ) [static]

Return the names of the attributes of this table.

Returns:
a vector of string
static const std::vector<std::string>& asdm::FocusTable::getAttributesNames ( ) [static]

Return the names of the attributes of this table.

Returns:
a vector of string
std::vector<FocusRow*>* asdm::FocusTable::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<FocusRow *>. A null returned value means that the table contains no FocusRow for the given ( antennaId ).
Exceptions:
IllegalAccessExceptionwhen a call is done to this method when it's called while the dataset has been imported with the option checkRowUniqueness set to false.
std::vector<FocusRow*>* asdm::FocusTable::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<FocusRow *>. A null returned value means that the table contains no FocusRow for the given ( antennaId ).
Exceptions:
IllegalAccessExceptionwhen 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::FocusTable::getByKeyNoAutoIncNoTime ( std::vector< FocusRow * > &  vin,
std::vector< FocusRow * > &  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.

void asdm::FocusTable::getByKeyNoAutoIncNoTime ( std::vector< FocusRow * > &  vin,
std::vector< FocusRow * > &  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.

Return the container to which this table belongs.

Returns:
the ASDM containing this table.

Return the container to which this table belongs.

Returns:
the ASDM containing this table.

Referenced by checkPresenceInMemory().

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

Return this table's Entity.

Implements asdm::Representable.

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

Return this table's Entity.

Implements asdm::Representable.

static std::vector<std::string> asdm::FocusTable::getKeyName ( ) [static]

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

Returns:
a vector of string.
static const std::vector<std::string>& asdm::FocusTable::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::FocusTable::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.

std::string asdm::FocusTable::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.

FocusRow* asdm::FocusTable::getRowByKey ( Tag  antennaId,
ArrayTimeInterval  timeInterval 
)

Returns a FocusRow* 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
FocusRow* asdm::FocusTable::getRowByKey ( Tag  antennaId,
ArrayTimeInterval  timeInterval 
)

Returns a FocusRow* 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
std::string asdm::FocusTable::getVersion ( ) const

Return the version information about this table.

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

Return the version information about this table.

static bool asdm::FocusTable::initAttributesNames ( ) [static, private]

A method to fill attributesNames and attributesNamesInBin;.

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

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

Parameters:
FocusRow*x . The pointer to be inserted.
vector<FocusRow*>& row . A reference to the vector where to insert x.
FocusRow* asdm::FocusTable::insertByStartTime ( FocusRow x,
std::vector< FocusRow * > &  row 
) [private]

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

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

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

std::string asdm::FocusTable::Key ( Tag  antennaId) [private]

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

FocusRow* asdm::FocusTable::lookup ( Tag  antennaId,
ArrayTimeInterval  timeInterval,
bool  focusTracking,
vector< Length focusOffset,
vector< Angle focusRotationOffset,
int  focusModelId 
)

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
focusTracking
focusOffset
focusRotationOffset
focusModelId
FocusRow* asdm::FocusTable::lookup ( Tag  antennaId,
ArrayTimeInterval  timeInterval,
bool  focusTracking,
vector< Length focusOffset,
vector< Angle focusRotationOffset,
int  focusModelId 
)

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
focusTracking
focusOffset
focusRotationOffset
focusModelId

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

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

static std::string asdm::FocusTable::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.
static std::string asdm::FocusTable::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.

====> Row creation.

Create a new row with default values.

Returns:
a pointer on a FocusRow

====> Row creation.

Create a new row with default values.

Returns:
a pointer on a FocusRow
FocusRow* asdm::FocusTable::newRow ( Tag  antennaId,
ArrayTimeInterval  timeInterval,
bool  focusTracking,
vector< Length focusOffset,
vector< Angle focusRotationOffset,
int  focusModelId 
)

Create a new row initialized to the specified values.

Returns:
a pointer on the created and initialized row.
Parameters:
antennaId
timeInterval
focusTracking
focusOffset
focusRotationOffset
focusModelId
FocusRow* asdm::FocusTable::newRow ( Tag  antennaId,
ArrayTimeInterval  timeInterval,
bool  focusTracking,
vector< Length focusOffset,
vector< Angle focusRotationOffset,
int  focusModelId 
)

Create a new row initialized to the specified values.

Returns:
a pointer on the created and initialized row.
Parameters:
antennaId
timeInterval
focusTracking
focusOffset
focusRotationOffset
focusModelId

Create a new row using a copy constructor mechanism.

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

Parameters:
rowthe row which is to be copied.

Create a new row using a copy constructor mechanism.

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

Parameters:
rowthe row which is to be copied.
void asdm::FocusTable::setEntity ( Entity  e) [virtual]

Set this table's Entity.

Parameters:
eAn entity.

Implements asdm::Representable.

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

Set this table's Entity.

Parameters:
eAn entity.

Implements asdm::Representable.

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

Reads and parses a file containing a representation of a FocusTable as those produced by the toFile method.

This table is populated with the result of the parsing.

Parameters:
directoryThe name of the directory containing the file te be read and parsed.
Exceptions:
ConversionExceptionIf any error occurs while reading the files in the directory or parsing them.

Referenced by checkPresenceInMemory().

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

Reads and parses a file containing a representation of a FocusTable as those produced by the toFile method.

This table is populated with the result of the parsing.

Parameters:
directoryThe name of the directory containing the file te be read and parsed.
Exceptions:
ConversionExceptionIf any error occurs while reading the files in the directory or parsing them.
void asdm::FocusTable::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:
mimeMsgthe string containing the MIME message.
Exceptions:
ConversionException
void asdm::FocusTable::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:
mimeMsgthe string containing the MIME message.
Exceptions:
ConversionException
void asdm::FocusTable::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 Focus table.

void asdm::FocusTable::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 Focus table.

void asdm::FocusTable::setFromXMLFile ( const std::string &  directory) [private]
void asdm::FocusTable::setFromXMLFile ( const std::string &  directory) [private]
void asdm::FocusTable::setUnknownAttributeBinaryReader ( const std::string &  attributeName,
BinaryAttributeReaderFunctor barFctr 
)
void asdm::FocusTable::setUnknownAttributeBinaryReader ( const std::string &  attributeName,
BinaryAttributeReaderFunctor barFctr 
)
unsigned int asdm::FocusTable::size ( ) const [virtual]

Return the number of rows in the table.

Returns:
the number of rows in an unsigned int.

Implements asdm::Representable.

unsigned int asdm::FocusTable::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::FocusTable::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 "Focus.bin" or an XML representation (fileAsBin==false) will be saved in a file "Focus.xml". The file is always written in a directory whose name is passed as a parameter.

Parameters:
directoryThe name of directory where the file containing the table's representation will be saved.
void asdm::FocusTable::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 "Focus.bin" or an XML representation (fileAsBin==false) will be saved in a file "Focus.xml". The file is always written in a directory whose name is passed as a parameter.

Parameters:
directoryThe name of directory where the file containing the table's representation will be saved.
asdmIDL::FocusTableIDL* asdm::FocusTable::toIDL ( )

Conversion Methods.

Convert this table into a FocusTableIDL CORBA structure.

Returns:
a pointer to a FocusTableIDL
asdmIDL::FocusTableIDL* asdm::FocusTable::toIDL ( )

Conversion Methods.

Convert this table into a FocusTableIDL CORBA structure.

Returns:
a pointer to a FocusTableIDL
void asdm::FocusTable::toIDL ( asdmIDL::FocusTableIDL &  x) const

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

Parameters:
xa reference to the asdmIDL::FocusTableIDL to be populated with the content of this.
std::string asdm::FocusTable::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:
byteOrdera const pointer to a static instance of the class ByteOrder.
std::string asdm::FocusTable::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:
byteOrdera const pointer to a static instance of the class ByteOrder.
std::string asdm::FocusTable::toXML ( ) [virtual]

Produces an XML representation conform to the schema defined for Focus (FocusTable.xsd).

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

Implements asdm::Representable.

std::string asdm::FocusTable::toXML ( ) [virtual]

Produces an XML representation conform to the schema defined for Focus (FocusTable.xsd).

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

Implements asdm::Representable.


Friends And Related Function Documentation

ASDM [friend]

Reimplemented from asdm::Representable.

Definition at line 186 of file FocusTable.h.


Member Data Documentation

Definition at line 468 of file FocusTable.h.

std::vector<std::string> asdm::FocusTable::attributesNames [static, private]

The attributes names.

Definition at line 473 of file FocusTable.h.

std::vector<std::string> asdm::FocusTable::attributesNamesInBin [static, private]

The attributes names in the order in which they appear in the binary representation of the table.

Definition at line 478 of file FocusTable.h.

Definition at line 466 of file FocusTable.h.

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

Definition at line 529 of file FocusTable.h.

Definition at line 473 of file FocusTable.h.

Definition at line 469 of file FocusTable.h.

Definition at line 484 of file FocusTable.h.

std::string asdm::FocusTable::itsName [static, private]

The name of this table.

Definition at line 468 of file FocusTable.h.

std::vector<std::string> asdm::FocusTable::key [static, private]

The list of field names that make up key key.

Definition at line 490 of file FocusTable.h.

Load the table in memory if necessary.

Reimplemented from asdm::Representable.

Definition at line 609 of file FocusTable.h.

Referenced by checkPresenceInMemory().

std::vector< FocusRow * > asdm::FocusTable::privateRows [private]

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

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

Definition at line 519 of file FocusTable.h.

Definition at line 560 of file FocusTable.h.

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

Definition at line 471 of file FocusTable.h.


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