asdm::SpectralWindowTable Class Reference

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

#include <SpectralWindowTable.h>

Inheritance diagram for asdm::SpectralWindowTable:

Public Member Functions
virtual	~SpectralWindowTable ()
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 SpectralWindow (SpectralWindowTable.xsd).
asdmIDL::SpectralWindowTableIDL *	toIDL ()
	Conversion Methods.
void	toIDL (asdmIDL::SpectralWindowTableIDL &x) const
	Fills the CORBA data structure passed in parameter with the content of this table.
void	fromIDL (asdmIDL::SpectralWindowTableIDL x)
	Populate this table from the content of a SpectralWindowTableIDL Corba structure.
SpectralWindowRow *	newRow ()
	====> Row creation.
SpectralWindowRow *	newRow (BasebandNameMod::BasebandName basebandName, NetSidebandMod::NetSideband netSideband, int numChan, Frequency refFreq, SidebandProcessingModeMod::SidebandProcessingMode sidebandProcessingMode, Frequency totBandwidth, WindowFunctionMod::WindowFunction windowFunction)
	Create a new row initialized to the specified values.
SpectralWindowRow *	newRow (SpectralWindowRow *row)
	Create a new row using a copy constructor mechanism.
SpectralWindowRow *	add (SpectralWindowRow *x)
	====> Append a row to its table.
std::vector< SpectralWindowRow * >	get ()
	====> Methods returning rows.
const std::vector < SpectralWindowRow * > &	get () const
	Get a const reference on the collection of rows pointers internally hold by the table.
SpectralWindowRow *	getRowByKey (Tag spectralWindowId)
	Returns a SpectralWindowRow* given a key.
SpectralWindowRow *	lookup (BasebandNameMod::BasebandName basebandName, NetSidebandMod::NetSideband netSideband, int numChan, Frequency refFreq, SidebandProcessingModeMod::SidebandProcessingMode sidebandProcessingMode, Frequency totBandwidth, WindowFunctionMod::WindowFunction windowFunction)
	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
	SpectralWindowTable (ASDM &container)
	Create a SpectralWindowTable.
void	autoIncrement (std::string key, SpectralWindowRow *x)
SpectralWindowRow *	checkAndAdd (SpectralWindowRow *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 (SpectralWindowRow *x)
	Brutally append an SpectralWindowRow x to the collection of rows already stored in this table.
void	addWithoutCheckingUnique (SpectralWindowRow *x)
	Brutally append an SpectralWindowRow 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 SpectralWindow (SpectralWindowTable.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 SpectralWindow 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 SpectralWindowTable 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< SpectralWindowRow * >	privateRows
	A data structure to store the pointers on the table's rows.
std::vector< SpectralWindowRow * >	row
std::map< std::string, BinaryAttributeReaderFunctor * >	unknownAttributes2Functors
bool	loadInProgress
	Load the table in memory if necessary.
Friends
class	ASDM

Detailed Description

The SpectralWindowTable class is an Alma table.

Role: Spectral window description. The convention in ALMA is to describe the frequency axis in the topocentric reference frame. If this is not the case (for instance if active Doppler tracking is implemented) then {measFreqRef} should be set accordingly.

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

Attributes of SpectralWindow
Name	Type	Expected shape	Comment
Key
spectralWindowId	Tag		identifies a unique row in the table.
Value (Mandatory)
basebandName	BasebandNameMod::BasebandName		identifies the baseband.
netSideband	NetSidebandMod::NetSideband		identifies the net sideband.
numChan	int		the number of frequency channels.
refFreq	Frequency		the reference frequency.
sidebandProcessingMode	SidebandProcessingModeMod::SidebandProcessingMode		identifies the sideband processing mode.
totBandwidth	Frequency		the total bandwidth.
windowFunction	WindowFunctionMod::WindowFunction		identifies the window function.
Value (Optional)
chanFreqStart	Frequency		the frequency of the first channel.
chanFreqStep	Frequency		the increment between two successive frequencies.
chanFreqArray	vector<Frequency >	numChan	the frequencies defined as an array ({numChan} values).
chanWidth	Frequency		the width of the frequency channel (supposedly constant).
chanWidthArray	vector<Frequency >	numChan	Array of channel widths
correlationBit	CorrelationBitMod::CorrelationBit		identifies the number of bits used in the signal representation.
effectiveBw	Frequency		the effective noise bandwidth.
effectiveBwArray	vector<Frequency >	numChan	array of effective bandwidths (one value per channel).
freqGroup	int		the frequency group number.
freqGroupName	string		the frequency group name.
lineArray	vector<bool >	numChan	indicates lines (true) versus baselines (false).
measFreqRef	FrequencyReferenceCodeMod::FrequencyReferenceCode		the reference frame of the frequencies.
name	string		a name for this spectral window.
oversampling	bool		data are "oversampled" (true) or not (false).
quantization	bool		a quantization correction has been applied (true) or not applied (false).
refChan	double		the reference channel "number".
resolution	Frequency		the half power frequency resolution (supposedly constant for all the channels).
resolutionArray	vector<Frequency >	numChan	the frequency resolutions (possibly variable )(one value per channel).
numAssocValues	int		the number of associated values.
assocNature	vector<SpectralResolutionTypeMod::SpectralResolutionType >	numAssocValues	the natures of the associations with the rows refered to by assocSpectralWindowId.
assocSpectralWindowId	vector<Tag>	numAssocValues	refers to a collection of associated rows in the table.
imageSpectralWindowId	Tag		refers to a unique row in the table (image sideband description).
dopplerId	int		refers to a collection of rows in DopplerTable.

Definition at line 394 of file SpectralWindowTable.h.

Constructor & Destructor Documentation

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

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

Create a SpectralWindowTable.

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

SpectralWindowRow* asdm::SpectralWindowTable::add ( SpectralWindowRow * 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 SpectralWindowRow.

void asdm::SpectralWindowTable::addWithoutCheckingUnique ( SpectralWindowRow * x ) [private]

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

No uniqueness check is done !

Parameters:

SpectralWindowRow*

x a pointer onto the SpectralWindowRow to be appended.

void asdm::SpectralWindowTable::append ( SpectralWindowRow * x ) [private]

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

No uniqueness check is done !

Parameters:

SpectralWindowRow*

x a pointer onto the SpectralWindowRow to be appended.

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

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

Definition at line 772 of file SpectralWindowTable.h.

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

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

void asdm::SpectralWindowTable::fromIDL ( asdmIDL::SpectralWindowTableIDL x )

Populate this table from the content of a SpectralWindowTableIDL 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::SpectralWindowTable::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 SpectralWindow (SpectralWindowTable.xsd).

Exceptions:

ConversionException

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

std::vector<SpectralWindowRow *> asdm::SpectralWindowTable::get ( )

====> Methods returning rows.

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

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

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

Return the names of the attributes of this table.

Returns:: a vector of string

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

Return the container to which this table belongs.

Returns:: the ASDM containing this table.

Referenced by checkPresenceInMemory().

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

Return this table's Entity.

Implements asdm::Representable.

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

SpectralWindowRow* asdm::SpectralWindowTable::getRowByKey ( Tag spectralWindowId )

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

spectralWindowId

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

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

Return the version information about this table.

SpectralWindowRow* asdm::SpectralWindowTable::lookup	(	BasebandNameMod::BasebandName	basebandName,
		NetSidebandMod::NetSideband	netSideband,
		int	numChan,
		Frequency	refFreq,
		SidebandProcessingModeMod::SidebandProcessingMode	sidebandProcessingMode,
		Frequency	totBandwidth,
		WindowFunctionMod::WindowFunction	windowFunction
	)

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:

	basebandName
	netSideband
	numChan
	refFreq
	sidebandProcessingMode
	totBandwidth
	windowFunction

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

SpectralWindowRow* asdm::SpectralWindowTable::newRow ( SpectralWindowRow * row )

Create a new row using a copy constructor mechanism.

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

Parameters:

row

the row which is to be copied.

SpectralWindowRow* asdm::SpectralWindowTable::newRow	(	BasebandNameMod::BasebandName	basebandName,
		NetSidebandMod::NetSideband	netSideband,
		int	numChan,
		Frequency	refFreq,
		SidebandProcessingModeMod::SidebandProcessingMode	sidebandProcessingMode,
		Frequency	totBandwidth,
		WindowFunctionMod::WindowFunction	windowFunction
	)

Create a new row initialized to the specified values.

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

Parameters:

	basebandName
	netSideband
	numChan
	refFreq
	sidebandProcessingMode
	totBandwidth
	windowFunction

SpectralWindowRow* asdm::SpectralWindowTable::newRow ( )

====> Row creation.

Create a new row with default values.

Returns:: a pointer on a SpectralWindowRow

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

Set this table's Entity.

Parameters:

e

An entity.

Implements asdm::Representable.

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

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

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

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

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

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

Parameters:

x

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

asdmIDL::SpectralWindowTableIDL* asdm::SpectralWindowTable::toIDL ( )

Conversion Methods.

Convert this table into a SpectralWindowTableIDL CORBA structure.