asdm::SBSummaryTable Class Reference

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

#include <SBSummaryTable.h>

Inheritance diagram for asdm::SBSummaryTable:

Public Member Functions
virtual	~SBSummaryTable ()
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 SBSummary (SBSummaryTable.xsd).
asdmIDL::SBSummaryTableIDL *	toIDL ()
	Conversion Methods.
void	toIDL (asdmIDL::SBSummaryTableIDL &x) const
	Fills the CORBA data structure passed in parameter with the content of this table.
void	fromIDL (asdmIDL::SBSummaryTableIDL x)
	Populate this table from the content of a SBSummaryTableIDL Corba structure.
SBSummaryRow *	newRow ()
	====> Row creation.
SBSummaryRow *	newRow (EntityRef sbSummaryUID, EntityRef projectUID, EntityRef obsUnitSetUID, double frequency, ReceiverBandMod::ReceiverBand frequencyBand, SBTypeMod::SBType sbType, Interval sbDuration, int numObservingMode, vector< string > observingMode, int numberRepeats, int numScienceGoal, vector< string > scienceGoal, int numWeatherConstraint, vector< string > weatherConstraint)
	Create a new row initialized to the specified values.
SBSummaryRow *	newRow (SBSummaryRow *row)
	Create a new row using a copy constructor mechanism.
SBSummaryRow *	add (SBSummaryRow *x)
	====> Append a row to its table.
std::vector< SBSummaryRow * >	get ()
	====> Methods returning rows.
const std::vector < SBSummaryRow * > &	get () const
	Get a const reference on the collection of rows pointers internally hold by the table.
SBSummaryRow *	getRowByKey (Tag sBSummaryId)
	Returns a SBSummaryRow* given a key.
SBSummaryRow *	lookup (EntityRef sbSummaryUID, EntityRef projectUID, EntityRef obsUnitSetUID, double frequency, ReceiverBandMod::ReceiverBand frequencyBand, SBTypeMod::SBType sbType, Interval sbDuration, int numObservingMode, vector< string > observingMode, int numberRepeats, int numScienceGoal, vector< string > scienceGoal, int numWeatherConstraint, vector< string > weatherConstraint)
	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
	SBSummaryTable (ASDM &container)
	Create a SBSummaryTable.
void	autoIncrement (std::string key, SBSummaryRow *x)
SBSummaryRow *	checkAndAdd (SBSummaryRow *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 (SBSummaryRow *x)
	Brutally append an SBSummaryRow x to the collection of rows already stored in this table.
void	addWithoutCheckingUnique (SBSummaryRow *x)
	Brutally append an SBSummaryRow 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 SBSummary (SBSummaryTable.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 SBSummary 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 SBSummaryTable 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< SBSummaryRow * >	privateRows
	A data structure to store the pointers on the table's rows.
std::vector< SBSummaryRow * >	row
std::map< std::string, BinaryAttributeReaderFunctor * >	unknownAttributes2Functors
bool	loadInProgress
	Load the table in memory if necessary.
Friends
class	ASDM

Detailed Description

The SBSummaryTable class is an Alma table.

Role: Characteristics of the Scheduling Block that has been executed. Much of the data here is reproduced from the Scheduling block itself.

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

Attributes of SBSummary
Name	Type	Expected shape	Comment
Key
sBSummaryId	Tag		refers to a unique row in the table.
Value (Mandatory)
sbSummaryUID	EntityRef		the scheduling block archive's UID.
projectUID	EntityRef		the projet archive's UID.
obsUnitSetUID	EntityRef		the observing unit set archive's UID.
frequency	double		a representative frequency.
frequencyBand	ReceiverBandMod::ReceiverBand		the frequency band.
sbType	SBTypeMod::SBType		the type of scheduling block.
sbDuration	Interval		the duration of the scheduling block.
numObservingMode	int		the number of observing modes.
observingMode	vector<string >	numObservingMode	the observing modes.
numberRepeats	int		the number of repeats.
numScienceGoal	int		the number of scientific goals.
scienceGoal	vector<string >	numScienceGoal	the scientific goals.
numWeatherConstraint	int		the number of weather constraints.
weatherConstraint	vector<string >	numWeatherConstraint	the weather constraints.
Value (Optional)
centerDirection	vector<Angle >	2	the representative target direction.
centerDirectionCode	DirectionReferenceCodeMod::DirectionReferenceCode		identifies the direction reference frame associated with centerDirection.
centerDirectionEquinox	ArrayTime		the equinox associated to centerDirectionReferenceCode (if needed).

Definition at line 287 of file SBSummaryTable.h.

Constructor & Destructor Documentation

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

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

Create a SBSummaryTable.

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

SBSummaryRow* asdm::SBSummaryTable::add ( SBSummaryRow * 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 SBSummaryRow.

void asdm::SBSummaryTable::addWithoutCheckingUnique ( SBSummaryRow * x ) [private]

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

No uniqueness check is done !

Parameters:

SBSummaryRow*

x a pointer onto the SBSummaryRow to be appended.

void asdm::SBSummaryTable::append ( SBSummaryRow * x ) [private]

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

No uniqueness check is done !

Parameters:

SBSummaryRow*

x a pointer onto the SBSummaryRow to be appended.

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

SBSummaryRow* asdm::SBSummaryTable::checkAndAdd	(	SBSummaryRow *	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::SBSummaryTable::checkPresenceInMemory ( ) [inline, private]

Definition at line 693 of file SBSummaryTable.h.

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

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

void asdm::SBSummaryTable::fromIDL ( asdmIDL::SBSummaryTableIDL x )

Populate this table from the content of a SBSummaryTableIDL 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::SBSummaryTable::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 SBSummary (SBSummaryTable.xsd).

Exceptions:

ConversionException

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

std::vector<SBSummaryRow *> asdm::SBSummaryTable::get ( )

====> Methods returning rows.

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

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

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

Return the names of the attributes of this table.

Returns:: a vector of string

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

Return the container to which this table belongs.

Returns:: the ASDM containing this table.

Referenced by checkPresenceInMemory().

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

Return this table's Entity.

Implements asdm::Representable.

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

SBSummaryRow* asdm::SBSummaryTable::getRowByKey ( Tag sBSummaryId )

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

sBSummaryId

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

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

Return the version information about this table.

SBSummaryRow* asdm::SBSummaryTable::lookup	(	EntityRef	sbSummaryUID,
		EntityRef	projectUID,
		EntityRef	obsUnitSetUID,
		double	frequency,
		ReceiverBandMod::ReceiverBand	frequencyBand,
		SBTypeMod::SBType	sbType,
		Interval	sbDuration,
		int	numObservingMode,
		vector< string >	observingMode,
		int	numberRepeats,
		int	numScienceGoal,
		vector< string >	scienceGoal,
		int	numWeatherConstraint,
		vector< string >	weatherConstraint
	)

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:

	sbSummaryUID
	projectUID
	obsUnitSetUID
	frequency
	frequencyBand
	sbType
	sbDuration
	numObservingMode
	observingMode
	numberRepeats
	numScienceGoal
	scienceGoal
	numWeatherConstraint
	weatherConstraint

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

SBSummaryRow* asdm::SBSummaryTable::newRow ( SBSummaryRow * row )

Create a new row using a copy constructor mechanism.

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

Parameters:

row

the row which is to be copied.

SBSummaryRow* asdm::SBSummaryTable::newRow	(	EntityRef	sbSummaryUID,
		EntityRef	projectUID,
		EntityRef	obsUnitSetUID,
		double	frequency,
		ReceiverBandMod::ReceiverBand	frequencyBand,
		SBTypeMod::SBType	sbType,
		Interval	sbDuration,
		int	numObservingMode,
		vector< string >	observingMode,
		int	numberRepeats,
		int	numScienceGoal,
		vector< string >	scienceGoal,
		int	numWeatherConstraint,
		vector< string >	weatherConstraint
	)

Create a new row initialized to the specified values.

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

Parameters:

	sbSummaryUID
	projectUID
	obsUnitSetUID
	frequency
	frequencyBand
	sbType
	sbDuration
	numObservingMode
	observingMode
	numberRepeats
	numScienceGoal
	scienceGoal
	numWeatherConstraint
	weatherConstraint

SBSummaryRow* asdm::SBSummaryTable::newRow ( )

====> Row creation.

Create a new row with default values.

Returns:: a pointer on a SBSummaryRow

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

Set this table's Entity.

Parameters:

e

An entity.

Implements asdm::Representable.

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

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

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

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

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

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

Parameters:

x

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

asdmIDL::SBSummaryTableIDL* asdm::SBSummaryTable::toIDL ( )

Conversion Methods.

Convert this table into a SBSummaryTableIDL CORBA structure.