asdm::SubscanTable Class Reference

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

#include <SubscanTable.h>

Inheritance diagram for asdm::SubscanTable:

Public Member Functions
virtual	~SubscanTable ()
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 Subscan (SubscanTable.xsd).
asdmIDL::SubscanTableIDL *	toIDL ()
	Conversion Methods.
void	toIDL (asdmIDL::SubscanTableIDL &x) const
	Fills the CORBA data structure passed in parameter with the content of this table.
void	fromIDL (asdmIDL::SubscanTableIDL x)
	Populate this table from the content of a SubscanTableIDL Corba structure.
SubscanRow *	newRow ()
	====> Row creation.
SubscanRow *	newRow (Tag execBlockId, int scanNumber, int subscanNumber, ArrayTime startTime, ArrayTime endTime, string fieldName, SubscanIntentMod::SubscanIntent subscanIntent, int numIntegration, vector< int > numSubintegration)
	Create a new row initialized to the specified values.
SubscanRow *	newRow (SubscanRow *row)
	Create a new row using a copy constructor mechanism.
SubscanRow *	add (SubscanRow *x)
	====> Append a row to its table.
std::vector< SubscanRow * >	get ()
	====> Methods returning rows.
const std::vector< SubscanRow * > &	get () const
	Get a const reference on the collection of rows pointers internally hold by the table.
SubscanRow *	getRowByKey (Tag execBlockId, int scanNumber, int subscanNumber)
	Returns a SubscanRow* given a key.
SubscanRow *	lookup (Tag execBlockId, int scanNumber, int subscanNumber, ArrayTime startTime, ArrayTime endTime, string fieldName, SubscanIntentMod::SubscanIntent subscanIntent, int numIntegration, vector< int > numSubintegration)
	Look up the table for a row whose all attributes 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
	SubscanTable (ASDM &container)
	Create a SubscanTable.
SubscanRow *	checkAndAdd (SubscanRow *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 (SubscanRow *x)
	Brutally append an SubscanRow x to the collection of rows already stored in this table.
void	addWithoutCheckingUnique (SubscanRow *x)
	Brutally append an SubscanRow 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 Subscan (SubscanTable.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 Subscan 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 SubscanTable as those produced by the toFile method.
Private Attributes
ASDM &	container
bool	archiveAsBin
bool	fileAsBin
std::string	version
Entity	entity
std::vector< SubscanRow * >	privateRows
	A data structure to store the pointers on the table's rows.
std::vector< SubscanRow * >	row
std::map< std::string, BinaryAttributeReaderFunctor * >	unknownAttributes2Functors
bool	loadInProgress
	Load the table in memory if necessary.
Friends
class	ASDM

Detailed Description

The SubscanTable class is an Alma table.

Role: Subscan-based information.

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

Attributes of Subscan
Name	Type	Expected shape	Comment
Key
execBlockId	Tag		identifies a unique row in ExecBlockTable.
scanNumber	int		the number of the scan this subscan belongs to.
subscanNumber	int		the subscan number.
Value (Mandatory)
startTime	ArrayTime		the actual start time of the subscan.
endTime	ArrayTime		the actual end time of the subscan.
fieldName	string		the name of the observed field.
subscanIntent	SubscanIntentMod::SubscanIntent		the intent of the subscan.
numIntegration	int		the number of integrations during the scan.
numSubintegration	vector<int >	numIntegration	the number of subintegrations for each integration.
Value (Optional)
subscanMode	SwitchingModeMod::SwitchingMode		identifies the data acquisition mode during the subscan.
correlatorCalibration	CorrelatorCalibrationMod::CorrelatorCalibration		identifies the correlator calibration during the subscan.

Definition at line 214 of file SubscanTable.h.

Constructor & Destructor Documentation

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

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

Create a SubscanTable.

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

SubscanRow* asdm::SubscanTable::add ( SubscanRow * x )

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

Add a row.

Parameters:

x

a pointer to the SubscanRow to be added.

Returns:: a pointer to a SubscanRow. If the table contains a SubscanRow whose attributes (key and mandatory values) are equal to x ones then returns a pointer on that SubscanRow, otherwise returns x.

Exceptions:

DuplicateKey

{ thrown when the table contains a SubscanRow with a key equal to the x one but having and a value section different from x one }

void asdm::SubscanTable::addWithoutCheckingUnique ( SubscanRow * x ) [private]

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

No uniqueness check is done !

Parameters:

SubscanRow*

x a pointer onto the SubscanRow to be appended.

void asdm::SubscanTable::append ( SubscanRow * x ) [private]

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

No uniqueness check is done !

Parameters:

SubscanRow*

x a pointer onto the SubscanRow to be appended.

SubscanRow* asdm::SubscanTable::checkAndAdd	(	SubscanRow *	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

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

Definition at line 601 of file SubscanTable.h.

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

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

void asdm::SubscanTable::fromIDL ( asdmIDL::SubscanTableIDL x )

Populate this table from the content of a SubscanTableIDL 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::SubscanTable::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 Subscan (SubscanTable.xsd).

Exceptions:

ConversionException

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

std::vector<SubscanRow *> asdm::SubscanTable::get ( )

====> Methods returning rows.

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

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

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

Return the names of the attributes of this table.

Returns:: a vector of string

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

Return the container to which this table belongs.

Returns:: the ASDM containing this table.

Referenced by checkPresenceInMemory().

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

Return this table's Entity.

Implements asdm::Representable.

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

SubscanRow* asdm::SubscanTable::getRowByKey	(	Tag	execBlockId,
		int	scanNumber,
		int	subscanNumber
	)

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

	execBlockId
	scanNumber
	subscanNumber

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

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

Return the version information about this table.

SubscanRow* asdm::SubscanTable::lookup	(	Tag	execBlockId,
		int	scanNumber,
		int	subscanNumber,
		ArrayTime	startTime,
		ArrayTime	endTime,
		string	fieldName,
		SubscanIntentMod::SubscanIntent	subscanIntent,
		int	numIntegration,
		vector< int >	numSubintegration
	)

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

Returns:: a pointer on this row if any, null otherwise.

Parameters:

	execBlockId
	scanNumber
	subscanNumber
	startTime
	endTime
	fieldName
	subscanIntent
	numIntegration
	numSubintegration

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

SubscanRow* asdm::SubscanTable::newRow ( SubscanRow * row )

Create a new row using a copy constructor mechanism.

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

Parameters:

row

the row which is to be copied.

SubscanRow* asdm::SubscanTable::newRow	(	Tag	execBlockId,
		int	scanNumber,
		int	subscanNumber,
		ArrayTime	startTime,
		ArrayTime	endTime,
		string	fieldName,
		SubscanIntentMod::SubscanIntent	subscanIntent,
		int	numIntegration,
		vector< int >	numSubintegration
	)

Create a new row initialized to the specified values.

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

Parameters:

	execBlockId
	scanNumber
	subscanNumber
	startTime
	endTime
	fieldName
	subscanIntent
	numIntegration
	numSubintegration

SubscanRow* asdm::SubscanTable::newRow ( )

====> Row creation.

Create a new row with default values.

Returns:: a pointer on a SubscanRow

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

Set this table's Entity.

Parameters:

e

An entity.

Implements asdm::Representable.

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

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

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

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

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

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

Parameters:

x

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

asdmIDL::SubscanTableIDL* asdm::SubscanTable::toIDL ( )

Conversion Methods.

Convert this table into a SubscanTableIDL CORBA structure.