The ASDM class is the container for all tables. More...

#include <ASDM.h>

Public Types
enum	Origin { FILE, ARCHIVE, EX_NIHILO }
	This enumeration lists the different possible origins for an ASDM present in memory. More...

Public Member Functions
	ASDM ()
	Constructs an empty ASDM. More...

virtual	~ASDM ()

MainTable &	getMain () const
	Get the table Main. More...

AlmaRadiometerTable &	getAlmaRadiometer () const
	Get the table AlmaRadiometer. More...

AnnotationTable &	getAnnotation () const
	Get the table Annotation. More...

AntennaTable &	getAntenna () const
	Get the table Antenna. More...

CalAmpliTable &	getCalAmpli () const
	Get the table CalAmpli. More...

CalAntennaSolutionsTable &	getCalAntennaSolutions () const
	Get the table CalAntennaSolutions. More...

CalAppPhaseTable &	getCalAppPhase () const
	Get the table CalAppPhase. More...

CalAtmosphereTable &	getCalAtmosphere () const
	Get the table CalAtmosphere. More...

CalBandpassTable &	getCalBandpass () const
	Get the table CalBandpass. More...

CalCurveTable &	getCalCurve () const
	Get the table CalCurve. More...

CalDataTable &	getCalData () const
	Get the table CalData. More...

CalDelayTable &	getCalDelay () const
	Get the table CalDelay. More...

CalDeviceTable &	getCalDevice () const
	Get the table CalDevice. More...

CalFluxTable &	getCalFlux () const
	Get the table CalFlux. More...

CalFocusTable &	getCalFocus () const
	Get the table CalFocus. More...

CalFocusModelTable &	getCalFocusModel () const
	Get the table CalFocusModel. More...

CalGainTable &	getCalGain () const
	Get the table CalGain. More...

CalHolographyTable &	getCalHolography () const
	Get the table CalHolography. More...

CalPhaseTable &	getCalPhase () const
	Get the table CalPhase. More...

CalPointingTable &	getCalPointing () const
	Get the table CalPointing. More...

CalPointingModelTable &	getCalPointingModel () const
	Get the table CalPointingModel. More...

CalPositionTable &	getCalPosition () const
	Get the table CalPosition. More...

CalPrimaryBeamTable &	getCalPrimaryBeam () const
	Get the table CalPrimaryBeam. More...

CalReductionTable &	getCalReduction () const
	Get the table CalReduction. More...

CalSeeingTable &	getCalSeeing () const
	Get the table CalSeeing. More...

CalWVRTable &	getCalWVR () const
	Get the table CalWVR. More...

ConfigDescriptionTable &	getConfigDescription () const
	Get the table ConfigDescription. More...

CorrelatorModeTable &	getCorrelatorMode () const
	Get the table CorrelatorMode. More...

DataDescriptionTable &	getDataDescription () const
	Get the table DataDescription. More...

DelayModelTable &	getDelayModel () const
	Get the table DelayModel. More...

DelayModelFixedParametersTable &	getDelayModelFixedParameters () const
	Get the table DelayModelFixedParameters. More...

DelayModelVariableParametersTable &	getDelayModelVariableParameters () const
	Get the table DelayModelVariableParameters. More...

DopplerTable &	getDoppler () const
	Get the table Doppler. More...

EphemerisTable &	getEphemeris () const
	Get the table Ephemeris. More...

ExecBlockTable &	getExecBlock () const
	Get the table ExecBlock. More...

FeedTable &	getFeed () const
	Get the table Feed. More...

FieldTable &	getField () const
	Get the table Field. More...

FlagTable &	getFlag () const
	Get the table Flag. More...

FlagCmdTable &	getFlagCmd () const
	Get the table FlagCmd. More...

FocusTable &	getFocus () const
	Get the table Focus. More...

FocusModelTable &	getFocusModel () const
	Get the table FocusModel. More...

FreqOffsetTable &	getFreqOffset () const
	Get the table FreqOffset. More...

GainTrackingTable &	getGainTracking () const
	Get the table GainTracking. More...

HistoryTable &	getHistory () const
	Get the table History. More...

HolographyTable &	getHolography () const
	Get the table Holography. More...

ObservationTable &	getObservation () const
	Get the table Observation. More...

PointingTable &	getPointing () const
	Get the table Pointing. More...

PointingModelTable &	getPointingModel () const
	Get the table PointingModel. More...

PolarizationTable &	getPolarization () const
	Get the table Polarization. More...

ProcessorTable &	getProcessor () const
	Get the table Processor. More...

PulsarTable &	getPulsar () const
	Get the table Pulsar. More...

ReceiverTable &	getReceiver () const
	Get the table Receiver. More...

SBSummaryTable &	getSBSummary () const
	Get the table SBSummary. More...

ScaleTable &	getScale () const
	Get the table Scale. More...

ScanTable &	getScan () const
	Get the table Scan. More...

SeeingTable &	getSeeing () const
	Get the table Seeing. More...

SourceTable &	getSource () const
	Get the table Source. More...

SpectralWindowTable &	getSpectralWindow () const
	Get the table SpectralWindow. More...

SquareLawDetectorTable &	getSquareLawDetector () const
	Get the table SquareLawDetector. More...

StateTable &	getState () const
	Get the table State. More...

StationTable &	getStation () const
	Get the table Station. More...

SubscanTable &	getSubscan () const
	Get the table Subscan. More...

SwitchCycleTable &	getSwitchCycle () const
	Get the table SwitchCycle. More...

SysCalTable &	getSysCal () const
	Get the table SysCal. More...

SysPowerTable &	getSysPower () const
	Get the table SysPower. More...

TotalPowerTable &	getTotalPower () const
	Get the table TotalPower. More...

WVMCalTable &	getWVMCal () const
	Get the table WVMCal. More...

WeatherTable &	getWeather () const
	Get the table Weather. More...

virtual std::string	toXML () const
	Produces the XML representation of * this. More...

void	toXML (std::string directory) const
	Write this ASDM dataset to the specified directory as a collection of XML documents. More...

virtual void	fromXML (std::string xml)
	Get an ASDM dataset, given the full path name of the directory containing the XML version of the dataset. More...

std::string	toMIME ()
	Serialize this into a stream of bytes and encapsulates that stream into a MIME message. More...

void	setFromMIME (const std::string &)
	Extracts the binary part of a MIME message and deserialize its content to fill this with the result of the deserialization. More...

void	toFile (std::string directory)
	Write this ASDM dataset to the specified directory as a collection of files. More...

void	setFromFile (std::string directory, bool loadTablesOnDemand)
	Constructs totally or partially an ASDM dataset from its representation on disk. More...

void	setFromFile (std::string directory, const ASDMParseOptions &parse=ASDMParseOptions())
	Constructs an ASDM dataset from its representation on disk. More...

bool	checkRowUniqueness () const
	Returns a boolean value indicating if a control of the uniqueness of each row of each table is done during the execution of the method setFromFile. More...

virtual asdmIDL::ASDMDataSetIDL *	toIDL ()
	Converts this ASDM into an ASDMDataSetIDL CORBA structure. More...

virtual void	fromIDL (asdmIDL::ASDMDataSetIDL *x)
	Builds an ASDM out of its IDL representation. More...

virtual Entity	getEntity () const

virtual void	setEntity (Entity e)

virtual std::string	getName () const
	Meaningless, but required for the Representable interface. More...

virtual unsigned int	size ()
	Meaningless, but required for the Representable interface. More...

void	updateArchive () const
	Update an ASDM dataset that already exists in the ALMA archive. More...

Representable &	getTable (std::string tableName)
	Return the table, as a Representable object, with the specified name. More...

ArrayTime	getTimeOfCreation () const
	===> Attribute timeOfCreation More...

void	setTimeOfCreation (ArrayTime timeOfCreation)
	Set timeOfCreation with the specified ArrayTime. More...

int	getVersion () const
	===> Attribute version More...

void	setVersion (int version)
	Set version with the specified int. More...

std::string	getXmlnsPrefix () const
	===> Attribute xmlnsPrefix More...

void	setXmlnsPrefix (std::string xmlnsPrefix)
	Set xmlnsPrefix with the specified std::string. More...

Origin	getOrigin () const
	Returns the origin of the dataset in memory. More...

std::string	getDirectory () const
	Returns the ASDM's directory. More...

XSLTransformer &	getXSLTransformer ()

Static Public Member Functions
static ASDM *	getFromXML (std::string xmlDirectory)
	Get an ASDM dataset, given the full path name of the directory containing the XML version of the dataset. More...

static ASDM *	fromArchive (EntityId datasetId)
	Create an ASDM dataset from the ALMA archive, given the entityId of its container. More...

Private Member Functions
void	error ()

Static Private Member Functions
static std::string	getXMLEntity (EntityId)

static void	putXMLEntity (std::string)

Private Attributes
bool	archiveAsBin

bool	fileAsBin

bool	hasBeenAdded

Origin	origin

bool	loadTablesOnDemand_

bool	checkRowUniqueness_

std::string	directory_

MainTable *	main
	The table Main. More...

AlmaRadiometerTable *	almaRadiometer
	The table AlmaRadiometer. More...

AnnotationTable *	annotation
	The table Annotation. More...

AntennaTable *	antenna
	The table Antenna. More...

CalAmpliTable *	calAmpli
	The table CalAmpli. More...

CalAntennaSolutionsTable *	calAntennaSolutions
	The table CalAntennaSolutions. More...

CalAppPhaseTable *	calAppPhase
	The table CalAppPhase. More...

CalAtmosphereTable *	calAtmosphere
	The table CalAtmosphere. More...

CalBandpassTable *	calBandpass
	The table CalBandpass. More...

CalCurveTable *	calCurve
	The table CalCurve. More...

CalDataTable *	calData
	The table CalData. More...

CalDelayTable *	calDelay
	The table CalDelay. More...

CalDeviceTable *	calDevice
	The table CalDevice. More...

CalFluxTable *	calFlux
	The table CalFlux. More...

CalFocusTable *	calFocus
	The table CalFocus. More...

CalFocusModelTable *	calFocusModel
	The table CalFocusModel. More...

CalGainTable *	calGain
	The table CalGain. More...

CalHolographyTable *	calHolography
	The table CalHolography. More...

CalPhaseTable *	calPhase
	The table CalPhase. More...

CalPointingTable *	calPointing
	The table CalPointing. More...

CalPointingModelTable *	calPointingModel
	The table CalPointingModel. More...

CalPositionTable *	calPosition
	The table CalPosition. More...

CalPrimaryBeamTable *	calPrimaryBeam
	The table CalPrimaryBeam. More...

CalReductionTable *	calReduction
	The table CalReduction. More...

CalSeeingTable *	calSeeing
	The table CalSeeing. More...

CalWVRTable *	calWVR
	The table CalWVR. More...

ConfigDescriptionTable *	configDescription
	The table ConfigDescription. More...

CorrelatorModeTable *	correlatorMode
	The table CorrelatorMode. More...

DataDescriptionTable *	dataDescription
	The table DataDescription. More...

DelayModelTable *	delayModel
	The table DelayModel. More...

DelayModelFixedParametersTable *	delayModelFixedParameters
	The table DelayModelFixedParameters. More...

DelayModelVariableParametersTable *	delayModelVariableParameters
	The table DelayModelVariableParameters. More...

DopplerTable *	doppler
	The table Doppler. More...

EphemerisTable *	ephemeris
	The table Ephemeris. More...

ExecBlockTable *	execBlock
	The table ExecBlock. More...

FeedTable *	feed
	The table Feed. More...

FieldTable *	field
	The table Field. More...

FlagTable *	flag
	The table Flag. More...

FlagCmdTable *	flagCmd
	The table FlagCmd. More...

FocusTable *	focus
	The table Focus. More...

FocusModelTable *	focusModel
	The table FocusModel. More...

FreqOffsetTable *	freqOffset
	The table FreqOffset. More...

GainTrackingTable *	gainTracking
	The table GainTracking. More...

HistoryTable *	history
	The table History. More...

HolographyTable *	holography
	The table Holography. More...

ObservationTable *	observation
	The table Observation. More...

PointingTable *	pointing
	The table Pointing. More...

PointingModelTable *	pointingModel
	The table PointingModel. More...

PolarizationTable *	polarization
	The table Polarization. More...

ProcessorTable *	processor
	The table Processor. More...

PulsarTable *	pulsar
	The table Pulsar. More...

ReceiverTable *	receiver
	The table Receiver. More...

SBSummaryTable *	sBSummary
	The table SBSummary. More...

ScaleTable *	scale
	The table Scale. More...

ScanTable *	scan
	The table Scan. More...

SeeingTable *	seeing
	The table Seeing. More...

SourceTable *	source
	The table Source. More...

SpectralWindowTable *	spectralWindow
	The table SpectralWindow. More...

SquareLawDetectorTable *	squareLawDetector
	The table SquareLawDetector. More...

StateTable *	state
	The table State. More...

StationTable *	station
	The table Station. More...

SubscanTable *	subscan
	The table Subscan. More...

SwitchCycleTable *	switchCycle
	The table SwitchCycle. More...

SysCalTable *	sysCal
	The table SysCal. More...

SysPowerTable *	sysPower
	The table SysPower. More...

TotalPowerTable *	totalPower
	The table TotalPower. More...

WVMCalTable *	wVMCal
	The table WVMCal. More...

WeatherTable *	weather
	The table Weather. More...

std::vector< Representable * >	table
	The list of tables as Representable. More...

std::map< std::string, Entity >	tableEntity
	The list of Entity objects representing the tables. More...

Entity	entity
	This Container's entity. More...

ArrayTime	timeOfCreation
	===> Attribute timeOfCreation More...

int	version
	===> Attribute version More...

std::string	xmlnsPrefix
	===> Attribute xmlnsPrefix More...

XSLTransformer	xslTransformer

Detailed Description

The ASDM class is the container for all tables.

Its instantation creates a complete set of tables.

Generated from model's revision "-1", branch ""class ASDM : public Representable {

Definition at line 273 of file ASDM.h.

Member Enumeration Documentation

enum asdm::ASDM::Origin

This enumeration lists the different possible origins for an ASDM present in memory.

Enumerator
FILE	The dataset has been constructed from its representation on disk.
ARCHIVE	The dataset has been constructed from its representation in the Archive.
EX_NIHILO	The dataset has been constructed ex nihilo.

Definition at line 984 of file ASDM.h.

Constructor & Destructor Documentation

asdm::ASDM::ASDM ( )

Constructs an empty ASDM.

virtual asdm::ASDM::~ASDM ( )

virtual

Member Function Documentation

bool asdm::ASDM::checkRowUniqueness ( ) const

Returns a boolean value indicating if a control of the uniqueness of each row of each table is done during the execution of the method setFromFile.

Returns: a bool.

see the documentation of ASDMParseOptions about how to set this parameter.

void asdm::ASDM::error ( )

private

static ASDM* asdm::ASDM::fromArchive ( EntityId datasetId )

static

Create an ASDM dataset from the ALMA archive, given the entityId of its container.

Parameters

datasetId The entityId of the container of the dataset.

Exceptions

ConversionException

virtual void asdm::ASDM::fromIDL ( asdmIDL::ASDMDataSetIDL * x )

virtual

Builds an ASDM out of its IDL representation.

Parameters

x	the IDL representation of the ASDM

Exceptions

DuplicateKey
ConversionException
UniquenessViolationException

virtual void asdm::ASDM::fromXML ( std::string xml )

virtual

Get an ASDM dataset, given the full path name of the directory containing the XML version of the dataset.

Parameters

xmlDirectory The full path name of the directory containing this dataset.

Returns: The complete dataset that belongs to the container in this directory.

Exceptions

ConversionException If any error occurs reading the files in the directory or in converting the tables from XML.

AlmaRadiometerTable& asdm::ASDM::getAlmaRadiometer ( ) const

Get the table AlmaRadiometer.

Returns: The table AlmaRadiometer as a AlmaRadiometerTable.

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

Get the table Annotation.

Returns: The table Annotation as a AnnotationTable.

AntennaTable& asdm::ASDM::getAntenna ( ) const

Get the table Antenna.

Returns: The table Antenna as a AntennaTable.

CalAmpliTable& asdm::ASDM::getCalAmpli ( ) const

Get the table CalAmpli.

Returns: The table CalAmpli as a CalAmpliTable.

CalAntennaSolutionsTable& asdm::ASDM::getCalAntennaSolutions ( ) const

Get the table CalAntennaSolutions.

Returns: The table CalAntennaSolutions as a CalAntennaSolutionsTable.

CalAppPhaseTable& asdm::ASDM::getCalAppPhase ( ) const

Get the table CalAppPhase.

Returns: The table CalAppPhase as a CalAppPhaseTable.

CalAtmosphereTable& asdm::ASDM::getCalAtmosphere ( ) const

Get the table CalAtmosphere.

Returns: The table CalAtmosphere as a CalAtmosphereTable.

CalBandpassTable& asdm::ASDM::getCalBandpass ( ) const

Get the table CalBandpass.

Returns: The table CalBandpass as a CalBandpassTable.

CalCurveTable& asdm::ASDM::getCalCurve ( ) const

Get the table CalCurve.

Returns: The table CalCurve as a CalCurveTable.

CalDataTable& asdm::ASDM::getCalData ( ) const

Get the table CalData.

Returns: The table CalData as a CalDataTable.

CalDelayTable& asdm::ASDM::getCalDelay ( ) const

Get the table CalDelay.

Returns: The table CalDelay as a CalDelayTable.

CalDeviceTable& asdm::ASDM::getCalDevice ( ) const

Get the table CalDevice.

Returns: The table CalDevice as a CalDeviceTable.

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

Get the table CalFlux.

Returns: The table CalFlux as a CalFluxTable.

CalFocusTable& asdm::ASDM::getCalFocus ( ) const

Get the table CalFocus.

Returns: The table CalFocus as a CalFocusTable.

CalFocusModelTable& asdm::ASDM::getCalFocusModel ( ) const

Get the table CalFocusModel.

Returns: The table CalFocusModel as a CalFocusModelTable.

CalGainTable& asdm::ASDM::getCalGain ( ) const

Get the table CalGain.

Returns: The table CalGain as a CalGainTable.

CalHolographyTable& asdm::ASDM::getCalHolography ( ) const

Get the table CalHolography.

Returns: The table CalHolography as a CalHolographyTable.

CalPhaseTable& asdm::ASDM::getCalPhase ( ) const

Get the table CalPhase.

Returns: The table CalPhase as a CalPhaseTable.

CalPointingTable& asdm::ASDM::getCalPointing ( ) const

Get the table CalPointing.

Returns: The table CalPointing as a CalPointingTable.

CalPointingModelTable& asdm::ASDM::getCalPointingModel ( ) const

Get the table CalPointingModel.

Returns: The table CalPointingModel as a CalPointingModelTable.

CalPositionTable& asdm::ASDM::getCalPosition ( ) const

Get the table CalPosition.

Returns: The table CalPosition as a CalPositionTable.

CalPrimaryBeamTable& asdm::ASDM::getCalPrimaryBeam ( ) const

Get the table CalPrimaryBeam.

Returns: The table CalPrimaryBeam as a CalPrimaryBeamTable.

CalReductionTable& asdm::ASDM::getCalReduction ( ) const

Get the table CalReduction.

Returns: The table CalReduction as a CalReductionTable.

CalSeeingTable& asdm::ASDM::getCalSeeing ( ) const

Get the table CalSeeing.

Returns: The table CalSeeing as a CalSeeingTable.

CalWVRTable& asdm::ASDM::getCalWVR ( ) const

Get the table CalWVR.

Returns: The table CalWVR as a CalWVRTable.

ConfigDescriptionTable& asdm::ASDM::getConfigDescription ( ) const

Get the table ConfigDescription.

Returns: The table ConfigDescription as a ConfigDescriptionTable.

CorrelatorModeTable& asdm::ASDM::getCorrelatorMode ( ) const

Get the table CorrelatorMode.

Returns: The table CorrelatorMode as a CorrelatorModeTable.

DataDescriptionTable& asdm::ASDM::getDataDescription ( ) const

Get the table DataDescription.

Returns: The table DataDescription as a DataDescriptionTable.

DelayModelTable& asdm::ASDM::getDelayModel ( ) const

Get the table DelayModel.

Returns: The table DelayModel as a DelayModelTable.

DelayModelFixedParametersTable& asdm::ASDM::getDelayModelFixedParameters ( ) const

Get the table DelayModelFixedParameters.

Returns: The table DelayModelFixedParameters as a DelayModelFixedParametersTable.

DelayModelVariableParametersTable& asdm::ASDM::getDelayModelVariableParameters ( ) const

Get the table DelayModelVariableParameters.

Returns: The table DelayModelVariableParameters as a DelayModelVariableParametersTable.

std::string asdm::ASDM::getDirectory ( ) const

Returns the ASDM's directory.

Returns: a string containing path to the directory containing the external representation of the ASDM if it has been constructed from this representation or an empty string if it has been constructed ex nihilo.

DopplerTable& asdm::ASDM::getDoppler ( ) const

Get the table Doppler.

Returns: The table Doppler as a DopplerTable.

virtual Entity asdm::ASDM::getEntity ( ) const

virtual

EphemerisTable& asdm::ASDM::getEphemeris ( ) const

Get the table Ephemeris.

Returns: The table Ephemeris as a EphemerisTable.

ExecBlockTable& asdm::ASDM::getExecBlock ( ) const

Get the table ExecBlock.

Returns: The table ExecBlock as a ExecBlockTable.

FeedTable& asdm::ASDM::getFeed ( ) const

Get the table Feed.

Returns: The table Feed as a FeedTable.

FieldTable& asdm::ASDM::getField ( ) const

Get the table Field.

Returns: The table Field as a FieldTable.

FlagTable& asdm::ASDM::getFlag ( ) const

Get the table Flag.

Returns: The table Flag as a FlagTable.

FlagCmdTable& asdm::ASDM::getFlagCmd ( ) const

Get the table FlagCmd.

Returns: The table FlagCmd as a FlagCmdTable.

FocusTable& asdm::ASDM::getFocus ( ) const

Get the table Focus.

Returns: The table Focus as a FocusTable.

FocusModelTable& asdm::ASDM::getFocusModel ( ) const

Get the table FocusModel.

Returns: The table FocusModel as a FocusModelTable.

FreqOffsetTable& asdm::ASDM::getFreqOffset ( ) const

Get the table FreqOffset.

Returns: The table FreqOffset as a FreqOffsetTable.

static ASDM* asdm::ASDM::getFromXML ( std::string xmlDirectory )

static

Get an ASDM dataset, given the full path name of the directory containing the XML version of the dataset.

Parameters

xmlDirectory The full path name of the directory containing this dataset.

Returns: The complete dataset that belongs to the container in this directory.

Exceptions

ConversionException If any error occurs reading the files in the directory or in converting the tables from XML.

Deprecated:

GainTrackingTable& asdm::ASDM::getGainTracking ( ) const

Get the table GainTracking.

Returns: The table GainTracking as a GainTrackingTable.

HistoryTable& asdm::ASDM::getHistory ( ) const

Get the table History.

Returns: The table History as a HistoryTable.

HolographyTable& asdm::ASDM::getHolography ( ) const

Get the table Holography.

Returns: The table Holography as a HolographyTable.

MainTable& asdm::ASDM::getMain ( ) const

Get the table Main.

Returns: The table Main as a MainTable.

virtual std::string asdm::ASDM::getName ( ) const

virtual

Meaningless, but required for the Representable interface.

ObservationTable& asdm::ASDM::getObservation ( ) const

Get the table Observation.

Returns: The table Observation as a ObservationTable.

Origin asdm::ASDM::getOrigin ( ) const

Returns the origin of the dataset in memory.

Returns: an ASDM::Origin value.

PointingTable& asdm::ASDM::getPointing ( ) const

Get the table Pointing.

Returns: The table Pointing as a PointingTable.

PointingModelTable& asdm::ASDM::getPointingModel ( ) const

Get the table PointingModel.

Returns: The table PointingModel as a PointingModelTable.

PolarizationTable& asdm::ASDM::getPolarization ( ) const

Get the table Polarization.

Returns: The table Polarization as a PolarizationTable.

ProcessorTable& asdm::ASDM::getProcessor ( ) const

Get the table Processor.

Returns: The table Processor as a ProcessorTable.

PulsarTable& asdm::ASDM::getPulsar ( ) const

Get the table Pulsar.

Returns: The table Pulsar as a PulsarTable.

ReceiverTable& asdm::ASDM::getReceiver ( ) const

Get the table Receiver.

Returns: The table Receiver as a ReceiverTable.

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

Get the table SBSummary.

Returns: The table SBSummary as a SBSummaryTable.

ScaleTable& asdm::ASDM::getScale ( ) const

Get the table Scale.

Returns: The table Scale as a ScaleTable.

ScanTable& asdm::ASDM::getScan ( ) const

Get the table Scan.

Returns: The table Scan as a ScanTable.

SeeingTable& asdm::ASDM::getSeeing ( ) const

Get the table Seeing.

Returns: The table Seeing as a SeeingTable.

SourceTable& asdm::ASDM::getSource ( ) const

Get the table Source.

Returns: The table Source as a SourceTable.

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

Get the table SpectralWindow.

Returns: The table SpectralWindow as a SpectralWindowTable.

SquareLawDetectorTable& asdm::ASDM::getSquareLawDetector ( ) const

Get the table SquareLawDetector.

Returns: The table SquareLawDetector as a SquareLawDetectorTable.

StateTable& asdm::ASDM::getState ( ) const

Get the table State.

Returns: The table State as a StateTable.

StationTable& asdm::ASDM::getStation ( ) const

Get the table Station.

Returns: The table Station as a StationTable.

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

Get the table Subscan.

Returns: The table Subscan as a SubscanTable.

SwitchCycleTable& asdm::ASDM::getSwitchCycle ( ) const

Get the table SwitchCycle.

Returns: The table SwitchCycle as a SwitchCycleTable.

SysCalTable& asdm::ASDM::getSysCal ( ) const

Get the table SysCal.

Returns: The table SysCal as a SysCalTable.

SysPowerTable& asdm::ASDM::getSysPower ( ) const

Get the table SysPower.

Returns: The table SysPower as a SysPowerTable.

Representable& asdm::ASDM::getTable ( std::string tableName )

Return the table, as a Representable object, with the specified name.

Exceptions

InvalidArgumentException

Referenced by asdm::TableStreamReader< T, R >::nextNRows(), and asdm::TableStreamReader< T, R >::untilNBytes().

ArrayTime asdm::ASDM::getTimeOfCreation ( ) const

===> Attribute timeOfCreation

Get timeOfCreation.

Returns: timeOfCreation as ArrayTime

TotalPowerTable& asdm::ASDM::getTotalPower ( ) const

Get the table TotalPower.

Returns: The table TotalPower as a TotalPowerTable.

int asdm::ASDM::getVersion ( ) const

===> Attribute version

Get version.

Returns: version as int

WeatherTable& asdm::ASDM::getWeather ( ) const

Get the table Weather.

Returns: The table Weather as a WeatherTable.

WVMCalTable& asdm::ASDM::getWVMCal ( ) const

Get the table WVMCal.

Returns: The table WVMCal as a WVMCalTable.

static std::string asdm::ASDM::getXMLEntity ( EntityId )

staticprivate

std::string asdm::ASDM::getXmlnsPrefix ( ) const

===> Attribute xmlnsPrefix

Get xmlnsPrefix.

Returns: xmlnsPrefix as std::string

XSLTransformer& asdm::ASDM::getXSLTransformer ( )

static void asdm::ASDM::putXMLEntity ( std::string )

staticprivate

virtual void asdm::ASDM::setEntity ( Entity e )

virtual

void asdm::ASDM::setFromFile	(	std::string	directory,
		bool	loadTablesOnDemand
	)

Constructs totally or partially an ASDM dataset from its representation on disk.

Reads and parses a file (ASDM.xml) containing the top level element of an ASDM. Depending on the value of the boolean parameter loadTablesOnDemand the files containing the tables of of the dataset are parsed to populate the dataset in memory immediately (false) or only when an application tries to retrieve values from these tables (true).

Parameters

directory	the name of the directory containing the files.
loadTablesOnDemand	the tables are read and parsed immediately (false) or only when necessary (true).

Exceptions

ConversionException If any error occurs while reading the files in the directory or parsing them.

void asdm::ASDM::setFromFile	(	std::string	directory,
		const ASDMParseOptions &	parse = `ASDMParseOptions()`
	)

Constructs an ASDM dataset from its representation on disk.

Reads and parses a file (ASDM.xml) containing the top level element of an ASDM and then the files containing the representation on disk of the dataset's tables. On exit the dataset contains all its tables in memory.

Backward compatibility. This method presents some level of backward compatibility in the sense that it does its best to check if the dataset needs to be transformed on the fly to the currently defined format prior being parsed and converted to its in memory representation. In order to do that it may need to find the version information of the dataset and possibly its origin (i.e. which telescope has created it). Based on these informations it decides if if a transformation has to be applied on the fly or if the dataset can be processed as is.

Helping backward compatibility It may happen though that the algorithm which searches the dataset for its version information and its origin fails, while the user knows that his/her dataset can be parsed. Then the method's behaviour can be controlled by using the second (and optional) argument parse which has to be an instance of ASDMParseOptions. See below the description of this argument to undersand how to use it.

Parameters

directory the name of the directory containing the files.

parse

an instance of ASDMParseOptions which can be used to tailor the behaviour of the method. Please read the definition of ASDMParseOptions to see how the logic of the method can be controlled. Most of the time it wont be necessary to specify this argument hence the fact it's optional. The typical cases when one may have to use this argument are :

The version information cannot be derived from the content of the ASDM and you want to force the method to consider its format as the most recent one or the older one. In such a case present an ASDMParseOptions instance onto which you have applied .asV3() or .asV2().
The origin of the data cannot be retrieved from the content of the ASDM; this happens when the dataset has not ExecbBlock table. Then one can help the method by providing an instance of ASDMParseOptions onto which one of .asALMA(), .asIRAM_PDB(), .asEVLA() has been applied.
One wants to control if all the tables of the dataset must be parsed and put into memory during the execution of the method or if one prefers to load them on on demand (i.e. a table is loaded in memory only the first time it's referred by the code.). One will present an instance of ASDMParseOptions onto which .loadTablesOnDemand(b) hase been called where b is boolean value interpreted as follows : true <->"load on demand" and false <-> "load the tables immediately."

Exceptions

ConversionException If any error occurs while reading the files in the directory or parsing them.

void asdm::ASDM::setFromMIME ( const std::string & )

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::ASDM::setTimeOfCreation ( ArrayTime timeOfCreation )

Set timeOfCreation with the specified ArrayTime.

Parameters

timeOfCreation The ArrayTime value to which timeOfCreation is to be set.

void asdm::ASDM::setVersion ( int version )

Set version with the specified int.

Parameters

version The int value to which version is to be set.

void asdm::ASDM::setXmlnsPrefix ( std::string xmlnsPrefix )

Set xmlnsPrefix with the specified std::string.

Parameters

xmlnsPrefix The std::string value to which xmlnsPrefix is to be set.

virtual unsigned int asdm::ASDM::size ( )

virtual

Meaningless, but required for the Representable interface.

void asdm::ASDM::toFile ( std::string directory )

Write this ASDM dataset to the specified directory as a collection of files.

The container itself is written into an XML file. Each table of the container having at least one row is written into a binary or an XML file depending on the value of its "fileAsBin" private field.

Parameters

directory The directory to which this dataset is written.

Exceptions

ConversionException If any error occurs in converting the container or any of its table. This method will not overwrite any existing file; a ConversionException is also thrown in this case.

virtual asdmIDL::ASDMDataSetIDL* asdm::ASDM::toIDL ( )

virtual

Converts this ASDM into an ASDMDataSetIDL CORBA structure.

Returns: a pointer to a ASDMDataSetIDL.

std::string asdm::ASDM::toMIME ( )

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

Returns: a string containing the MIME message.

virtual std::string asdm::ASDM::toXML ( ) const

virtual

Produces the XML representation of * this.

Returns: a string containing the XML representation of this.

Exceptions

ConversionException.

void asdm::ASDM::toXML ( std::string directory ) const

Write this ASDM dataset to the specified directory as a collection of XML documents.

Parameters

directory The directory to which this dataset is written.

Exceptions

ConversionException If any error occurs in converting the table to XML and writing it to the directory. This method will not overwrite any existing file; a ConversionException is also thrown in this case.

void asdm::ASDM::updateArchive ( ) const

Update an ASDM dataset that already exists in the ALMA archive.

Exceptions

ConversionException

Member Data Documentation

AlmaRadiometerTable* asdm::ASDM::almaRadiometer

private

The table AlmaRadiometer.

Definition at line 1027 of file ASDM.h.

AnnotationTable* asdm::ASDM::annotation

private

The table Annotation.

Definition at line 1032 of file ASDM.h.

AntennaTable* asdm::ASDM::antenna

private

The table Antenna.

Definition at line 1037 of file ASDM.h.

bool asdm::ASDM::archiveAsBin

private

Definition at line 1010 of file ASDM.h.

CalAmpliTable* asdm::ASDM::calAmpli

private

The table CalAmpli.

Definition at line 1042 of file ASDM.h.

CalAntennaSolutionsTable* asdm::ASDM::calAntennaSolutions

private

The table CalAntennaSolutions.

Definition at line 1047 of file ASDM.h.

CalAppPhaseTable* asdm::ASDM::calAppPhase

private

The table CalAppPhase.

Definition at line 1052 of file ASDM.h.

CalAtmosphereTable* asdm::ASDM::calAtmosphere

private

The table CalAtmosphere.

Definition at line 1057 of file ASDM.h.

CalBandpassTable* asdm::ASDM::calBandpass

private

The table CalBandpass.

Definition at line 1062 of file ASDM.h.

CalCurveTable* asdm::ASDM::calCurve

private

The table CalCurve.

Definition at line 1067 of file ASDM.h.

CalDataTable* asdm::ASDM::calData

private

The table CalData.

Definition at line 1072 of file ASDM.h.

CalDelayTable* asdm::ASDM::calDelay

private

The table CalDelay.

Definition at line 1077 of file ASDM.h.

CalDeviceTable* asdm::ASDM::calDevice

private

The table CalDevice.

Definition at line 1082 of file ASDM.h.

CalFluxTable* asdm::ASDM::calFlux

private

The table CalFlux.

Definition at line 1087 of file ASDM.h.

CalFocusTable* asdm::ASDM::calFocus

private

The table CalFocus.

Definition at line 1092 of file ASDM.h.

CalFocusModelTable* asdm::ASDM::calFocusModel

private

The table CalFocusModel.

Definition at line 1097 of file ASDM.h.

CalGainTable* asdm::ASDM::calGain

private

The table CalGain.

Definition at line 1102 of file ASDM.h.

CalHolographyTable* asdm::ASDM::calHolography

private

The table CalHolography.

Definition at line 1107 of file ASDM.h.

CalPhaseTable* asdm::ASDM::calPhase

private

The table CalPhase.

Definition at line 1112 of file ASDM.h.

CalPointingTable* asdm::ASDM::calPointing

private

The table CalPointing.

Definition at line 1117 of file ASDM.h.

CalPointingModelTable* asdm::ASDM::calPointingModel

private

The table CalPointingModel.

Definition at line 1122 of file ASDM.h.

CalPositionTable* asdm::ASDM::calPosition

private

The table CalPosition.

Definition at line 1127 of file ASDM.h.

CalPrimaryBeamTable* asdm::ASDM::calPrimaryBeam

private

The table CalPrimaryBeam.

Definition at line 1132 of file ASDM.h.

CalReductionTable* asdm::ASDM::calReduction

private

The table CalReduction.

Definition at line 1137 of file ASDM.h.

CalSeeingTable* asdm::ASDM::calSeeing

private

The table CalSeeing.

Definition at line 1142 of file ASDM.h.

CalWVRTable* asdm::ASDM::calWVR

private

The table CalWVR.

Definition at line 1147 of file ASDM.h.

bool asdm::ASDM::checkRowUniqueness_

private

Definition at line 1015 of file ASDM.h.

ConfigDescriptionTable* asdm::ASDM::configDescription

private

The table ConfigDescription.

Definition at line 1152 of file ASDM.h.

CorrelatorModeTable* asdm::ASDM::correlatorMode

private

The table CorrelatorMode.

Definition at line 1157 of file ASDM.h.

DataDescriptionTable* asdm::ASDM::dataDescription

private

The table DataDescription.

Definition at line 1162 of file ASDM.h.

DelayModelTable* asdm::ASDM::delayModel

private

The table DelayModel.

Definition at line 1167 of file ASDM.h.

DelayModelFixedParametersTable* asdm::ASDM::delayModelFixedParameters

private

The table DelayModelFixedParameters.

Definition at line 1172 of file ASDM.h.

DelayModelVariableParametersTable* asdm::ASDM::delayModelVariableParameters

private

The table DelayModelVariableParameters.

Definition at line 1177 of file ASDM.h.

std::string asdm::ASDM::directory_

private

Definition at line 1016 of file ASDM.h.

DopplerTable* asdm::ASDM::doppler

private

The table Doppler.

Definition at line 1182 of file ASDM.h.

Entity asdm::ASDM::entity

private

This Container's entity.

Definition at line 1373 of file ASDM.h.

EphemerisTable* asdm::ASDM::ephemeris

private

The table Ephemeris.

Definition at line 1187 of file ASDM.h.

ExecBlockTable* asdm::ASDM::execBlock

private

The table ExecBlock.

Definition at line 1192 of file ASDM.h.

FeedTable* asdm::ASDM::feed

private

The table Feed.

Definition at line 1197 of file ASDM.h.

FieldTable* asdm::ASDM::field

private

The table Field.

Definition at line 1202 of file ASDM.h.

bool asdm::ASDM::fileAsBin

private

Definition at line 1011 of file ASDM.h.

FlagTable* asdm::ASDM::flag

private

The table Flag.

Definition at line 1207 of file ASDM.h.

FlagCmdTable* asdm::ASDM::flagCmd

private

The table FlagCmd.

Definition at line 1212 of file ASDM.h.

FocusTable* asdm::ASDM::focus

private

The table Focus.

Definition at line 1217 of file ASDM.h.

FocusModelTable* asdm::ASDM::focusModel

private

The table FocusModel.

Definition at line 1222 of file ASDM.h.

FreqOffsetTable* asdm::ASDM::freqOffset

private

The table FreqOffset.

Definition at line 1227 of file ASDM.h.

GainTrackingTable* asdm::ASDM::gainTracking

private

The table GainTracking.

Definition at line 1232 of file ASDM.h.

bool asdm::ASDM::hasBeenAdded

private

Definition at line 1012 of file ASDM.h.

HistoryTable* asdm::ASDM::history

private

The table History.

Definition at line 1237 of file ASDM.h.

HolographyTable* asdm::ASDM::holography

private

The table Holography.

Definition at line 1242 of file ASDM.h.

bool asdm::ASDM::loadTablesOnDemand_

private

Definition at line 1014 of file ASDM.h.

MainTable* asdm::ASDM::main

private

The table Main.

Definition at line 1022 of file ASDM.h.

ObservationTable* asdm::ASDM::observation

private

The table Observation.

Definition at line 1247 of file ASDM.h.

Origin asdm::ASDM::origin

private

Definition at line 1013 of file ASDM.h.

PointingTable* asdm::ASDM::pointing

private

The table Pointing.

Definition at line 1252 of file ASDM.h.

PointingModelTable* asdm::ASDM::pointingModel

private

The table PointingModel.

Definition at line 1257 of file ASDM.h.

PolarizationTable* asdm::ASDM::polarization

private

The table Polarization.

Definition at line 1262 of file ASDM.h.

ProcessorTable* asdm::ASDM::processor

private

The table Processor.

Definition at line 1267 of file ASDM.h.

PulsarTable* asdm::ASDM::pulsar

private

The table Pulsar.

Definition at line 1272 of file ASDM.h.

ReceiverTable* asdm::ASDM::receiver

private

The table Receiver.

Definition at line 1277 of file ASDM.h.

SBSummaryTable* asdm::ASDM::sBSummary

private

The table SBSummary.

Definition at line 1282 of file ASDM.h.

ScaleTable* asdm::ASDM::scale

private

The table Scale.

Definition at line 1287 of file ASDM.h.

ScanTable* asdm::ASDM::scan

private

The table Scan.

Definition at line 1292 of file ASDM.h.

SeeingTable* asdm::ASDM::seeing

private

The table Seeing.

Definition at line 1297 of file ASDM.h.

SourceTable* asdm::ASDM::source

private

The table Source.

Definition at line 1302 of file ASDM.h.

SpectralWindowTable* asdm::ASDM::spectralWindow

private

The table SpectralWindow.

Definition at line 1307 of file ASDM.h.

SquareLawDetectorTable* asdm::ASDM::squareLawDetector

private

The table SquareLawDetector.

Definition at line 1312 of file ASDM.h.

StateTable* asdm::ASDM::state

private

The table State.

Definition at line 1317 of file ASDM.h.

StationTable* asdm::ASDM::station

private

The table Station.

Definition at line 1322 of file ASDM.h.

SubscanTable* asdm::ASDM::subscan

private

The table Subscan.

Definition at line 1327 of file ASDM.h.

SwitchCycleTable* asdm::ASDM::switchCycle

private

The table SwitchCycle.

Definition at line 1332 of file ASDM.h.

SysCalTable* asdm::ASDM::sysCal

private

The table SysCal.

Definition at line 1337 of file ASDM.h.

SysPowerTable* asdm::ASDM::sysPower

private

The table SysPower.

Definition at line 1342 of file ASDM.h.

std::vector<Representable *> asdm::ASDM::table

private

The list of tables as Representable.

Definition at line 1362 of file ASDM.h.

std::map<std::string, Entity> asdm::ASDM::tableEntity

private

The list of Entity objects representing the tables.

vector<Entity *> tableEntity;

Definition at line 1368 of file ASDM.h.

ArrayTime asdm::ASDM::timeOfCreation

private

===> Attribute timeOfCreation

Definition at line 1381 of file ASDM.h.

TotalPowerTable* asdm::ASDM::totalPower

private

The table TotalPower.

Definition at line 1347 of file ASDM.h.

int asdm::ASDM::version

private

===> Attribute version

Definition at line 1392 of file ASDM.h.

WeatherTable* asdm::ASDM::weather

private

The table Weather.

Definition at line 1357 of file ASDM.h.

WVMCalTable* asdm::ASDM::wVMCal

private

The table WVMCal.

Definition at line 1352 of file ASDM.h.

std::string asdm::ASDM::xmlnsPrefix

private

===> Attribute xmlnsPrefix

Definition at line 1403 of file ASDM.h.

XSLTransformer asdm::ASDM::xslTransformer

private

Definition at line 1414 of file ASDM.h.

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

casa/code/alma/ASDM/ASDM.h

Public Types

Public Member Functions

Static Public Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation