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

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

#include <FieldTable.h>

Inheritance diagram for asdm::FieldTable:
asdm::Representable asdm::Representable

List of all members.

Public Member Functions

virtual ~FieldTable ()
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 Field (FieldTable.xsd).
asdmIDL::FieldTableIDL * toIDL ()
 Conversion Methods.
void toIDL (asdmIDL::FieldTableIDL &x) const
 Fills the CORBA data structure passed in parameter with the content of this table.
void fromIDL (asdmIDL::FieldTableIDL x)
 Populate this table from the content of a FieldTableIDL Corba structure.
FieldRownewRow ()
 ====> Row creation.
FieldRownewRow (string fieldName, int numPoly, vector< vector< Angle > > delayDir, vector< vector< Angle > > phaseDir, vector< vector< Angle > > referenceDir)
 Create a new row initialized to the specified values.
FieldRownewRow (FieldRow *row)
 Create a new row using a copy constructor mechanism.
FieldRowadd (FieldRow *x)
 ====> Append a row to its table.
std::vector< FieldRow * > get ()
 ====> Methods returning rows.
const std::vector< FieldRow * > & get () const
 Get a const reference on the collection of rows pointers internally hold by the table.
FieldRowgetRowByKey (Tag fieldId)
 Returns a FieldRow* given a key.
FieldRowlookup (string fieldName, int numPoly, vector< vector< Angle > > delayDir, vector< vector< Angle > > phaseDir, vector< vector< Angle > > referenceDir)
 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 ~FieldTable ()
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 Field (FieldTable.xsd).
asdmIDL::FieldTableIDL * toIDL ()
 Conversion Methods.
void fromIDL (asdmIDL::FieldTableIDL x)
 Populate this table from the content of a FieldTableIDL Corba structure.
FieldRownewRow ()
 ====> Row creation.
FieldRownewRow (string fieldName, int numPoly, vector< vector< Angle > > delayDir, vector< vector< Angle > > phaseDir, vector< vector< Angle > > referenceDir)
 Create a new row initialized to the specified values.
FieldRownewRow (FieldRow *row)
 Create a new row using a copy constructor mechanism.
FieldRowadd (FieldRow *x)
 ====> Append a row to its table.
std::vector< FieldRow * > get ()
 ====> Methods returning rows.
const std::vector< FieldRow * > & get () const
 Get a const reference on the collection of rows pointers internally hold by the table.
FieldRowgetRowByKey (Tag fieldId)
 Returns a FieldRow* given a key.
FieldRowlookup (string fieldName, int numPoly, vector< vector< Angle > > delayDir, vector< vector< Angle > > phaseDir, vector< vector< Angle > > referenceDir)
 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

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


Role
The field position for each source.

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

Attributes of Field
Name Type Expected shape

Comment

Key

fieldId

Tag  

 identifies a unique row in the table.

Value
(Mandatory)

fieldName string  

 the name of the field.

numPoly int  

 number of coefficients of the polynomials.

delayDir vector<vector<Angle > > numPoly, 2

 the delay tracking direction.

phaseDir vector<vector<Angle > > numPoly, 2

 the phase tracking direction.

referenceDir vector<vector<Angle > > numPoly, 2

 the reference direction.

Value
(Optional)

time ArrayTime  

  value used as the origin for the polynomials.

code string  

  describes the function of the field.

directionCode DirectionReferenceCodeMod::DirectionReferenceCode  

  the direction reference code of the field.

directionEquinox ArrayTime  

  the direction reference equinox of the field.

assocNature string  

  identifies the nature of the association with the row refered to by fieldId.

ephemerisId Tag  

  refers to a unique row in EphemerisTable.

sourceId int  

  refers to a collection of rows in SourceTable.

assocFieldId Tag  

  Associated Field ID


Role
The field position for each source.

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

Attributes of Field
Name Type Expected shape

Comment

Key

fieldId

Tag  

 identifies a unique row in the table.

Value
(Mandatory)

fieldName string  

 the name of the field.

numPoly int  

 number of coefficients of the polynomials.

delayDir vector<vector<Angle > > numPoly, 2

 the delay tracking direction.

phaseDir vector<vector<Angle > > numPoly, 2

 the phase tracking direction.

referenceDir vector<vector<Angle > > numPoly, 2

 the reference direction.

Value
(Optional)

time ArrayTime  

  value used as the origin for the polynomials.

code string  

  describes the function of the field.

directionCode DirectionReferenceCodeMod::DirectionReferenceCode  

  the direction reference code of the field.

directionEquinox ArrayTime  

  the direction reference equinox of the field.

assocNature string  

  identifies the nature of the association with the row refered to by fieldId.

ephemerisId Tag  

  refers to a unique row in EphemerisTable.

sourceId int  

  refers to a collection of rows in SourceTable.

assocFieldId Tag  

  Associated Field ID

Definition at line 233 of file FieldTable.h.


Constructor & Destructor Documentation

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

Create a FieldTable.

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

Create a FieldTable.

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 FieldRow.

====> 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 FieldRow.

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

No uniqueness check is done !

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

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

No uniqueness check is done !

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

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

No uniqueness check is done !

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

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

No uniqueness check is done !

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

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

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

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

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

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

Exceptions:
ConversionException
std::vector<FieldRow *> asdm::FieldTable::get ( )

====> Methods returning rows.

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

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

====> Methods returning rows.

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

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

Return the names of the attributes of this table.

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

Return this table's Entity.

Implements asdm::Representable.

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

Return this table's Entity.

Implements asdm::Representable.

static std::vector<std::string> asdm::FieldTable::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::FieldTable::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::FieldTable::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::FieldTable::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 FieldRow* 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:
fieldId

Returns a FieldRow* 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:
fieldId
std::string asdm::FieldTable::getVersion ( ) const

Return the version information about this table.

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

Return the version information about this table.

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

A method to fill attributesNames and attributesNamesInBin;.

FieldRow* asdm::FieldTable::lookup ( string  fieldName,
int  numPoly,
vector< vector< Angle > >  delayDir,
vector< vector< Angle > >  phaseDir,
vector< vector< Angle > >  referenceDir 
)

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:
fieldName
numPoly
delayDir
phaseDir
referenceDir
FieldRow* asdm::FieldTable::lookup ( string  fieldName,
int  numPoly,
vector< vector< Angle > >  delayDir,
vector< vector< Angle > >  phaseDir,
vector< vector< Angle > >  referenceDir 
)

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:
fieldName
numPoly
delayDir
phaseDir
referenceDir

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::FieldTable::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::FieldTable::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 FieldRow

====> Row creation.

Create a new row with default values.

Returns:
a pointer on a FieldRow
FieldRow* asdm::FieldTable::newRow ( string  fieldName,
int  numPoly,
vector< vector< Angle > >  delayDir,
vector< vector< Angle > >  phaseDir,
vector< vector< Angle > >  referenceDir 
)

Create a new row initialized to the specified values.

Returns:
a pointer on the created and initialized row.
Parameters:
fieldName
numPoly
delayDir
phaseDir
referenceDir
FieldRow* asdm::FieldTable::newRow ( string  fieldName,
int  numPoly,
vector< vector< Angle > >  delayDir,
vector< vector< Angle > >  phaseDir,
vector< vector< Angle > >  referenceDir 
)

Create a new row initialized to the specified values.

Returns:
a pointer on the created and initialized row.
Parameters:
fieldName
numPoly
delayDir
phaseDir
referenceDir

Create a new row using a copy constructor mechanism.

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

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

Set this table's Entity.

Parameters:
eAn entity.

Implements asdm::Representable.

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

Set this table's Entity.

Parameters:
eAn entity.

Implements asdm::Representable.

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

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

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

void asdm::FieldTable::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 Field table.

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

Conversion Methods.

Convert this table into a FieldTableIDL CORBA structure.

Returns:
a pointer to a FieldTableIDL
asdmIDL::FieldTableIDL* asdm::FieldTable::toIDL ( )

Conversion Methods.

Convert this table into a FieldTableIDL CORBA structure.

Returns:
a pointer to a FieldTableIDL
void asdm::FieldTable::toIDL ( asdmIDL::FieldTableIDL &  x) const

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

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

Produces an XML representation conform to the schema defined for Field (FieldTable.xsd).

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

Implements asdm::Representable.

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

Produces an XML representation conform to the schema defined for Field (FieldTable.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 234 of file FieldTable.h.


Member Data Documentation

Definition at line 490 of file FieldTable.h.

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

The attributes names.

Definition at line 499 of file FieldTable.h.

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

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

Definition at line 504 of file FieldTable.h.

Definition at line 488 of file FieldTable.h.

Definition at line 495 of file FieldTable.h.

Definition at line 491 of file FieldTable.h.

Definition at line 510 of file FieldTable.h.

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

The name of this table.

Definition at line 494 of file FieldTable.h.

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

The list of field names that make up key key.

Definition at line 516 of file FieldTable.h.

Load the table in memory if necessary.

Reimplemented from asdm::Representable.

Definition at line 602 of file FieldTable.h.

Referenced by checkPresenceInMemory().

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

A map for the autoincrementation algorithm.

Definition at line 499 of file FieldTable.h.

std::vector< FieldRow * > asdm::FieldTable::privateRows [private]

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

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

Definition at line 535 of file FieldTable.h.

std::vector< FieldRow * > asdm::FieldTable::row [private]

Definition at line 539 of file FieldTable.h.

Definition at line 553 of file FieldTable.h.

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

Definition at line 493 of file FieldTable.h.


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