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

#include <ObservationTable.h>

Inheritance diagram for asdm::ObservationTable:

Public Member Functions
virtual	~ObservationTable ()
ASDM &	getContainer () 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 Observation (ObservationTable.xsd).
asdmIDL::ObservationTableIDL *	toIDL ()
	Conversion Methods.
void	toIDL (asdmIDL::ObservationTableIDL &x) const
	Fills the CORBA data structure passed in parameter with the content of this table.
void	fromIDL (asdmIDL::ObservationTableIDL x)
	Populate this table from the content of a ObservationTableIDL Corba structure.
ObservationRow *	newRow ()
	====> Row creation.
ObservationRow *	newRow (ObservationRow *row)
	Create a new row using a copy constructor mechanism.
ObservationRow *	add (ObservationRow *x)
	====> Append a row to its table.
std::vector< ObservationRow * >	get ()
	====> Methods returning rows.
const std::vector < ObservationRow * > &	get () const
	Get a const reference on the collection of rows pointers internally hold by the table.
ObservationRow *	getRowByKey (Tag observationId)
	Returns a ObservationRow* given a key.
void	setUnknownAttributeBinaryReader (const std::string &attributeName, BinaryAttributeReaderFunctor *barFctr)
BinaryAttributeReaderFunctor *	getUnknownAttributeBinaryReader (const std::string &attributeName) const
virtual	~ObservationTable ()
ASDM &	getContainer () 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 Observation (ObservationTable.xsd).
asdmIDL::ObservationTableIDL *	toIDL ()
	Conversion Methods.
void	fromIDL (asdmIDL::ObservationTableIDL x)
	Populate this table from the content of a ObservationTableIDL Corba structure.
ObservationRow *	newRow ()
	====> Row creation.
ObservationRow *	newRow (ObservationRow *row)
	Create a new row using a copy constructor mechanism.
ObservationRow *	add (ObservationRow *x)
	====> Append a row to its table.
std::vector< ObservationRow * >	get ()
	====> Methods returning rows.
const std::vector < ObservationRow * > &	get () const
	Get a const reference on the collection of rows pointers internally hold by the table.
ObservationRow *	getRowByKey (Tag observationId)
	Returns a ObservationRow* given a key.
void	setUnknownAttributeBinaryReader (const std::string &attributeName, BinaryAttributeReaderFunctor *barFctr)
BinaryAttributeReaderFunctor *	getUnknownAttributeBinaryReader (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
	ObservationTable (ASDM &container)
	Create a ObservationTable.
void	autoIncrement (std::string key, ObservationRow *x)
ObservationRow *	checkAndAdd (ObservationRow *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 (ObservationRow *x)
	Brutally append an ObservationRow x to the collection of rows already stored in this table.
void	addWithoutCheckingUnique (ObservationRow *x)
	Brutally append an ObservationRow 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 Observation (ObservationTable.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 Observation 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 ObservationTable as those produced by the toFile method.
	ObservationTable (ASDM &container)
	Create a ObservationTable.
void	autoIncrement (std::string key, ObservationRow *x)
ObservationRow *	checkAndAdd (ObservationRow *x)
	If this table has an autoincrementable attribute then check if *x verifies the rule of uniqueness and throw exception if not.
void	append (ObservationRow *x)
	Brutally append an ObservationRow x to the collection of rows already stored in this table.
void	addWithoutCheckingUnique (ObservationRow *x)
	Brutally append an ObservationRow 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 Observation (ObservationTable.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 Observation 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 ObservationTable as those produced by the toFile method.
Static Private Member Functions
static bool	initAttributesNames ()
	A method to fill attributesNames and attributesNamesInBin;.
Private Attributes
ASDM &	container
bool	archiveAsBin
bool	fileAsBin
std::string	version
Entity	entity
std::map< std::string, int >	noAutoIncIds
	A map for the autoincrementation algorithm.
std::vector< ObservationRow * >	privateRows
	A data structure to store the pointers on the table's rows.
std::vector< ObservationRow * >	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 ObservationTable class is an Alma table.

Role: At the present time, this table is not defined. In the AEDF document, it's name is Observation_Unit.

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

Attributes of Observation
Name	Type	Expected shape	Comment
Key
observationId	Tag

Role: At the present time, this table is not defined. In the AEDF document, it's name is Observation_Unit.

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

Attributes of Observation
Name	Type	Expected shape	Comment
Key
observationId	Tag

Definition at line 106 of file ObservationTable.h.

Constructor & Destructor Documentation

virtual asdm::ObservationTable::~ObservationTable ( ) [virtual]

asdm::ObservationTable::ObservationTable ( ASDM & container ) [private]

Create a ObservationTable.

This constructor is private because only the container can create tables. All tables must know the container to which they belong.

Parameters:

container The container to which this table belongs.

virtual asdm::ObservationTable::~ObservationTable ( ) [virtual]

asdm::ObservationTable::ObservationTable ( ASDM & container ) [private]

Create a ObservationTable.

This constructor is private because only the container can create tables. All tables must know the container to which they belong.

Parameters:

container The container to which this table belongs.

Member Function Documentation

ObservationRow* asdm::ObservationTable::add ( ObservationRow * x )

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

ObservationRow* asdm::ObservationTable::add ( ObservationRow * x )

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

void asdm::ObservationTable::addWithoutCheckingUnique ( ObservationRow * x ) [private]

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

No uniqueness check is done !

Parameters:

ObservationRow* x a pointer onto the ObservationRow to be appended.

void asdm::ObservationTable::addWithoutCheckingUnique ( ObservationRow * x ) [private]

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

No uniqueness check is done !

Parameters:

ObservationRow* x a pointer onto the ObservationRow to be appended.

void asdm::ObservationTable::append ( ObservationRow * x ) [private]

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

No uniqueness check is done !

Parameters:

ObservationRow* x a pointer onto the ObservationRow to be appended.

void asdm::ObservationTable::append ( ObservationRow * x ) [private]

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

No uniqueness check is done !

Parameters:

ObservationRow* x a pointer onto the ObservationRow to be appended.

void asdm::ObservationTable::autoIncrement	(	std::string	key,
		ObservationRow *	x
	)		`[private]`

void asdm::ObservationTable::autoIncrement	(	std::string	key,
		ObservationRow *	x
	)		`[private]`

ObservationRow* asdm::ObservationTable::checkAndAdd	(	ObservationRow *	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

ObservationRow* asdm::ObservationTable::checkAndAdd ( ObservationRow * x ) [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

void asdm::ObservationTable::checkPresenceInMemory ( ) [inline, private]

Definition at line 439 of file ObservationTable.h.

References getContainer(), loadInProgress, asdm::Representable::presentInMemory, and setFromFile().

void asdm::ObservationTable::checkPresenceInMemory ( ) [inline, private]

Definition at line 455 of file ObservationTable.h.

References getContainer(), loadInProgress, asdm::Representable::presentInMemory, and setFromFile().

static const std::vector<std::string>& asdm::ObservationTable::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::ObservationTable::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::ObservationTable::error ( ) [private]

void asdm::ObservationTable::fromIDL ( asdmIDL::ObservationTableIDL x )

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

Exceptions:

DuplicateKey	Thrown if the method tries to add a row having a key that is already in the table.
ConversionException

void asdm::ObservationTable::fromIDL ( asdmIDL::ObservationTableIDL x )

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

Exceptions:

DuplicateKey	Thrown if the method tries to add a row having a key that is already in the table.
ConversionException

void asdm::ObservationTable::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 Observation (ObservationTable.xsd).

Exceptions:

ConversionException

void asdm::ObservationTable::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 Observation (ObservationTable.xsd).

Exceptions:

ConversionException

std::vector<ObservationRow *> asdm::ObservationTable::get ( )

====> Methods returning rows.

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

Returns:: Alls rows in a vector of pointers of ObservationRow. The elements of this vector are stored in the order in which they have been added to the ObservationTable.

const std::vector<ObservationRow *>& asdm::ObservationTable::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 ObservationRow. The elements of this vector are stored in the order in which they have been added to the ObservationTable.

std::vector<ObservationRow *> asdm::ObservationTable::get ( )

====> Methods returning rows.

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

Returns:: Alls rows in a vector of pointers of ObservationRow. The elements of this vector are stored in the order in which they have been added to the ObservationTable.

const std::vector<ObservationRow *>& asdm::ObservationTable::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 ObservationRow. The elements of this vector are stored in the order in which they have been added to the ObservationTable.

static const std::vector<std::string>& asdm::ObservationTable::getAttributesNames ( ) [static]

Return the names of the attributes of this table.

Returns:: a vector of string

static const std::vector<std::string>& asdm::ObservationTable::getAttributesNames ( ) [static]

Return the names of the attributes of this table.

Returns:: a vector of string

ASDM& asdm::ObservationTable::getContainer ( ) const

Return the container to which this table belongs.

Returns:: the ASDM containing this table.

ASDM& asdm::ObservationTable::getContainer ( ) const

Return the container to which this table belongs.

Returns:: the ASDM containing this table.

Referenced by checkPresenceInMemory().

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

Return this table's Entity.

Implements asdm::Representable.

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

Return this table's Entity.

Implements asdm::Representable.

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

ObservationRow* asdm::ObservationTable::getRowByKey ( Tag observationId )

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

observationId

ObservationRow* asdm::ObservationTable::getRowByKey ( Tag observationId )

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

observationId

BinaryAttributeReaderFunctor* asdm::ObservationTable::getUnknownAttributeBinaryReader ( const std::string & attributeName ) const

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

Return the version information about this table.

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

Return the version information about this table.

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

A method to fill attributesNames and attributesNamesInBin;.

std::string asdm::ObservationTable::MIMEXMLPart ( const asdm::ByteOrder * byteOrder = asdm::ByteOrder::Machine_Endianity ) [private]

Private methods involved during the export of this table into disk file(s).

std::string asdm::ObservationTable::MIMEXMLPart ( const asdm::ByteOrder * byteOrder = asdm::ByteOrder::Machine_Endianity ) [private]

Private methods involved during the export of this table into disk file(s).

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

ObservationRow* asdm::ObservationTable::newRow ( )

====> Row creation.

Create a new row with default values.

Returns:: a pointer on a ObservationRow

ObservationRow* asdm::ObservationTable::newRow ( )

====> Row creation.

Create a new row with default values.

Returns:: a pointer on a ObservationRow

ObservationRow* asdm::ObservationTable::newRow ( ObservationRow * row )

Create a new row using a copy constructor mechanism.

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

Parameters:

row	the row which is to be copied.

ObservationRow* asdm::ObservationTable::newRow ( ObservationRow * row )

Create a new row using a copy constructor mechanism.

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

Parameters:

row	the row which is to be copied.

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

Set this table's Entity.

Parameters:

e	An entity.

Implements asdm::Representable.

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

Set this table's Entity.

Parameters:

e	An entity.

Implements asdm::Representable.

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

Reads and parses a file containing a representation of a ObservationTable as those produced by the toFile method.

This table is populated with the result of the parsing.

Parameters:

directory The name of the directory containing the file te be read and parsed.

Exceptions:

ConversionException If any error occurs while reading the files in the directory or parsing them.

Referenced by checkPresenceInMemory().

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

Reads and parses a file containing a representation of a ObservationTable as those produced by the toFile method.

This table is populated with the result of the parsing.

Parameters:

directory The name of the directory containing the file te be read and parsed.

Exceptions:

ConversionException If any error occurs while reading the files in the directory or parsing them.

void asdm::ObservationTable::setFromMIME ( const std::string & mimeMsg ) [private]

Extracts the binary part of a MIME message and deserialize its content to fill this with the result of the deserialization.

Parameters:

mimeMsg the string containing the MIME message.

Exceptions:

ConversionException

void asdm::ObservationTable::setFromMIME ( const std::string & mimeMsg ) [private]

Extracts the binary part of a MIME message and deserialize its content to fill this with the result of the deserialization.

Parameters:

mimeMsg the string containing the MIME message.

Exceptions:

ConversionException

void asdm::ObservationTable::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 Observation table.

void asdm::ObservationTable::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 Observation table.

void asdm::ObservationTable::setFromXMLFile ( const std::string & directory ) [private]

void asdm::ObservationTable::setUnknownAttributeBinaryReader	(	const std::string &	attributeName,
		BinaryAttributeReaderFunctor *	barFctr
	)

void asdm::ObservationTable::setUnknownAttributeBinaryReader	(	const std::string &	attributeName,
		BinaryAttributeReaderFunctor *	barFctr
	)

unsigned int asdm::ObservationTable::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::ObservationTable::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::ObservationTable::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 "Observation.bin" or an XML representation (fileAsBin==false) will be saved in a file "Observation.xml". The file is always written in a directory whose name is passed as a parameter.

Parameters:

directory The name of directory where the file containing the table's representation will be saved.

void asdm::ObservationTable::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 "Observation.bin" or an XML representation (fileAsBin==false) will be saved in a file "Observation.xml". The file is always written in a directory whose name is passed as a parameter.

Parameters:

directory The name of directory where the file containing the table's representation will be saved.

asdmIDL::ObservationTableIDL* asdm::ObservationTable::toIDL ( )

Conversion Methods.

Convert this table into a ObservationTableIDL CORBA structure.