casa  5.7.0-16
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Static Public Member Functions | Private Types | Private Member Functions | Private Attributes | Friends | List of all members
asdm::SysPowerTable Class Reference

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

#include <SysPowerTable.h>

Inheritance diagram for asdm::SysPowerTable:
asdm::Representable

Public Member Functions

virtual ~SysPowerTable ()
 
ASDMgetContainer () const
 Return the container to which this table belongs. More...
 
unsigned int size () const
 Return the number of rows in the table. More...
 
std::string getName () const
 Return the name of this table. More...
 
std::string getVersion () const
 Return the version information about this table. More...
 
Entity getEntity () const
 Return this table's Entity. More...
 
void setEntity (Entity e)
 Set this table's Entity. More...
 
std::string toXML ()
 Produces an XML representation conform to the schema defined for SysPower (SysPowerTable.xsd). More...
 
asdmIDL::SysPowerTableIDL * toIDL ()
 Conversion Methods. More...
 
void toIDL (asdmIDL::SysPowerTableIDL &x) const
 Fills the CORBA data structure passed in parameter with the content of this table. More...
 
void fromIDL (asdmIDL::SysPowerTableIDL x)
 Populate this table from the content of a SysPowerTableIDL Corba structure. More...
 
SysPowerRownewRow ()
 ====> Row creation. More...
 
SysPowerRownewRow (Tag antennaId, Tag spectralWindowId, int feedId, ArrayTimeInterval timeInterval, int numReceptor)
 Create a new row initialized to the specified values. More...
 
SysPowerRownewRow (SysPowerRow *row)
 Create a new row using a copy constructor mechanism. More...
 
SysPowerRowadd (SysPowerRow *x)
 ====> Append a row to its table. More...
 
std::vector< SysPowerRow * > get ()
 ====> Methods returning rows. More...
 
const std::vector< SysPowerRow * > & get () const
 Get a const reference on the collection of rows pointers internally hold by the table. More...
 
std::vector< SysPowerRow * > * getByContext (Tag antennaId, Tag spectralWindowId, int feedId)
 Returns all the rows sorted by ascending startTime for a given context. More...
 
SysPowerRowgetRowByKey (Tag antennaId, Tag spectralWindowId, int feedId, ArrayTimeInterval timeInterval)
 Returns a SysPowerRow* given a key. More...
 
SysPowerRowlookup (Tag antennaId, Tag spectralWindowId, int feedId, ArrayTimeInterval timeInterval, int numReceptor)
 Look up the table for a row whose all attributes are equal to the corresponding parameters of the method. More...
 
void setUnknownAttributeBinaryReader (const std::string &attributeName, BinaryAttributeReaderFunctor *barFctr)
 
BinaryAttributeReaderFunctorgetUnknownAttributeBinaryReader (const std::string &attributeName) const
 
- Public Member Functions inherited from asdm::Representable
virtual ~Representable ()
 

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. More...
 
static std::string name ()
 Return the name of this table. More...
 
static const std::vector
< std::string > & 
getAttributesNames ()
 Return the names of the attributes of this table. More...
 
static const std::vector
< std::string > & 
defaultAttributesNamesInBin ()
 Return the default sorted list of attributes names in the binary representation of the table. More...
 

Private Types

typedef std::vector
< SysPowerRow * > 
TIME_ROWS
 

Private Member Functions

 SysPowerTable (ASDM &container)
 Create a SysPowerTable. More...
 
SysPowerRowcheckAndAdd (SysPowerRow *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. More...
 
void append (SysPowerRow *x)
 Brutally append an SysPowerRow x to the collection of rows already stored in this table. More...
 
void addWithoutCheckingUnique (SysPowerRow *x)
 Brutally append an SysPowerRow x to the collection of rows already stored in this table. More...
 
SysPowerRowinsertByStartTime (SysPowerRow *x, std::vector< SysPowerRow * > &row)
 Insert a SysPowerRow* in a vector of SysPowerRow* so that it's ordered by ascending time. More...
 
std::string Key (Tag antennaId, Tag spectralWindowId, int feedId)
 Returns a string built by concatenating the ascii representation of the parameters values suffixed with a "_" character. More...
 
void getByKeyNoAutoIncNoTime (std::vector< SysPowerRow * > &vin, std::vector< SysPowerRow * > &vout, Tag antennaId, Tag spectralWindowId, int feedId)
 Fills the vector vout (passed by reference) with pointers on elements of vin whose attributes are equal to the corresponding parameters of the method. More...
 
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 SysPower (SysPowerTable.xsd). More...
 
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 SysPower table. More...
 
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. More...
 
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. More...
 
std::string MIMEXMLPart (const asdm::ByteOrder *byteOrder=asdm::ByteOrder::Machine_Endianity)
 Private methods involved during the export of this table into disk file(s). More...
 
void toFile (std::string directory)
 Stores a representation (binary or XML) of this table into a file. More...
 
void checkPresenceInMemory ()
 
void setFromFile (const std::string &directory)
 Reads and parses a file containing a representation of a SysPowerTable as those produced by the toFile method. More...
 

Private Attributes

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

Friends

class ASDM
 

Additional Inherited Members

- Protected Attributes inherited from asdm::Representable
bool presentInMemory
 
bool loadInProgress
 
uint32_t declaredSize
 

Detailed Description

The SysPowerTable class is an Alma table.


Role
This table is intended to store power measurements based on a synchronous power detector as used at the EVLA. While the table is intended to be general enough for use with other arrays, it is deeply entwined with the EVLA data acquisition scheme. The units of $P_{diff}$ and $P_{sum}$ are such that the system temperature, $T_{sys}$, is :

\[ T_{sys}=\frac{P_{sum}}{P_{diff}} . \frac{T_{cal}}{2} \]

where $T_{cal}$ is the temperature of the noise tube.


Generated from model's revision "-1", branch ""

Attributes of SysPower
Name Type Expected shape

Comment

Key

antennaId

Tag  

 

spectralWindowId

Tag  

 

feedId

int  

 

timeInterval

ArrayTimeInterval  

 time interval over which the content of the row was measured.

Value
(Mandatory)

numReceptor (numReceptor) int  

 The number of receptors.

Value
(Optional)

switchedPowerDifference std::vector<float > numReceptor

  the switched power difference $P_{diff}$ defined by $P_{diff} = G*(P_{on}-P_{off})$.

switchedPowerSum std::vector<float > numReceptor

  the switched power sum $P_{sum}$ defined by $P_{sum}=G(P_{on} + P_{off})$.

requantizerGain std::vector<float > numReceptor

  refers to the gain inserted after the synchronous power detector. For WIDAR, it is the requantizer gain ( $G$).

Definition at line 184 of file SysPowerTable.h.

Member Typedef Documentation

typedef std::vector<SysPowerRow* > asdm::SysPowerTable::TIME_ROWS
private

Definition at line 530 of file SysPowerTable.h.

Constructor & Destructor Documentation

virtual asdm::SysPowerTable::~SysPowerTable ( )
virtual
asdm::SysPowerTable::SysPowerTable ( ASDM container)
private

Create a SysPowerTable.

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

SysPowerRow* asdm::SysPowerTable::add ( SysPowerRow x)

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

Add a row.

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

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

No uniqueness check is done !

Parameters
SysPowerRow*x a pointer onto the SysPowerRow to be appended.
void asdm::SysPowerTable::append ( SysPowerRow x)
private

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

No uniqueness check is done !

Parameters
SysPowerRow*x a pointer onto the SysPowerRow to be appended.
SysPowerRow* asdm::SysPowerTable::checkAndAdd ( SysPowerRow 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::SysPowerTable::checkPresenceInMemory ( )
inlineprivate
static const std::vector<std::string>& asdm::SysPowerTable::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::SysPowerTable::error ( )
private
void asdm::SysPowerTable::fromIDL ( asdmIDL::SysPowerTableIDL  x)

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

Exceptions
DuplicateKeyThrown if the method tries to add a row having a key that is already in the table.
ConversionException
void asdm::SysPowerTable::fromXML ( std::string &  xmlDoc)
privatevirtual

Populate this table from the content of a XML document that is required to be conform to the XML schema defined for a SysPower (SysPowerTable.xsd).

Exceptions
ConversionException

Implements asdm::Representable.

std::vector<SysPowerRow *> asdm::SysPowerTable::get ( )

====> Methods returning rows.

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

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

Return the names of the attributes of this table.

Returns
a vector of string
std::vector<SysPowerRow*>* asdm::SysPowerTable::getByContext ( Tag  antennaId,
Tag  spectralWindowId,
int  feedId 
)

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

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

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

Return the container to which this table belongs.

Returns
the ASDM containing this table.

Referenced by checkPresenceInMemory().

Entity asdm::SysPowerTable::getEntity ( ) const
virtual

Return this table's Entity.

Implements asdm::Representable.

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

SysPowerRow* asdm::SysPowerTable::getRowByKey ( Tag  antennaId,
Tag  spectralWindowId,
int  feedId,
ArrayTimeInterval  timeInterval 
)

Returns a SysPowerRow* 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
spectralWindowId
feedId
timeInterval
BinaryAttributeReaderFunctor* asdm::SysPowerTable::getUnknownAttributeBinaryReader ( const std::string &  attributeName) const
std::string asdm::SysPowerTable::getVersion ( ) const

Return the version information about this table.

SysPowerRow* asdm::SysPowerTable::insertByStartTime ( SysPowerRow x,
std::vector< SysPowerRow * > &  row 
)
private

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

Parameters
SysPowerRow*x . The pointer to be inserted.
vector<SysPowerRow*>& row . A reference to the vector where to insert x.
std::string asdm::SysPowerTable::Key ( Tag  antennaId,
Tag  spectralWindowId,
int  feedId 
)
private

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

SysPowerRow* asdm::SysPowerTable::lookup ( Tag  antennaId,
Tag  spectralWindowId,
int  feedId,
ArrayTimeInterval  timeInterval,
int  numReceptor 
)

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
spectralWindowId
feedId
timeInterval
numReceptor
std::string asdm::SysPowerTable::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::SysPowerTable::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.
SysPowerRow* asdm::SysPowerTable::newRow ( )

====> Row creation.

Create a new row with default values.

Returns
a pointer on a SysPowerRow
SysPowerRow* asdm::SysPowerTable::newRow ( Tag  antennaId,
Tag  spectralWindowId,
int  feedId,
ArrayTimeInterval  timeInterval,
int  numReceptor 
)

Create a new row initialized to the specified values.

Returns
a pointer on the created and initialized row.
Parameters
antennaId
spectralWindowId
feedId
timeInterval
numReceptor
SysPowerRow* asdm::SysPowerTable::newRow ( SysPowerRow row)

Create a new row using a copy constructor mechanism.

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

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

Set this table's Entity.

Parameters
eAn entity.

Implements asdm::Representable.

void asdm::SysPowerTable::setFromFile ( const std::string &  directory)
private

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

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

Conversion Methods.

Convert this table into a SysPowerTableIDL CORBA structure.

Returns
a pointer to a SysPowerTableIDL
void asdm::SysPowerTable::toIDL ( asdmIDL::SysPowerTableIDL &  x) const

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

Parameters
xa reference to the asdmIDL::SysPowerTableIDL to be populated with the content of this.
std::string asdm::SysPowerTable::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::SysPowerTable::toXML ( )
virtual

Produces an XML representation conform to the schema defined for SysPower (SysPowerTable.xsd).

Returns
a string containing the XML representation.
Exceptions
ConversionException

Implements asdm::Representable.

Friends And Related Function Documentation

friend class ASDM
friend

Definition at line 185 of file SysPowerTable.h.

Member Data Documentation

bool asdm::SysPowerTable::archiveAsBin
private

Definition at line 467 of file SysPowerTable.h.

ASDM& asdm::SysPowerTable::container
private

Definition at line 465 of file SysPowerTable.h.

std::map<std::string, TIME_ROWS > asdm::SysPowerTable::context
private

Definition at line 531 of file SysPowerTable.h.

Entity asdm::SysPowerTable::entity
private

Definition at line 472 of file SysPowerTable.h.

bool asdm::SysPowerTable::fileAsBin
private

Definition at line 468 of file SysPowerTable.h.

bool asdm::SysPowerTable::loadInProgress
private

Load the table in memory if necessary.

Definition at line 611 of file SysPowerTable.h.

Referenced by checkPresenceInMemory().

std::vector<SysPowerRow * > asdm::SysPowerTable::privateRows
private

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

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

Definition at line 521 of file SysPowerTable.h.

std::map<std::string, BinaryAttributeReaderFunctor *> asdm::SysPowerTable::unknownAttributes2Functors
private

Definition at line 562 of file SysPowerTable.h.

std::string asdm::SysPowerTable::version
private

Definition at line 470 of file SysPowerTable.h.


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