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

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

#include <CalWVRTable.h>

Inheritance diagram for asdm::CalWVRTable:
asdm::Representable asdm::Representable

List of all members.

Public Member Functions

virtual ~CalWVRTable ()
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 CalWVR (CalWVRTable.xsd).
asdmIDL::CalWVRTableIDL * toIDL ()
 Conversion Methods.
void toIDL (asdmIDL::CalWVRTableIDL &x) const
 Fills the CORBA data structure passed in parameter with the content of this table.
void fromIDL (asdmIDL::CalWVRTableIDL x)
 Populate this table from the content of a CalWVRTableIDL Corba structure.
CalWVRRownewRow ()
 ====> Row creation.
CalWVRRownewRow (string antennaName, Tag calDataId, Tag calReductionId, ArrayTime startValidTime, ArrayTime endValidTime, WVRMethodMod::WVRMethod wvrMethod, int numInputAntennas, vector< string > inputAntennaNames, int numChan, vector< Frequency > chanFreq, vector< Frequency > chanWidth, vector< vector< Temperature > > refTemp, int numPoly, vector< vector< vector< float > > > pathCoeff, vector< Frequency > polyFreqLimits, vector< float > wetPath, vector< float > dryPath, Length water)
 Create a new row initialized to the specified values.
CalWVRRownewRow (CalWVRRow *row)
 Create a new row using a copy constructor mechanism.
CalWVRRowadd (CalWVRRow *x)
 ====> Append a row to its table.
std::vector< CalWVRRow * > get ()
 ====> Methods returning rows.
const std::vector< CalWVRRow * > & get () const
 Get a const reference on the collection of rows pointers internally hold by the table.
CalWVRRowgetRowByKey (string antennaName, Tag calDataId, Tag calReductionId)
 Returns a CalWVRRow* given a key.
CalWVRRowlookup (string antennaName, Tag calDataId, Tag calReductionId, ArrayTime startValidTime, ArrayTime endValidTime, WVRMethodMod::WVRMethod wvrMethod, int numInputAntennas, vector< string > inputAntennaNames, int numChan, vector< Frequency > chanFreq, vector< Frequency > chanWidth, vector< vector< Temperature > > refTemp, int numPoly, vector< vector< vector< float > > > pathCoeff, vector< Frequency > polyFreqLimits, vector< float > wetPath, vector< float > dryPath, Length water)
 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 ~CalWVRTable ()
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 CalWVR (CalWVRTable.xsd).
asdmIDL::CalWVRTableIDL * toIDL ()
 Conversion Methods.
void fromIDL (asdmIDL::CalWVRTableIDL x)
 Populate this table from the content of a CalWVRTableIDL Corba structure.
CalWVRRownewRow ()
 ====> Row creation.
CalWVRRownewRow (string antennaName, Tag calDataId, Tag calReductionId, ArrayTime startValidTime, ArrayTime endValidTime, WVRMethodMod::WVRMethod wvrMethod, int numInputAntennas, vector< string > inputAntennaNames, int numChan, vector< Frequency > chanFreq, vector< Frequency > chanWidth, vector< vector< Temperature > > refTemp, int numPoly, vector< vector< vector< float > > > pathCoeff, vector< Frequency > polyFreqLimits, vector< float > wetPath, vector< float > dryPath, Length water)
 Create a new row initialized to the specified values.
CalWVRRownewRow (CalWVRRow *row)
 Create a new row using a copy constructor mechanism.
CalWVRRowadd (CalWVRRow *x)
 ====> Append a row to its table.
std::vector< CalWVRRow * > get ()
 ====> Methods returning rows.
const std::vector< CalWVRRow * > & get () const
 Get a const reference on the collection of rows pointers internally hold by the table.
CalWVRRowgetRowByKey (string antennaName, Tag calDataId, Tag calReductionId)
 Returns a CalWVRRow* given a key.
CalWVRRowlookup (string antennaName, Tag calDataId, Tag calReductionId, ArrayTime startValidTime, ArrayTime endValidTime, WVRMethodMod::WVRMethod wvrMethod, int numInputAntennas, vector< string > inputAntennaNames, int numChan, vector< Frequency > chanFreq, vector< Frequency > chanWidth, vector< vector< Temperature > > refTemp, int numPoly, vector< vector< vector< float > > > pathCoeff, vector< Frequency > polyFreqLimits, vector< float > wetPath, vector< float > dryPath, Length water)
 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 Member Functions

 CalWVRTable (ASDM &container)
 Create a CalWVRTable.
CalWVRRowcheckAndAdd (CalWVRRow *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 (CalWVRRow *x)
 Brutally append an CalWVRRow x to the collection of rows already stored in this table.
void addWithoutCheckingUnique (CalWVRRow *x)
 Brutally append an CalWVRRow 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 CalWVR (CalWVRTable.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 CalWVR 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 CalWVRTable as those produced by the toFile method.
 CalWVRTable (ASDM &container)
 Create a CalWVRTable.
CalWVRRowcheckAndAdd (CalWVRRow *x)
 If this table has an autoincrementable attribute then check if *x verifies the rule of uniqueness and throw exception if not.
void append (CalWVRRow *x)
 Brutally append an CalWVRRow x to the collection of rows already stored in this table.
void addWithoutCheckingUnique (CalWVRRow *x)
 Brutally append an CalWVRRow 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 CalWVR (CalWVRTable.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 CalWVR 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 CalWVRTable 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< CalWVRRow * > privateRows
 A data structure to store the pointers on the table's rows.
std::vector< CalWVRRow * > row
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 CalWVRTable class is an Alma table.


Role
Result of the water vapour radiometric calibration performed by TelCal.

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

Attributes of CalWVR
Name Type Expected shape

Comment

Key

antennaName

string  

 the name of the antenna.

calDataId

Tag  

 refers to a unique row in CalData Table.

calReductionId

Tag  

 refers to unique row in CalReductionTable.

Value
(Mandatory)

startValidTime ArrayTime  

 the start time of result validity period.

endValidTime ArrayTime  

 the end time of result validity period.

wvrMethod WVRMethodMod::WVRMethod  

 identifies the method used for the calibration.

numInputAntennas int  

 the number of input antennas (i.e. equiped with functional WVRs).

inputAntennaNames vector<string > numInputAntennas

 the names of the input antennas (one string per antenna).

numChan int  

 the number of frequency channels in the WVR receiver.

chanFreq vector<Frequency > numChan

 the channel frequencies (one value per channel).

chanWidth vector<Frequency > numChan

 the widths of the channels (one value per channel).

refTemp vector<vector<Temperature > > numInputAntennas, numChan

 the reference temperatures (one value per input antenna per channel).

numPoly int  

 the number of polynomial coefficients.

pathCoeff vector<vector<vector<float > > > numInputAntennas, numChan, numPoly

 the path length coefficients (one value per input antenna per channel per polynomial coefficient).

polyFreqLimits vector<Frequency > 2

 the limits of the interval of frequencies for which the path length coefficients are computed.

wetPath vector<float > numPoly

 The wet path as a function frequency (expressed as a polynomial).

dryPath vector<float > numPoly

 The dry path as a function frequency (expressed as a polynomial).

water Length  

 The precipitable water vapor corresponding to the reference model.


Role
Result of the water vapour radiometric calibration performed by TelCal.

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

Attributes of CalWVR
Name Type Expected shape

Comment

Key

antennaName

string  

 the name of the antenna.

calDataId

Tag  

 refers to a unique row in CalData Table.

calReductionId

Tag  

 refers to unique row in CalReductionTable.

Value
(Mandatory)

startValidTime ArrayTime  

 the start time of result validity period.

endValidTime ArrayTime  

 the end time of result validity period.

wvrMethod WVRMethodMod::WVRMethod  

 identifies the method used for the calibration.

numInputAntennas int  

 the number of input antennas (i.e. equiped with functional WVRs).

inputAntennaNames vector<string > numInputAntennas

 the names of the input antennas (one string per antenna).

numChan int  

 the number of frequency channels in the WVR receiver.

chanFreq vector<Frequency > numChan

 the channel frequencies (one value per channel).

chanWidth vector<Frequency > numChan

 the widths of the channels (one value per channel).

refTemp vector<vector<Temperature > > numInputAntennas, numChan

 the reference temperatures (one value per input antenna per channel).

numPoly int  

 the number of polynomial coefficients.

pathCoeff vector<vector<vector<float > > > numInputAntennas, numChan, numPoly

 the path length coefficients (one value per input antenna per channel per polynomial coefficient).

polyFreqLimits vector<Frequency > 2

 the limits of the interval of frequencies for which the path length coefficients are computed.

wetPath vector<float > numPoly

 The wet path as a function frequency (expressed as a polynomial).

dryPath vector<float > numPoly

 The dry path as a function frequency (expressed as a polynomial).

water Length  

 The precipitable water vapor corresponding to the reference model.

Definition at line 280 of file CalWVRTable.h.


Constructor & Destructor Documentation

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

Create a CalWVRTable.

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::CalWVRTable::~CalWVRTable ( ) [virtual]
asdm::CalWVRTable::CalWVRTable ( ASDM container) [private]

Create a CalWVRTable.

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 CalWVRRow to be added.
Returns:
a pointer to a CalWVRRow. If the table contains a CalWVRRow whose attributes (key and mandatory values) are equal to x ones then returns a pointer on that CalWVRRow, otherwise returns x.
Exceptions:
DuplicateKey{ thrown when the table contains a CalWVRRow with a key equal to the x one but having and a value section different from x one }

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

Add a row.

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

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

No uniqueness check is done !

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

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

No uniqueness check is done !

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

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

No uniqueness check is done !

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

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

No uniqueness check is done !

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

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

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

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

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

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

Exceptions:
ConversionException
std::vector<CalWVRRow *> asdm::CalWVRTable::get ( )

====> Methods returning rows.

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

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

====> Methods returning rows.

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

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

Return the names of the attributes of this table.

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

Return the names of the attributes of this table.

Returns:
a vector of string

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::CalWVRTable::getEntity ( ) const [virtual]

Return this table's Entity.

Implements asdm::Representable.

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

Return this table's Entity.

Implements asdm::Representable.

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

CalWVRRow* asdm::CalWVRTable::getRowByKey ( string  antennaName,
Tag  calDataId,
Tag  calReductionId 
)

Returns a CalWVRRow* 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:
antennaName
calDataId
calReductionId
CalWVRRow* asdm::CalWVRTable::getRowByKey ( string  antennaName,
Tag  calDataId,
Tag  calReductionId 
)

Returns a CalWVRRow* 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:
antennaName
calDataId
calReductionId
std::string asdm::CalWVRTable::getVersion ( ) const

Return the version information about this table.

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

Return the version information about this table.

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

A method to fill attributesNames and attributesNamesInBin;.

CalWVRRow* asdm::CalWVRTable::lookup ( string  antennaName,
Tag  calDataId,
Tag  calReductionId,
ArrayTime  startValidTime,
ArrayTime  endValidTime,
WVRMethodMod::WVRMethod  wvrMethod,
int  numInputAntennas,
vector< string >  inputAntennaNames,
int  numChan,
vector< Frequency chanFreq,
vector< Frequency chanWidth,
vector< vector< Temperature > >  refTemp,
int  numPoly,
vector< vector< vector< float > > >  pathCoeff,
vector< Frequency polyFreqLimits,
vector< float >  wetPath,
vector< float >  dryPath,
Length  water 
)

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:
antennaName
calDataId
calReductionId
startValidTime
endValidTime
wvrMethod
numInputAntennas
inputAntennaNames
numChan
chanFreq
chanWidth
refTemp
numPoly
pathCoeff
polyFreqLimits
wetPath
dryPath
water
CalWVRRow* asdm::CalWVRTable::lookup ( string  antennaName,
Tag  calDataId,
Tag  calReductionId,
ArrayTime  startValidTime,
ArrayTime  endValidTime,
WVRMethodMod::WVRMethod  wvrMethod,
int  numInputAntennas,
vector< string >  inputAntennaNames,
int  numChan,
vector< Frequency chanFreq,
vector< Frequency chanWidth,
vector< vector< Temperature > >  refTemp,
int  numPoly,
vector< vector< vector< float > > >  pathCoeff,
vector< Frequency polyFreqLimits,
vector< float >  wetPath,
vector< float >  dryPath,
Length  water 
)

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:
antennaName
calDataId
calReductionId
startValidTime
endValidTime
wvrMethod
numInputAntennas
inputAntennaNames
numChan
chanFreq
chanWidth
refTemp
numPoly
pathCoeff
polyFreqLimits
wetPath
dryPath
water

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::CalWVRTable::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::CalWVRTable::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 CalWVRRow

====> Row creation.

Create a new row with default values.

Returns:
a pointer on a CalWVRRow
CalWVRRow* asdm::CalWVRTable::newRow ( string  antennaName,
Tag  calDataId,
Tag  calReductionId,
ArrayTime  startValidTime,
ArrayTime  endValidTime,
WVRMethodMod::WVRMethod  wvrMethod,
int  numInputAntennas,
vector< string >  inputAntennaNames,
int  numChan,
vector< Frequency chanFreq,
vector< Frequency chanWidth,
vector< vector< Temperature > >  refTemp,
int  numPoly,
vector< vector< vector< float > > >  pathCoeff,
vector< Frequency polyFreqLimits,
vector< float >  wetPath,
vector< float >  dryPath,
Length  water 
)

Create a new row initialized to the specified values.

Returns:
a pointer on the created and initialized row.
Parameters:
antennaName
calDataId
calReductionId
startValidTime
endValidTime
wvrMethod
numInputAntennas
inputAntennaNames
numChan
chanFreq
chanWidth
refTemp
numPoly
pathCoeff
polyFreqLimits
wetPath
dryPath
water
CalWVRRow* asdm::CalWVRTable::newRow ( string  antennaName,
Tag  calDataId,
Tag  calReductionId,
ArrayTime  startValidTime,
ArrayTime  endValidTime,
WVRMethodMod::WVRMethod  wvrMethod,
int  numInputAntennas,
vector< string >  inputAntennaNames,
int  numChan,
vector< Frequency chanFreq,
vector< Frequency chanWidth,
vector< vector< Temperature > >  refTemp,
int  numPoly,
vector< vector< vector< float > > >  pathCoeff,
vector< Frequency polyFreqLimits,
vector< float >  wetPath,
vector< float >  dryPath,
Length  water 
)

Create a new row initialized to the specified values.

Returns:
a pointer on the created and initialized row.
Parameters:
antennaName
calDataId
calReductionId
startValidTime
endValidTime
wvrMethod
numInputAntennas
inputAntennaNames
numChan
chanFreq
chanWidth
refTemp
numPoly
pathCoeff
polyFreqLimits
wetPath
dryPath
water

Create a new row using a copy constructor mechanism.

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

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

Set this table's Entity.

Parameters:
eAn entity.

Implements asdm::Representable.

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

Set this table's Entity.

Parameters:
eAn entity.

Implements asdm::Representable.

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

Reads and parses a file containing a representation of a CalWVRTable 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::CalWVRTable::setFromFile ( const std::string &  directory) [private]

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

void asdm::CalWVRTable::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 CalWVR table.

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

Conversion Methods.

Convert this table into a CalWVRTableIDL CORBA structure.

Returns:
a pointer to a CalWVRTableIDL
asdmIDL::CalWVRTableIDL* asdm::CalWVRTable::toIDL ( )

Conversion Methods.

Convert this table into a CalWVRTableIDL CORBA structure.

Returns:
a pointer to a CalWVRTableIDL
void asdm::CalWVRTable::toIDL ( asdmIDL::CalWVRTableIDL &  x) const

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

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

Produces an XML representation conform to the schema defined for CalWVR (CalWVRTable.xsd).

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

Implements asdm::Representable.

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

Produces an XML representation conform to the schema defined for CalWVR (CalWVRTable.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 281 of file CalWVRTable.h.


Member Data Documentation

Definition at line 596 of file CalWVRTable.h.

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

The attributes names.

Definition at line 601 of file CalWVRTable.h.

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

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

Definition at line 606 of file CalWVRTable.h.

Definition at line 594 of file CalWVRTable.h.

Definition at line 601 of file CalWVRTable.h.

Definition at line 597 of file CalWVRTable.h.

Definition at line 612 of file CalWVRTable.h.

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

The name of this table.

Definition at line 596 of file CalWVRTable.h.

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

The list of field names that make up key key.

Definition at line 618 of file CalWVRTable.h.

Load the table in memory if necessary.

Reimplemented from asdm::Representable.

Definition at line 702 of file CalWVRTable.h.

Referenced by checkPresenceInMemory().

std::vector< CalWVRRow * > asdm::CalWVRTable::privateRows [private]

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

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

Definition at line 635 of file CalWVRTable.h.

std::vector< CalWVRRow * > asdm::CalWVRTable::row [private]

Definition at line 639 of file CalWVRTable.h.

Definition at line 653 of file CalWVRTable.h.

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

Definition at line 599 of file CalWVRTable.h.


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