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::FlagTable Class Reference

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

#include <FlagTable.h>

Inheritance diagram for asdm::FlagTable:
asdm::Representable asdm::Representable

List of all members.

Public Member Functions

virtual ~FlagTable ()
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 Flag (FlagTable.xsd).
asdmIDL::FlagTableIDL * toIDL ()
 Conversion Methods.
void toIDL (asdmIDL::FlagTableIDL &x) const
 Fills the CORBA data structure passed in parameter with the content of this table.
void fromIDL (asdmIDL::FlagTableIDL x)
 Populate this table from the content of a FlagTableIDL Corba structure.
FlagRownewRow ()
 ====> Row creation.
FlagRownewRow (ArrayTime startTime, ArrayTime endTime, string reason, int numAntenna, vector< Tag > antennaId)
 Create a new row initialized to the specified values.
FlagRownewRow (FlagRow *row)
 Create a new row using a copy constructor mechanism.
FlagRowadd (FlagRow *x)
 ====> Append a row to its table.
std::vector< FlagRow * > get ()
 ====> Methods returning rows.
const std::vector< FlagRow * > & get () const
 Get a const reference on the collection of rows pointers internally hold by the table.
FlagRowgetRowByKey (Tag flagId)
 Returns a FlagRow* given a key.
FlagRowlookup (ArrayTime startTime, ArrayTime endTime, string reason, int numAntenna, vector< Tag > antennaId)
 Look up the table for a row whose all attributes except the autoincrementable one are equal to the corresponding parameters of the method.
void setUnknownAttributeBinaryReader (const std::string &attributeName, BinaryAttributeReaderFunctor *barFctr)
BinaryAttributeReaderFunctorgetUnknownAttributeBinaryReader (const std::string &attributeName) const
virtual ~FlagTable ()
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 Flag (FlagTable.xsd).
asdmIDL::FlagTableIDL * toIDL ()
 Conversion Methods.
void fromIDL (asdmIDL::FlagTableIDL x)
 Populate this table from the content of a FlagTableIDL Corba structure.
FlagRownewRow ()
 ====> Row creation.
FlagRownewRow (ArrayTime startTime, ArrayTime endTime, string reason, int numAntenna, vector< Tag > antennaId)
 Create a new row initialized to the specified values.
FlagRownewRow (FlagRow *row)
 Create a new row using a copy constructor mechanism.
FlagRowadd (FlagRow *x)
 ====> Append a row to its table.
std::vector< FlagRow * > get ()
 ====> Methods returning rows.
const std::vector< FlagRow * > & get () const
 Get a const reference on the collection of rows pointers internally hold by the table.
FlagRowgetRowByKey (Tag flagId)
 Returns a FlagRow* given a key.
FlagRowlookup (ArrayTime startTime, ArrayTime endTime, string reason, int numAntenna, vector< Tag > antennaId)
 Look up the table for a row whose all attributes except the autoincrementable one 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

 FlagTable (ASDM &container)
 Create a FlagTable.
void autoIncrement (std::string key, FlagRow *x)
FlagRowcheckAndAdd (FlagRow *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 (FlagRow *x)
 Brutally append an FlagRow x to the collection of rows already stored in this table.
void addWithoutCheckingUnique (FlagRow *x)
 Brutally append an FlagRow 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 Flag (FlagTable.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 Flag 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 FlagTable as those produced by the toFile method.
 FlagTable (ASDM &container)
 Create a FlagTable.
void autoIncrement (std::string key, FlagRow *x)
FlagRowcheckAndAdd (FlagRow *x)
 If this table has an autoincrementable attribute then check if *x verifies the rule of uniqueness and throw exception if not.
void append (FlagRow *x)
 Brutally append an FlagRow x to the collection of rows already stored in this table.
void addWithoutCheckingUnique (FlagRow *x)
 Brutally append an FlagRow 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 Flag (FlagTable.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 Flag 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 FlagTable 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::map< std::string, int > noAutoIncIds
 A map for the autoincrementation algorithm.
std::vector< FlagRow * > privateRows
 A data structure to store the pointers on the table's rows.
std::vector< FlagRow * > 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 FlagTable class is an Alma table.


Role
This table is used for flagging visibility data and is used in addition to the Binary Data Format flags produced by the correlator software.

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

Attributes of Flag
Name Type Expected shape

Comment

Key

flagId

Tag  

 identifies a unique row in the table.

Value
(Mandatory)

startTime ArrayTime  

 the start time of the flagging period.

endTime ArrayTime  

 the end time of the flagging period.

reason string  

 Extensible list of flagging conditions.

numAntenna int  

 The number of antennas to which the flagging refers.By convention numAntenna== 0 means that the flag applies to all the existing antennas.

antennaId vector<Tag> numAntenna

 An array of Tag which refers to a collection of rows in the Antenna table. The flag applies to the antennas described in these rows. It is an error to have different elements with a same value in this array.

Value
(Optional)

numPolarizationType int  

  The number of polarization types , i.e. the size of the attribute polarizationType. By convention numPolarizationType == 0 means that the flag applies to all the defined polarization types.

numSpectralWindow int  

  The number of spectral windows. By convention numSpectralWindow == 0 means that the flag applies to all the existing spectral windows.

numPairedAntenna int  

  The number of antennas to be paired with to form the flagged baselines. By convention, numPairedAntenna == 0 means that the flag applies to all baselines built on the antennas declared in the attribute antennaId.

polarizationType vector<PolarizationTypeMod::PolarizationType > numPolarizationType

  An array of values of type PolarizationType. It specifies the polarization types where the flagging applies. It is an error to have different elements with a same value in this array.

pairedAntennaId vector<Tag> numPairedAntenna

  An array of Tag which refers to rows in the Antenna table. These rows contain the description of the antennas which are paired to form the flagged baselines. It is an error to have distinct elements with a same value in this array.

spectralWindowId vector<Tag> numSpectralWindow

  An array of Tag which refers to a collection of rows in the SpectralWindow table. The flag applies to the spectral windows described in these rows. It is an error to have different elements with a same value in this array.


Role
This table is used for flagging visibility data and is used in addition to the Binary Data Format flags produced by the correlator software.

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

Attributes of Flag
Name Type Expected shape

Comment

Key

flagId

Tag  

 identifies a unique row in the table.

Value
(Mandatory)

startTime ArrayTime  

 the start time of the flagging period.

endTime ArrayTime  

 the end time of the flagging period.

reason string  

 Extensible list of flagging conditions.

numAntenna int  

 The number of antennas to which the flagging refers.By convention numAntenna== 0 means that the flag applies to all the existing antennas.

antennaId vector<Tag> numAntenna

 An array of Tag which refers to a collection of rows in the Antenna table. The flag applies to the antennas described in these rows. It is an error to have different elements with a same value in this array.

Value
(Optional)

numPolarizationType int  

  The number of polarization types , i.e. the size of the attribute polarizationType. By convention numPolarizationType == 0 means that the flag applies to all the defined polarization types.

numSpectralWindow int  

  The number of spectral windows. By convention numSpectralWindow == 0 means that the flag applies to all the existing spectral windows.

numPairedAntenna int  

  The number of antennas to be paired with to form the flagged baselines. By convention, numPairedAntenna == 0 means that the flag applies to all baselines built on the antennas declared in the attribute antennaId.

polarizationType vector<PolarizationTypeMod::PolarizationType > numPolarizationType

  An array of values of type PolarizationType. It specifies the polarization types where the flagging applies. It is an error to have different elements with a same value in this array.

pairedAntennaId vector<Tag> numPairedAntenna

  An array of Tag which refers to rows in the Antenna table. These rows contain the description of the antennas which are paired to form the flagged baselines. It is an error to have distinct elements with a same value in this array.

spectralWindowId vector<Tag> numSpectralWindow

  An array of Tag which refers to a collection of rows in the SpectralWindow table. The flag applies to the spectral windows described in these rows. It is an error to have different elements with a same value in this array.

Definition at line 211 of file FlagTable.h.


Constructor & Destructor Documentation

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

Create a FlagTable.

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

Create a FlagTable.

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. If there table contains a row whose key's fields are equal to x's ones then return a pointer on this row (i.e. no actual insertion is performed) otherwise add x to the table and return x.

Parameters:
x. A pointer on the row to be added.
Returns:
a pointer to a FlagRow.

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

Add a row. If there table contains a row whose key's fields are equal to x's ones then return a pointer on this row (i.e. no actual insertion is performed) otherwise add x to the table and return x.

Parameters:
x. A pointer on the row to be added.
Returns:
a pointer to a FlagRow.

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

No uniqueness check is done !

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

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

No uniqueness check is done !

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

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

No uniqueness check is done !

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

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

No uniqueness check is done !

Parameters:
FlagRow*x a pointer onto the FlagRow to be appended.
void asdm::FlagTable::autoIncrement ( std::string  key,
FlagRow x 
) [private]
void asdm::FlagTable::autoIncrement ( std::string  key,
FlagRow x 
) [private]
FlagRow* asdm::FlagTable::checkAndAdd ( FlagRow 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
UniquenessViolationException

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

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

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

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

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

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

Exceptions:
ConversionException
std::vector<FlagRow *> asdm::FlagTable::get ( )

====> Methods returning rows.

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

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

====> Methods returning rows.

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

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

Return the names of the attributes of this table.

Returns:
a vector of string
static const std::vector<std::string>& asdm::FlagTable::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::FlagTable::getEntity ( ) const [virtual]

Return this table's Entity.

Implements asdm::Representable.

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

Return this table's Entity.

Implements asdm::Representable.

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

Returns a FlagRow* 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:
flagId

Returns a FlagRow* 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:
flagId
std::string asdm::FlagTable::getVersion ( ) const

Return the version information about this table.

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

Return the version information about this table.

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

A method to fill attributesNames and attributesNamesInBin;.

FlagRow* asdm::FlagTable::lookup ( ArrayTime  startTime,
ArrayTime  endTime,
string  reason,
int  numAntenna,
vector< Tag antennaId 
)

Look up the table for a row whose all attributes except the autoincrementable one are equal to the corresponding parameters of the method.

Returns:
a pointer on this row if any, null otherwise.
Parameters:
startTime
endTime
reason
numAntenna
antennaId
FlagRow* asdm::FlagTable::lookup ( ArrayTime  startTime,
ArrayTime  endTime,
string  reason,
int  numAntenna,
vector< Tag antennaId 
)

Look up the table for a row whose all attributes except the autoincrementable one are equal to the corresponding parameters of the method.

Returns:
a pointer on this row if any, null otherwise.
Parameters:
startTime
endTime
reason
numAntenna
antennaId

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::FlagTable::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::FlagTable::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 FlagRow

====> Row creation.

Create a new row with default values.

Returns:
a pointer on a FlagRow
FlagRow* asdm::FlagTable::newRow ( ArrayTime  startTime,
ArrayTime  endTime,
string  reason,
int  numAntenna,
vector< Tag antennaId 
)

Create a new row initialized to the specified values.

Returns:
a pointer on the created and initialized row.
Parameters:
startTime
endTime
reason
numAntenna
antennaId
FlagRow* asdm::FlagTable::newRow ( ArrayTime  startTime,
ArrayTime  endTime,
string  reason,
int  numAntenna,
vector< Tag antennaId 
)

Create a new row initialized to the specified values.

Returns:
a pointer on the created and initialized row.
Parameters:
startTime
endTime
reason
numAntenna
antennaId

Create a new row using a copy constructor mechanism.

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

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

Set this table's Entity.

Parameters:
eAn entity.

Implements asdm::Representable.

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

Set this table's Entity.

Parameters:
eAn entity.

Implements asdm::Representable.

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

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

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

void asdm::FlagTable::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 Flag table.

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

Conversion Methods.

Convert this table into a FlagTableIDL CORBA structure.

Returns:
a pointer to a FlagTableIDL
asdmIDL::FlagTableIDL* asdm::FlagTable::toIDL ( )

Conversion Methods.

Convert this table into a FlagTableIDL CORBA structure.

Returns:
a pointer to a FlagTableIDL
void asdm::FlagTable::toIDL ( asdmIDL::FlagTableIDL &  x) const

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

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

Produces an XML representation conform to the schema defined for Flag (FlagTable.xsd).

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

Implements asdm::Representable.

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

Produces an XML representation conform to the schema defined for Flag (FlagTable.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 212 of file FlagTable.h.


Member Data Documentation

Definition at line 468 of file FlagTable.h.

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

The attributes names.

Definition at line 477 of file FlagTable.h.

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

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

Definition at line 482 of file FlagTable.h.

Definition at line 466 of file FlagTable.h.

Definition at line 473 of file FlagTable.h.

Definition at line 469 of file FlagTable.h.

Definition at line 488 of file FlagTable.h.

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

The name of this table.

Definition at line 472 of file FlagTable.h.

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

The list of field names that make up key key.

Definition at line 494 of file FlagTable.h.

Load the table in memory if necessary.

Reimplemented from asdm::Representable.

Definition at line 580 of file FlagTable.h.

Referenced by checkPresenceInMemory().

std::map< std::string, int > asdm::FlagTable::noAutoIncIds [private]

A map for the autoincrementation algorithm.

Definition at line 477 of file FlagTable.h.

std::vector< FlagRow * > asdm::FlagTable::privateRows [private]

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

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

Definition at line 513 of file FlagTable.h.

std::vector< FlagRow * > asdm::FlagTable::row [private]

Definition at line 517 of file FlagTable.h.

Definition at line 531 of file FlagTable.h.

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

Definition at line 471 of file FlagTable.h.


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