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

#include <CalFluxTable.h>

Inheritance diagram for asdm::CalFluxTable:

Public Member Functions
virtual	~CalFluxTable ()

ASDM &	getContainer () const
	Return the container to which this table belongs. More...

unsigned int	size () const
	Return the number of rows in the table. More...

std::string	getName () const
	Return the name of this table. More...

std::string	getVersion () const
	Return the version information about this table. More...

Entity	getEntity () const
	Return this table's Entity. More...

void	setEntity (Entity e)
	Set this table's Entity. More...

std::string	toXML ()
	Produces an XML representation conform to the schema defined for CalFlux (CalFluxTable.xsd). More...

asdmIDL::CalFluxTableIDL *	toIDL ()
	Conversion Methods. More...

void	toIDL (asdmIDL::CalFluxTableIDL &x) const
	Fills the CORBA data structure passed in parameter with the content of this table. More...

void	fromIDL (asdmIDL::CalFluxTableIDL x)
	Populate this table from the content of a CalFluxTableIDL Corba structure. More...

CalFluxRow *	newRow ()
	====> Row creation. More...

CalFluxRow *	newRow (std::string sourceName, Tag calDataId, Tag calReductionId, ArrayTime startValidTime, ArrayTime endValidTime, int numFrequencyRanges, int numStokes, std::vector< std::vector< Frequency > > frequencyRanges, FluxCalibrationMethodMod::FluxCalibrationMethod fluxMethod, std::vector< std::vector< double > > flux, std::vector< std::vector< double > > fluxError, std::vector< StokesParameterMod::StokesParameter > stokes)
	Create a new row initialized to the specified values. More...

CalFluxRow *	newRow (CalFluxRow *row)
	Create a new row using a copy constructor mechanism. More...

CalFluxRow *	add (CalFluxRow *x)
	====> Append a row to its table. More...

std::vector< CalFluxRow * >	get ()
	====> Methods returning rows. More...

const std::vector< CalFluxRow * > &	get () const
	Get a const reference on the collection of rows pointers internally hold by the table. More...

CalFluxRow *	getRowByKey (std::string sourceName, Tag calDataId, Tag calReductionId)
	Returns a CalFluxRow* given a key. More...

CalFluxRow *	lookup (std::string sourceName, Tag calDataId, Tag calReductionId, ArrayTime startValidTime, ArrayTime endValidTime, int numFrequencyRanges, int numStokes, std::vector< std::vector< Frequency > > frequencyRanges, FluxCalibrationMethodMod::FluxCalibrationMethod fluxMethod, std::vector< std::vector< double > > flux, std::vector< std::vector< double > > fluxError, std::vector< StokesParameterMod::StokesParameter > stokes)
	Look up the table for a row whose all attributes are equal to the corresponding parameters of the method. More...

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

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

Public Member Functions inherited from asdm::Representable
virtual	~Representable ()

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. More...

static std::string	name ()
	Return the name of this table. More...

static const std::vector < std::string > &	getAttributesNames ()
	Return the names of the attributes of this table. More...

static const std::vector < std::string > &	defaultAttributesNamesInBin ()
	Return the default sorted list of attributes names in the binary representation of the table. More...

Private Member Functions
	CalFluxTable (ASDM &container)
	Create a CalFluxTable. More...

CalFluxRow *	checkAndAdd (CalFluxRow *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. More...

void	append (CalFluxRow *x)
	Brutally append an CalFluxRow x to the collection of rows already stored in this table. More...

void	addWithoutCheckingUnique (CalFluxRow *x)
	Brutally append an CalFluxRow x to the collection of rows already stored in this table. More...

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 CalFlux (CalFluxTable.xsd). More...

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 CalFlux table. More...

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. More...

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. More...

std::string	MIMEXMLPart (const asdm::ByteOrder *byteOrder=asdm::ByteOrder::Machine_Endianity)
	Private methods involved during the export of this table into disk file(s). More...

void	toFile (std::string directory)
	Stores a representation (binary or XML) of this table into a file. More...

void	checkPresenceInMemory ()

void	setFromFile (const std::string &directory)
	Reads and parses a file containing a representation of a CalFluxTable as those produced by the toFile method. More...

Private Attributes
ASDM &	container

bool	archiveAsBin

bool	fileAsBin

std::string	version

Entity	entity

std::vector< CalFluxRow * >	privateRows
	A data structure to store the pointers on the table's rows. More...

std::vector< CalFluxRow * >	row

std::map< std::string, BinaryAttributeReaderFunctor * >	unknownAttributes2Functors

bool	loadInProgress
	Load the table in memory if necessary. More...

Friends
class	ASDM

Additional Inherited Members
Protected Attributes inherited from asdm::Representable
bool	presentInMemory

bool	loadInProgress

uint32_t	declaredSize

Detailed Description

The CalFluxTable class is an Alma table.

Role: Result of flux calibration performed on-line by TelCal. Atmospheric absorption is corrected for. No ionosphere correction has been applied.

Generated from model's revision "-1", branch ""

Attributes of CalFlux
Name	Type	Expected shape	Comment
Key
sourceName	std::string		the name of the source.
calDataId	Tag		refers to a unique row in CalData Table.
calReductionId	Tag		refers to a unique row in CalReduction Table.
Value (Mandatory)
startValidTime	ArrayTime		the start time of result validity period.
endValidTime	ArrayTime		the end time of result validity period.
numFrequencyRanges (numFrequencyRanges)	int		the number of frequency ranges.
numStokes (numStokes)	int		the number of Stokes parameters.
frequencyRanges	std::vector<std::vector<Frequency > >	numFrequencyRanges, 2	the frequency ranges (one pair of values per range).
fluxMethod	FluxCalibrationMethodMod::FluxCalibrationMethod		identifies the flux determination method.
flux	std::vector<std::vector<double > >	numStokes, numFrequencyRanges	the flux densities (one value par Stokes parameter per frequency range) expressed in Jansky (Jy).
fluxError	std::vector<std::vector<double > >	numStokes, numFrequencyRanges	the uncertainties on the flux densities (one value per Stokes parameter per frequency range).
stokes	std::vector<StokesParameterMod::StokesParameter >	numStokes	the Stokes parameter.
Value (Optional)
direction	std::vector<Angle >	2	the direction of the source.
directionCode	DirectionReferenceCodeMod::DirectionReferenceCode		identifies the reference frame of the source's direction.
directionEquinox	Angle		equinox associated with the reference frame of the source's direction.
PA	std::vector<std::vector<Angle > >	numStokes, numFrequencyRanges	the position's angles for the source model (one value per Stokes parameter per frequency range).
PAError	std::vector<std::vector<Angle > >	numStokes, numFrequencyRanges	the uncertainties on the position's angles (one value per Stokes parameter per frequency range).
size	std::vector<std::vector<std::vector<Angle > > >	numStokes, numFrequencyRanges, 2	the sizes of the source (one pair of angles per Stokes parameter per frequency range).
sizeError	std::vector<std::vector<std::vector<Angle > > >	numStokes, numFrequencyRanges, 2	the uncertainties of the sizes of the source (one pair of angles per Stokes parameter per frequency range).
sourceModel	SourceModelMod::SourceModel		identifies the source model.

Definition at line 303 of file CalFluxTable.h.

Constructor & Destructor Documentation

virtual asdm::CalFluxTable::~CalFluxTable ( )

virtual

asdm::CalFluxTable::CalFluxTable ( ASDM & container )

private

Create a CalFluxTable.

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

CalFluxRow* asdm::CalFluxTable::add ( CalFluxRow * x )

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

Add a row.

Parameters

x	a pointer to the CalFluxRow to be added.

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

Exceptions

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

void asdm::CalFluxTable::addWithoutCheckingUnique ( CalFluxRow * x )

private

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

No uniqueness check is done !

Parameters

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

void asdm::CalFluxTable::append ( CalFluxRow * x )

private

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

No uniqueness check is done !

Parameters

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

CalFluxRow* asdm::CalFluxTable::checkAndAdd	(	CalFluxRow *	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::CalFluxTable::checkPresenceInMemory ( )

inlineprivate

Definition at line 705 of file CalFluxTable.h.

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

static const std::vector<std::string>& asdm::CalFluxTable::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::CalFluxTable::error ( )

private

void asdm::CalFluxTable::fromIDL ( asdmIDL::CalFluxTableIDL x )

Populate this table from the content of a CalFluxTableIDL 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::CalFluxTable::fromXML ( std::string & xmlDoc )

privatevirtual

Populate this table from the content of a XML document that is required to be conform to the XML schema defined for a CalFlux (CalFluxTable.xsd).

Exceptions

ConversionException

Implements asdm::Representable.

std::vector<CalFluxRow *> asdm::CalFluxTable::get ( )

====> Methods returning rows.

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

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

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

static const std::vector<std::string>& asdm::CalFluxTable::getAttributesNames ( )

static

Return the names of the attributes of this table.

Returns: a vector of string

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

Return the container to which this table belongs.

Returns: the ASDM containing this table.

Referenced by checkPresenceInMemory().

Entity asdm::CalFluxTable::getEntity ( ) const

virtual

Return this table's Entity.

Implements asdm::Representable.

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

CalFluxRow* asdm::CalFluxTable::getRowByKey	(	std::string	sourceName,
		Tag	calDataId,
		Tag	calReductionId
	)

Returns a CalFluxRow* 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

sourceName
calDataId
calReductionId

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

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

Return the version information about this table.

CalFluxRow* asdm::CalFluxTable::lookup	(	std::string	sourceName,
		Tag	calDataId,
		Tag	calReductionId,
		ArrayTime	startValidTime,
		ArrayTime	endValidTime,
		int	numFrequencyRanges,
		int	numStokes,
		std::vector< std::vector< Frequency > >	frequencyRanges,
		FluxCalibrationMethodMod::FluxCalibrationMethod	fluxMethod,
		std::vector< std::vector< double > >	flux,
		std::vector< std::vector< double > >	fluxError,
		std::vector< StokesParameterMod::StokesParameter >	stokes
	)

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

sourceName
calDataId
calReductionId
startValidTime
endValidTime
numFrequencyRanges
numStokes
frequencyRanges
fluxMethod
flux
fluxError
stokes

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

CalFluxRow* asdm::CalFluxTable::newRow ( )

====> Row creation.

Create a new row with default values.

Returns: a pointer on a CalFluxRow

CalFluxRow* asdm::CalFluxTable::newRow	(	std::string	sourceName,
		Tag	calDataId,
		Tag	calReductionId,
		ArrayTime	startValidTime,
		ArrayTime	endValidTime,
		int	numFrequencyRanges,
		int	numStokes,
		std::vector< std::vector< Frequency > >	frequencyRanges,
		FluxCalibrationMethodMod::FluxCalibrationMethod	fluxMethod,
		std::vector< std::vector< double > >	flux,
		std::vector< std::vector< double > >	fluxError,
		std::vector< StokesParameterMod::StokesParameter >	stokes
	)

Create a new row initialized to the specified values.

Returns: a pointer on the created and initialized row.

Parameters

sourceName
calDataId
calReductionId
startValidTime
endValidTime
numFrequencyRanges
numStokes
frequencyRanges
fluxMethod
flux
fluxError
stokes

CalFluxRow* asdm::CalFluxTable::newRow ( CalFluxRow * row )

Create a new row using a copy constructor mechanism.

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

Parameters

row	the row which is to be copied.

void asdm::CalFluxTable::setEntity ( Entity e )

virtual

Set this table's Entity.

Parameters

e	An entity.

Implements asdm::Representable.

void asdm::CalFluxTable::setFromFile ( const std::string & directory )

private

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

void asdm::CalFluxTable::setFromXMLFile ( const std::string & directory )

private

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

unsigned int asdm::CalFluxTable::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::CalFluxTable::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 "CalFlux.bin" or an XML representation (fileAsBin==false) will be saved in a file "CalFlux.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::CalFluxTableIDL* asdm::CalFluxTable::toIDL ( )

Conversion Methods.

Convert this table into a CalFluxTableIDL CORBA structure.

Returns: a pointer to a CalFluxTableIDL

void asdm::CalFluxTable::toIDL ( asdmIDL::CalFluxTableIDL & x ) const

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

Parameters

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

std::string asdm::CalFluxTable::toMIME ( const asdm::ByteOrder * byteOrder = asdm::ByteOrder::Machine_Endianity )

private

Serialize this into a stream of bytes and encapsulates that stream into a MIME message.

Returns: a string containing the MIME message.

Parameters

byteOrder a const pointer to a static instance of the class ByteOrder.

std::string asdm::CalFluxTable::toXML ( )

virtual

Produces an XML representation conform to the schema defined for CalFlux (CalFluxTable.xsd).

Returns: a string containing the XML representation.

Exceptions

ConversionException

Implements asdm::Representable.

Friends And Related Function Documentation

friend class ASDM

friend

Definition at line 304 of file CalFluxTable.h.

Member Data Documentation

bool asdm::CalFluxTable::archiveAsBin

private

Definition at line 595 of file CalFluxTable.h.

ASDM& asdm::CalFluxTable::container

private

Definition at line 593 of file CalFluxTable.h.

Entity asdm::CalFluxTable::entity

private

Definition at line 600 of file CalFluxTable.h.

bool asdm::CalFluxTable::fileAsBin

private

Definition at line 596 of file CalFluxTable.h.

bool asdm::CalFluxTable::loadInProgress

private

Load the table in memory if necessary.

Definition at line 704 of file CalFluxTable.h.

Referenced by checkPresenceInMemory().

std::vector<CalFluxRow * > asdm::CalFluxTable::privateRows

private

A data structure to store the pointers on the table's rows.

In all cases we maintain a private vector of CalFluxRow s.

Definition at line 637 of file CalFluxTable.h.

std::vector<CalFluxRow *> asdm::CalFluxTable::row

private

Definition at line 641 of file CalFluxTable.h.

std::map<std::string, BinaryAttributeReaderFunctor *> asdm::CalFluxTable::unknownAttributes2Functors

private

Definition at line 655 of file CalFluxTable.h.

std::string asdm::CalFluxTable::version

private

Definition at line 598 of file CalFluxTable.h.

The documentation for this class was generated from the following file:

casa/code/alma/ASDM/CalFluxTable.h

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation