asdm::AnnotationTable Class Reference

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

#include <AnnotationTable.h>

Inheritance diagram for asdm::AnnotationTable:

Public Member Functions
virtual	~AnnotationTable ()
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 Annotation (AnnotationTable.xsd).
asdmIDL::AnnotationTableIDL *	toIDL ()
	Conversion Methods.
void	toIDL (asdmIDL::AnnotationTableIDL &x) const
	Fills the CORBA data structure passed in parameter with the content of this table.
void	fromIDL (asdmIDL::AnnotationTableIDL x)
	Populate this table from the content of a AnnotationTableIDL Corba structure.
AnnotationRow *	newRow ()
	====> Row creation.
AnnotationRow *	newRow (ArrayTime time, string issue, string details)
	Create a new row initialized to the specified values.
AnnotationRow *	newRow (AnnotationRow *row)
	Create a new row using a copy constructor mechanism.
AnnotationRow *	add (AnnotationRow *x)
	====> Append a row to its table.
std::vector< AnnotationRow * >	get ()
	====> Methods returning rows.
const std::vector < AnnotationRow * > &	get () const
	Get a const reference on the collection of rows pointers internally hold by the table.
AnnotationRow *	getRowByKey (Tag annotationId)
	Returns a AnnotationRow* given a key.
AnnotationRow *	lookup (ArrayTime time, string issue, string details)
	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)
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.
Private Member Functions
	AnnotationTable (ASDM &container)
	Create a AnnotationTable.
void	autoIncrement (std::string key, AnnotationRow *x)
AnnotationRow *	checkAndAdd (AnnotationRow *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 (AnnotationRow *x)
	Brutally append an AnnotationRow x to the collection of rows already stored in this table.
void	addWithoutCheckingUnique (AnnotationRow *x)
	Brutally append an AnnotationRow 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 Annotation (AnnotationTable.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 Annotation 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 AnnotationTable as those produced by the toFile method.
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< AnnotationRow * >	privateRows
	A data structure to store the pointers on the table's rows.
std::vector< AnnotationRow * >	row
std::map< std::string, BinaryAttributeReaderFunctor * >	unknownAttributes2Functors
bool	loadInProgress
	Load the table in memory if necessary.
Friends
class	ASDM

Detailed Description

The AnnotationTable class is an Alma table.

Role: The Annotation Table is intended to offer space for unexpected data to be added in the software development process at short notice, without redefining the data model.

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

Attributes of Annotation
Name	Type	Expected shape	Comment
Key
annotationId	Tag		identifies a unique row in the table.
Value (Mandatory)
time	ArrayTime		mid point of the interval of time on which the recorded information is pertinent.
issue	string		name of this annotation.
details	string		details of this annotation.
Value (Optional)
numAntenna	int		number of antennas.
basebandName	vector<BasebandNameMod::BasebandName >	numBaseband	an array of numBaseband baseband names.
numBaseband	int		number of basebands.
interval	Interval		time interval
dValue	double		scalar data.
vdValue	vector<double >		useful to store an array of double values.
vvdValues	vector<vector<double > >	,	useful to store an array of array(s) of double values.
llValue	int64_t		useful to record a long long data.
vllValue	vector<int64_t >		useful to store an array of array(s) of long long values.
vvllValue	vector<vector<int64_t > >	,	useful to store an array of array(s) long long values.
antennaId	vector<Tag>	numAntenna	refers to a collection of rows in the AntennaTable.

Definition at line 246 of file AnnotationTable.h.

Constructor & Destructor Documentation

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

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

Create a AnnotationTable.

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

AnnotationRow* asdm::AnnotationTable::add ( AnnotationRow * 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 AnnotationRow.

void asdm::AnnotationTable::addWithoutCheckingUnique ( AnnotationRow * x ) [private]

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

No uniqueness check is done !

Parameters:

AnnotationRow*

x a pointer onto the AnnotationRow to be appended.

void asdm::AnnotationTable::append ( AnnotationRow * x ) [private]

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

No uniqueness check is done !

Parameters:

AnnotationRow*

x a pointer onto the AnnotationRow to be appended.

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

AnnotationRow* asdm::AnnotationTable::checkAndAdd	(	AnnotationRow *	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

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

Definition at line 608 of file AnnotationTable.h.

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

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

void asdm::AnnotationTable::fromIDL ( asdmIDL::AnnotationTableIDL x )

Populate this table from the content of a AnnotationTableIDL 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::AnnotationTable::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 Annotation (AnnotationTable.xsd).

Exceptions:

ConversionException

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

std::vector<AnnotationRow *> asdm::AnnotationTable::get ( )

====> Methods returning rows.

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

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

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

Return the names of the attributes of this table.

Returns:: a vector of string

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

Return the container to which this table belongs.

Returns:: the ASDM containing this table.

Referenced by checkPresenceInMemory().

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

Return this table's Entity.

Implements asdm::Representable.

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

AnnotationRow* asdm::AnnotationTable::getRowByKey ( Tag annotationId )

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

annotationId

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

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

Return the version information about this table.

AnnotationRow* asdm::AnnotationTable::lookup	(	ArrayTime	time,
		string	issue,
		string	details
	)

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:

	time
	issue
	details

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

AnnotationRow* asdm::AnnotationTable::newRow ( AnnotationRow * row )

Create a new row using a copy constructor mechanism.

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

Parameters:

row

the row which is to be copied.

AnnotationRow* asdm::AnnotationTable::newRow	(	ArrayTime	time,
		string	issue,
		string	details
	)

Create a new row initialized to the specified values.

Returns:: a pointer on the created and initialized row.

Parameters:

	time
	issue
	details

AnnotationRow* asdm::AnnotationTable::newRow ( )

====> Row creation.

Create a new row with default values.

Returns:: a pointer on a AnnotationRow

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

Set this table's Entity.

Parameters:

e

An entity.

Implements asdm::Representable.

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

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

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

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

unsigned int asdm::AnnotationTable::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::AnnotationTable::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 "Annotation.bin" or an XML representation (fileAsBin==false) will be saved in a file "Annotation.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::AnnotationTable::toIDL ( asdmIDL::AnnotationTableIDL & x ) const

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

Parameters:

x

a reference to the asdmIDL::AnnotationTableIDL to be populated with the content of this.

asdmIDL::AnnotationTableIDL* asdm::AnnotationTable::toIDL ( )

Conversion Methods.

Convert this table into a AnnotationTableIDL CORBA structure.