asdm::ScanTable Class Reference

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

#include <ScanTable.h>

Inheritance diagram for asdm::ScanTable:
asdm::Representable

List of all members.

Public Member Functions

virtual ~ScanTable ()
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 Scan (ScanTable.xsd).
asdmIDL::ScanTableIDL * toIDL ()
 Conversion Methods.
void toIDL (asdmIDL::ScanTableIDL &x) const
 Fills the CORBA data structure passed in parameter with the content of this table.
void fromIDL (asdmIDL::ScanTableIDL x)
 Populate this table from the content of a ScanTableIDL Corba structure.
ScanRownewRow ()
 ====> Row creation.
ScanRownewRow (Tag execBlockId, int scanNumber, ArrayTime startTime, ArrayTime endTime, int numIntent, int numSubscan, vector< ScanIntentMod::ScanIntent > scanIntent, vector< CalDataOriginMod::CalDataOrigin > calDataType, vector< bool > calibrationOnLine)
 Create a new row initialized to the specified values.
ScanRownewRow (ScanRow *row)
 Create a new row using a copy constructor mechanism.
ScanRowadd (ScanRow *x)
 ====> Append a row to its table.
std::vector< ScanRow * > get ()
 ====> Methods returning rows.
const std::vector< ScanRow * > & get () const
 Get a const reference on the collection of rows pointers internally hold by the table.
ScanRowgetRowByKey (Tag execBlockId, int scanNumber)
 Returns a ScanRow* given a key.
ScanRowlookup (Tag execBlockId, int scanNumber, ArrayTime startTime, ArrayTime endTime, int numIntent, int numSubscan, vector< ScanIntentMod::ScanIntent > scanIntent, vector< CalDataOriginMod::CalDataOrigin > calDataType, vector< bool > calibrationOnLine)
 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 Member Functions

 ScanTable (ASDM &container)
 Create a ScanTable.
ScanRowcheckAndAdd (ScanRow *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 (ScanRow *x)
 Brutally append an ScanRow x to the collection of rows already stored in this table.
void addWithoutCheckingUnique (ScanRow *x)
 Brutally append an ScanRow x to the collection of rows already stored in this table.
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 Scan (ScanTable.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 Scan 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 ScanTable as those produced by the toFile method.

Private Attributes

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

Friends

class ASDM

Detailed Description

The ScanTable class is an Alma table.


Role
A summary of information for each scan.

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

Attributes of Scan

Name

Type

Expected shape

Comment

Key

execBlockId

Tag

 

 refers to a unique row in ExecBlockTable.

scanNumber

int

 

 the scan number.

Value
(Mandatory)

startTime

ArrayTime

 

 the actual start time of the scan.

endTime

ArrayTime

 

 the actual end time of the scan.

numIntent

int

 

 the number of intents for this scan.

numSubscan

int

 

 the number of subscans contained by this scan.

scanIntent

vector<ScanIntentMod::ScanIntent >

numIntent

 identifies the intents of this scan.

calDataType

vector<CalDataOriginMod::CalDataOrigin >

numIntent

 identifies the calibration data types (one value per intent).

calibrationOnLine

vector<bool >

numIntent

 the online calibration was required (true) or not (false) (one value per intent).

Value
(Optional)

calibrationFunction

vector<CalibrationFunctionMod::CalibrationFunction >

numIntent

  identifies the calibration functions (one value per intent).

calibrationSet

vector<CalibrationSetMod::CalibrationSet >

numIntent

  attaches this scan to a calibration set (one value per intent).

calPattern

vector<AntennaMotionPatternMod::AntennaMotionPattern >

numIntent

  identifies the antenna motion patterns used for the calibration.

numField

int

 

  the number of fields observed.

fieldName

vector<string >

numField

  the names of the observed fields (one value per field).

sourceName

string

 

  the name of the observed source.

Definition at line 252 of file ScanTable.h.


Constructor & Destructor Documentation

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

Create a ScanTable.

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

ScanRow* asdm::ScanTable::add ( ScanRow x  ) 

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

Add a row.

Parameters:
x a pointer to the ScanRow to be added.
Returns:
a pointer to a ScanRow. If the table contains a ScanRow whose attributes (key and mandatory values) are equal to x ones then returns a pointer on that ScanRow, otherwise returns x.
Exceptions:
DuplicateKey { thrown when the table contains a ScanRow with a key equal to the x one but having and a value section different from x one }
void asdm::ScanTable::addWithoutCheckingUnique ( ScanRow x  )  [private]

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

No uniqueness check is done !

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

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

No uniqueness check is done !

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

Populate this table from the content of a ScanTableIDL 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::ScanTable::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 Scan (ScanTable.xsd).

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

====> Methods returning rows.

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

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

Return the names of the attributes of this table.

Returns:
a vector of string
ASDM& asdm::ScanTable::getContainer (  )  const

Return the container to which this table belongs.

Returns:
the ASDM containing this table.

Referenced by checkPresenceInMemory().

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

Return this table's Entity.

Implements asdm::Representable.

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

ScanRow* asdm::ScanTable::getRowByKey ( Tag  execBlockId,
int  scanNumber 
)

Returns a ScanRow* 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:
execBlockId 
scanNumber 
BinaryAttributeReaderFunctor* asdm::ScanTable::getUnknownAttributeBinaryReader ( const std::string &  attributeName  )  const
std::string asdm::ScanTable::getVersion (  )  const

Return the version information about this table.

ScanRow* asdm::ScanTable::lookup ( Tag  execBlockId,
int  scanNumber,
ArrayTime  startTime,
ArrayTime  endTime,
int  numIntent,
int  numSubscan,
vector< ScanIntentMod::ScanIntent >  scanIntent,
vector< CalDataOriginMod::CalDataOrigin >  calDataType,
vector< bool >  calibrationOnLine 
)

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:
execBlockId 
scanNumber 
startTime 
endTime 
numIntent 
numSubscan 
scanIntent 
calDataType 
calibrationOnLine 
std::string asdm::ScanTable::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::ScanTable::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.
ScanRow* asdm::ScanTable::newRow ( ScanRow row  ) 

Create a new row using a copy constructor mechanism.

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

Parameters:
row the row which is to be copied.
ScanRow* asdm::ScanTable::newRow ( Tag  execBlockId,
int  scanNumber,
ArrayTime  startTime,
ArrayTime  endTime,
int  numIntent,
int  numSubscan,
vector< ScanIntentMod::ScanIntent >  scanIntent,
vector< CalDataOriginMod::CalDataOrigin >  calDataType,
vector< bool >  calibrationOnLine 
)

Create a new row initialized to the specified values.

Returns:
a pointer on the created and initialized row.
Parameters:
execBlockId 
scanNumber 
startTime 
endTime 
numIntent 
numSubscan 
scanIntent 
calDataType 
calibrationOnLine 
ScanRow* asdm::ScanTable::newRow (  ) 

====> Row creation.

Create a new row with default values.

Returns:
a pointer on a ScanRow
void asdm::ScanTable::setEntity ( Entity  e  )  [virtual]

Set this table's Entity.

Parameters:
e An entity.

Implements asdm::Representable.

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

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

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

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

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

Conversion Methods.

Convert this table into a ScanTableIDL CORBA structure.

Returns:
a pointer to a ScanTableIDL
std::string asdm::ScanTable::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::ScanTable::toXML (  )  [virtual]

Produces an XML representation conform to the schema defined for Scan (ScanTable.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 253 of file ScanTable.h.


Member Data Documentation

Definition at line 530 of file ScanTable.h.

Definition at line 528 of file ScanTable.h.

Definition at line 535 of file ScanTable.h.

Definition at line 531 of file ScanTable.h.

Load the table in memory if necessary.

Reimplemented from asdm::Representable.

Definition at line 636 of file ScanTable.h.

Referenced by checkPresenceInMemory().

std::vector<ScanRow * > asdm::ScanTable::privateRows [private]

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

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

Definition at line 569 of file ScanTable.h.

std::vector<ScanRow *> asdm::ScanTable::row [private]

Definition at line 573 of file ScanTable.h.

Definition at line 587 of file ScanTable.h.

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

Definition at line 533 of file ScanTable.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