asdm::ASDM Class Reference

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

#include <ASDM.h>

List of all members.

Public Types
enum	Origin {   FILE,   ARCHIVE,   EX_NIHILO,   FILE,   ARCHIVE,   EX_NIHILO }
	This enumeration lists the different possible origins for an ASDM present in memory. More...
enum	Origin {   FILE,   ARCHIVE,   EX_NIHILO,   FILE,   ARCHIVE,   EX_NIHILO }
Public Member Functions
	ASDM ()
	Constructs an empty ASDM.
virtual	~ASDM ()
MainTable &	getMain () const
	Get the table Main.
AlmaRadiometerTable &	getAlmaRadiometer () const
	Get the table AlmaRadiometer.
AnnotationTable &	getAnnotation () const
	Get the table Annotation.
AntennaTable &	getAntenna () const
	Get the table Antenna.
CalAmpliTable &	getCalAmpli () const
	Get the table CalAmpli.
CalAtmosphereTable &	getCalAtmosphere () const
	Get the table CalAtmosphere.
CalBandpassTable &	getCalBandpass () const
	Get the table CalBandpass.
CalCurveTable &	getCalCurve () const
	Get the table CalCurve.
CalDataTable &	getCalData () const
	Get the table CalData.
CalDelayTable &	getCalDelay () const
	Get the table CalDelay.
CalDeviceTable &	getCalDevice () const
	Get the table CalDevice.
CalFluxTable &	getCalFlux () const
	Get the table CalFlux.
CalFocusTable &	getCalFocus () const
	Get the table CalFocus.
CalFocusModelTable &	getCalFocusModel () const
	Get the table CalFocusModel.
CalGainTable &	getCalGain () const
	Get the table CalGain.
CalHolographyTable &	getCalHolography () const
	Get the table CalHolography.
CalPhaseTable &	getCalPhase () const
	Get the table CalPhase.
CalPointingTable &	getCalPointing () const
	Get the table CalPointing.
CalPointingModelTable &	getCalPointingModel () const
	Get the table CalPointingModel.
CalPositionTable &	getCalPosition () const
	Get the table CalPosition.
CalPrimaryBeamTable &	getCalPrimaryBeam () const
	Get the table CalPrimaryBeam.
CalReductionTable &	getCalReduction () const
	Get the table CalReduction.
CalSeeingTable &	getCalSeeing () const
	Get the table CalSeeing.
CalWVRTable &	getCalWVR () const
	Get the table CalWVR.
ConfigDescriptionTable &	getConfigDescription () const
	Get the table ConfigDescription.
CorrelatorModeTable &	getCorrelatorMode () const
	Get the table CorrelatorMode.
DataDescriptionTable &	getDataDescription () const
	Get the table DataDescription.
DelayModelTable &	getDelayModel () const
	Get the table DelayModel.
DopplerTable &	getDoppler () const
	Get the table Doppler.
EphemerisTable &	getEphemeris () const
	Get the table Ephemeris.
ExecBlockTable &	getExecBlock () const
	Get the table ExecBlock.
FeedTable &	getFeed () const
	Get the table Feed.
FieldTable &	getField () const
	Get the table Field.
FlagTable &	getFlag () const
	Get the table Flag.
FlagCmdTable &	getFlagCmd () const
	Get the table FlagCmd.
FocusTable &	getFocus () const
	Get the table Focus.
FocusModelTable &	getFocusModel () const
	Get the table FocusModel.
FreqOffsetTable &	getFreqOffset () const
	Get the table FreqOffset.
GainTrackingTable &	getGainTracking () const
	Get the table GainTracking.
HistoryTable &	getHistory () const
	Get the table History.
HolographyTable &	getHolography () const
	Get the table Holography.
ObservationTable &	getObservation () const
	Get the table Observation.
PointingTable &	getPointing () const
	Get the table Pointing.
PointingModelTable &	getPointingModel () const
	Get the table PointingModel.
PolarizationTable &	getPolarization () const
	Get the table Polarization.
ProcessorTable &	getProcessor () const
	Get the table Processor.
ReceiverTable &	getReceiver () const
	Get the table Receiver.
SBSummaryTable &	getSBSummary () const
	Get the table SBSummary.
ScaleTable &	getScale () const
	Get the table Scale.
ScanTable &	getScan () const
	Get the table Scan.
SeeingTable &	getSeeing () const
	Get the table Seeing.
SourceTable &	getSource () const
	Get the table Source.
SpectralWindowTable &	getSpectralWindow () const
	Get the table SpectralWindow.
SquareLawDetectorTable &	getSquareLawDetector () const
	Get the table SquareLawDetector.
StateTable &	getState () const
	Get the table State.
StationTable &	getStation () const
	Get the table Station.
SubscanTable &	getSubscan () const
	Get the table Subscan.
SwitchCycleTable &	getSwitchCycle () const
	Get the table SwitchCycle.
SysCalTable &	getSysCal () const
	Get the table SysCal.
SysPowerTable &	getSysPower () const
	Get the table SysPower.
TotalPowerTable &	getTotalPower () const
	Get the table TotalPower.
WVMCalTable &	getWVMCal () const
	Get the table WVMCal.
WeatherTable &	getWeather () const
	Get the table Weather.
virtual std::string	toXML ()
	Produces the XML representation of * this.
void	toXML (std::string directory)
	Write this ASDM dataset to the specified directory as a collection of XML documents.
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.
std::string	toMIME ()
	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.
void	toFile (std::string directory)
	Write this ASDM dataset to the specified directory as a collection of files.
void	setFromFile (std::string directory, bool loadTablesOnDemand)
	Constructs totally or partially an ASDM dataset from its representation on disk.
void	setFromFile (std::string directory, const ASDMParseOptions &parse=ASDMParseOptions())
	Constructs an ASDM dataset from its representation on disk.
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.
virtual asdmIDL::ASDMDataSetIDL *	toIDL ()
	Converts this ASDM into an ASDMDataSetIDL CORBA structure.
virtual void	fromIDL (asdmIDL::ASDMDataSetIDL *x)
	Builds an ASDM out of its IDL representation.
virtual Entity	getEntity () const
virtual void	setEntity (Entity e)
virtual std::string	getName () const
	Meaningless, but required for the Representable interface.
virtual unsigned int	size ()
	Meaningless, but required for the Representable interface.
void	updateArchive () const
	Update an ASDM dataset that already exists in the ALMA archive.
Representable &	getTable (std::string tableName)
	Return the table, as a Representable object, with the specified name.
ArrayTime	getTimeOfCreation () const
	===> Attribute timeOfCreation
void	setTimeOfCreation (ArrayTime timeOfCreation)
	Set timeOfCreation with the specified ArrayTime.
int	getVersion () const
	===> Attribute version
void	setVersion (int version)
	Set version with the specified int.
string	getXmlnsPrefix () const
	===> Attribute xmlnsPrefix
void	setXmlnsPrefix (string xmlnsPrefix)
	Set xmlnsPrefix with the specified string.
Origin	getOrigin () const
	Returns the origin of the dataset in memory.
std::string	getDirectory () const
	Returns the ASDM's directory.
XSLTransformer &	getXSLTransformer ()
	ASDM ()
	Constructs an empty ASDM.
virtual	~ASDM ()
MainTable &	getMain () const
	Get the table Main.
AlmaRadiometerTable &	getAlmaRadiometer () const
	Get the table AlmaRadiometer.
AnnotationTable &	getAnnotation () const
	Get the table Annotation.
AntennaTable &	getAntenna () const
	Get the table Antenna.
CalAmpliTable &	getCalAmpli () const
	Get the table CalAmpli.
CalAtmosphereTable &	getCalAtmosphere () const
	Get the table CalAtmosphere.
CalBandpassTable &	getCalBandpass () const
	Get the table CalBandpass.
CalCurveTable &	getCalCurve () const
	Get the table CalCurve.
CalDataTable &	getCalData () const
	Get the table CalData.
CalDelayTable &	getCalDelay () const
	Get the table CalDelay.
CalDeviceTable &	getCalDevice () const
	Get the table CalDevice.
CalFluxTable &	getCalFlux () const
	Get the table CalFlux.
CalFocusTable &	getCalFocus () const
	Get the table CalFocus.
CalFocusModelTable &	getCalFocusModel () const
	Get the table CalFocusModel.
CalGainTable &	getCalGain () const
	Get the table CalGain.
CalHolographyTable &	getCalHolography () const
	Get the table CalHolography.
CalPhaseTable &	getCalPhase () const
	Get the table CalPhase.
CalPointingTable &	getCalPointing () const
	Get the table CalPointing.
CalPointingModelTable &	getCalPointingModel () const
	Get the table CalPointingModel.
CalPositionTable &	getCalPosition () const
	Get the table CalPosition.
CalPrimaryBeamTable &	getCalPrimaryBeam () const
	Get the table CalPrimaryBeam.
CalReductionTable &	getCalReduction () const
	Get the table CalReduction.
CalSeeingTable &	getCalSeeing () const
	Get the table CalSeeing.
CalWVRTable &	getCalWVR () const
	Get the table CalWVR.
ConfigDescriptionTable &	getConfigDescription () const
	Get the table ConfigDescription.
CorrelatorModeTable &	getCorrelatorMode () const
	Get the table CorrelatorMode.
DataDescriptionTable &	getDataDescription () const
	Get the table DataDescription.
DelayModelTable &	getDelayModel () const
	Get the table DelayModel.
DopplerTable &	getDoppler () const
	Get the table Doppler.
EphemerisTable &	getEphemeris () const
	Get the table Ephemeris.
ExecBlockTable &	getExecBlock () const
	Get the table ExecBlock.
FeedTable &	getFeed () const
	Get the table Feed.
FieldTable &	getField () const
	Get the table Field.
FlagTable &	getFlag () const
	Get the table Flag.
FlagCmdTable &	getFlagCmd () const
	Get the table FlagCmd.
FocusTable &	getFocus () const
	Get the table Focus.
FocusModelTable &	getFocusModel () const
	Get the table FocusModel.
FreqOffsetTable &	getFreqOffset () const
	Get the table FreqOffset.
GainTrackingTable &	getGainTracking () const
	Get the table GainTracking.
HistoryTable &	getHistory () const
	Get the table History.
HolographyTable &	getHolography () const
	Get the table Holography.
ObservationTable &	getObservation () const
	Get the table Observation.
PointingTable &	getPointing () const
	Get the table Pointing.
PointingModelTable &	getPointingModel () const
	Get the table PointingModel.
PolarizationTable &	getPolarization () const
	Get the table Polarization.
ProcessorTable &	getProcessor () const
	Get the table Processor.
ReceiverTable &	getReceiver () const
	Get the table Receiver.
SBSummaryTable &	getSBSummary () const
	Get the table SBSummary.
ScaleTable &	getScale () const
	Get the table Scale.
ScanTable &	getScan () const
	Get the table Scan.
SeeingTable &	getSeeing () const
	Get the table Seeing.
SourceTable &	getSource () const
	Get the table Source.
SpectralWindowTable &	getSpectralWindow () const
	Get the table SpectralWindow.
SquareLawDetectorTable &	getSquareLawDetector () const
	Get the table SquareLawDetector.
StateTable &	getState () const
	Get the table State.
StationTable &	getStation () const
	Get the table Station.
SubscanTable &	getSubscan () const
	Get the table Subscan.
SwitchCycleTable &	getSwitchCycle () const
	Get the table SwitchCycle.
SysCalTable &	getSysCal () const
	Get the table SysCal.
SysPowerTable &	getSysPower () const
	Get the table SysPower.
TotalPowerTable &	getTotalPower () const
	Get the table TotalPower.
WVMCalTable &	getWVMCal () const
	Get the table WVMCal.
WeatherTable &	getWeather () const
	Get the table Weather.
virtual std::string	toXML ()
	Produces the XML representation of * this.
void	toXML (std::string directory)
	Write this ASDM dataset to the specified directory as a collection of XML documents.
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.
std::string	toMIME ()
	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.
void	toFile (std::string directory)
	Write this ASDM dataset to the specified directory as a collection of files.
void	setFromFile (std::string directory, bool loadTablesOnDemand)
	Constructs totally or partially an ASDM dataset from its representation on disk.
void	setFromFile (std::string directory, const ASDMParseOptions &parse=ASDMParseOptions())
	Constructs an ASDM dataset from its representation on disk.
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.
virtual asdmIDL::ASDMDataSetIDL *	toIDL ()
	Converts this ASDM into an ASDMDataSetIDL CORBA structure.
virtual void	fromIDL (asdmIDL::ASDMDataSetIDL *x)
	Builds an ASDM out of its IDL representation.
virtual Entity	getEntity () const
virtual void	setEntity (Entity e)
virtual std::string	getName () const
	Meaningless, but required for the Representable interface.
virtual unsigned int	size ()
	Meaningless, but required for the Representable interface.
void	updateArchive () const
	Update an ASDM dataset that already exists in the ALMA archive.
Representable &	getTable (std::string tableName)
	Return the table, as a Representable object, with the specified name.
ArrayTime	getTimeOfCreation () const
	===> Attribute timeOfCreation
void	setTimeOfCreation (ArrayTime timeOfCreation)
	Set timeOfCreation with the specified ArrayTime.
int	getVersion () const
	===> Attribute version
void	setVersion (int version)
	Set version with the specified int.
string	getXmlnsPrefix () const
	===> Attribute xmlnsPrefix
void	setXmlnsPrefix (string xmlnsPrefix)
	Set xmlnsPrefix with the specified string.
Origin	getOrigin () const
	Returns the origin of the dataset in memory.
std::string	getDirectory () const
	Returns the ASDM's directory.
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.
static ASDM *	fromArchive (EntityId datasetId)
	Create an ASDM dataset from the ALMA archive, given the entityId of its container.
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.
static ASDM *	fromArchive (EntityId datasetId)
	Create an ASDM dataset from the ALMA archive, given the entityId of its container.
Private Member Functions
void	error ()
void	error ()
Static Private Member Functions
static std::string	getXMLEntity (EntityId id)
static void	putXMLEntity (std::string xml)
static std::string	getXMLEntity (EntityId id)
static void	putXMLEntity (std::string xml)
Private Attributes
bool	archiveAsBin
bool	fileAsBin
bool	hasBeenAdded
Origin	origin
bool	loadTablesOnDemand_
bool	checkRowUniqueness_
std::string	directory
MainTable *	main
	The table Main.
AlmaRadiometerTable *	almaRadiometer
	The table AlmaRadiometer.
AnnotationTable *	annotation
	The table Annotation.
AntennaTable *	antenna
	The table Antenna.
CalAmpliTable *	calAmpli
	The table CalAmpli.
CalAtmosphereTable *	calAtmosphere
	The table CalAtmosphere.
CalBandpassTable *	calBandpass
	The table CalBandpass.
CalCurveTable *	calCurve
	The table CalCurve.
CalDataTable *	calData
	The table CalData.
CalDelayTable *	calDelay
	The table CalDelay.
CalDeviceTable *	calDevice
	The table CalDevice.
CalFluxTable *	calFlux
	The table CalFlux.
CalFocusTable *	calFocus
	The table CalFocus.
CalFocusModelTable *	calFocusModel
	The table CalFocusModel.
CalGainTable *	calGain
	The table CalGain.
CalHolographyTable *	calHolography
	The table CalHolography.
CalPhaseTable *	calPhase
	The table CalPhase.
CalPointingTable *	calPointing
	The table CalPointing.
CalPointingModelTable *	calPointingModel
	The table CalPointingModel.
CalPositionTable *	calPosition
	The table CalPosition.
CalPrimaryBeamTable *	calPrimaryBeam
	The table CalPrimaryBeam.
CalReductionTable *	calReduction
	The table CalReduction.
CalSeeingTable *	calSeeing
	The table CalSeeing.
CalWVRTable *	calWVR
	The table CalWVR.
ConfigDescriptionTable *	configDescription
	The table ConfigDescription.
CorrelatorModeTable *	correlatorMode
	The table CorrelatorMode.
DataDescriptionTable *	dataDescription
	The table DataDescription.
DelayModelTable *	delayModel
	The table DelayModel.
DopplerTable *	doppler
	The table Doppler.
EphemerisTable *	ephemeris
	The table Ephemeris.
ExecBlockTable *	execBlock
	The table ExecBlock.
FeedTable *	feed
	The table Feed.
FieldTable *	field
	The table Field.
FlagTable *	flag
	The table Flag.
FlagCmdTable *	flagCmd
	The table FlagCmd.
FocusTable *	focus
	The table Focus.
FocusModelTable *	focusModel
	The table FocusModel.
FreqOffsetTable *	freqOffset
	The table FreqOffset.
GainTrackingTable *	gainTracking
	The table GainTracking.
HistoryTable *	history
	The table History.
HolographyTable *	holography
	The table Holography.
ObservationTable *	observation
	The table Observation.
PointingTable *	pointing
	The table Pointing.
PointingModelTable *	pointingModel
	The table PointingModel.
PolarizationTable *	polarization
	The table Polarization.
ProcessorTable *	processor
	The table Processor.
ReceiverTable *	receiver
	The table Receiver.
SBSummaryTable *	sBSummary
	The table SBSummary.
ScaleTable *	scale
	The table Scale.
ScanTable *	scan
	The table Scan.
SeeingTable *	seeing
	The table Seeing.
SourceTable *	source
	The table Source.
SpectralWindowTable *	spectralWindow
	The table SpectralWindow.
SquareLawDetectorTable *	squareLawDetector
	The table SquareLawDetector.
StateTable *	state
	The table State.
StationTable *	station
	The table Station.
SubscanTable *	subscan
	The table Subscan.
SwitchCycleTable *	switchCycle
	The table SwitchCycle.
SysCalTable *	sysCal
	The table SysCal.
SysPowerTable *	sysPower
	The table SysPower.
TotalPowerTable *	totalPower
	The table TotalPower.
WVMCalTable *	wVMCal
	The table WVMCal.
WeatherTable *	weather
	The table Weather.
std::vector< Representable * >	table
	The list of tables as Representable.
std::map< std::string, Entity >	tableEntity
	The list of Entity objects representing the tables.
Entity	entity
	This Container's entity.
ArrayTime	timeOfCreation
	===> Attribute timeOfCreation
int	version
	===> Attribute version
string	xmlnsPrefix
	===> Attribute xmlnsPrefix
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.61", branch "HEAD"class ASDM : public Representable {

Definition at line 259 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.
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 940 of file ASDM.h.

enum asdm::ASDM::Origin

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.
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 940 of file ASDM.h.

---

Constructor & Destructor Documentation

asdm::ASDM::ASDM

(

)

Constructs an empty ASDM.

virtual asdm::ASDM::~ASDM

(

)

[virtual]

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.

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]

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

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

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.

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.

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.

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.

CalAmpliTable& asdm::ASDM::getCalAmpli

(

)

const

Get the table CalAmpli.

Returns:

The table CalAmpli as a CalAmpliTable.

CalAtmosphereTable& asdm::ASDM::getCalAtmosphere

(

)

const

Get the table CalAtmosphere.

Returns:

The table CalAtmosphere as a CalAtmosphereTable.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

DelayModelTable& asdm::ASDM::getDelayModel

(

)

const

Get the table DelayModel.

Returns:

The table DelayModel as a DelayModelTable.

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.

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.

DopplerTable& asdm::ASDM::getDoppler

(

)

const

Get the table Doppler.

Returns:

The table Doppler as a DopplerTable.

virtual Entity asdm::ASDM::getEntity

(

)

const [virtual]

virtual Entity asdm::ASDM::getEntity

(

)

const [virtual]

EphemerisTable& asdm::ASDM::getEphemeris

(

)

const

Get the table Ephemeris.

Returns:

The table Ephemeris as a EphemerisTable.

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.

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.

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.

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.

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.

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.

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.

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.

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:

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

ProcessorTable& asdm::ASDM::getProcessor

(

)

const

Get the table Processor.

Returns:

The table Processor as a ProcessorTable.

ReceiverTable& asdm::ASDM::getReceiver

(

)

const

Get the table Receiver.

Returns:

The table Receiver as a ReceiverTable.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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().

Representable& asdm::ASDM::getTable

(

std::string

tableName

)

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

Exceptions:

InvalidArgumentException

ArrayTime asdm::ASDM::getTimeOfCreation

(

)

const

===> Attribute timeOfCreation

Get timeOfCreation.

Returns:

timeOfCreation as ArrayTime

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.

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

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.

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.

WVMCalTable& asdm::ASDM::getWVMCal

(

)

const

Get the table WVMCal.

Returns:

The table WVMCal as a WVMCalTable.

static std::string asdm::ASDM::getXMLEntity

(

EntityId

id

)

[static, private]

static std::string asdm::ASDM::getXMLEntity

(

EntityId

id

)

[static, private]

string asdm::ASDM::getXmlnsPrefix

(

)

const

===> Attribute xmlnsPrefix

Get xmlnsPrefix.

Returns:

xmlnsPrefix as string

string asdm::ASDM::getXmlnsPrefix

(

)

const

===> Attribute xmlnsPrefix

Get xmlnsPrefix.

Returns:

xmlnsPrefix as string

XSLTransformer& asdm::ASDM::getXSLTransformer

(

)

XSLTransformer& asdm::ASDM::getXSLTransformer

(

)

static void asdm::ASDM::putXMLEntity

(

std::string

xml

)

[static, private]

static void asdm::ASDM::putXMLEntity

(

std::string

xml

)

[static, private]

virtual void asdm::ASDM::setEntity

(

Entity

e

)

[virtual]

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,
		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::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 &

mimeMsg

)

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

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::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::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

(

string

xmlnsPrefix

)

Set xmlnsPrefix with the specified string.

Parameters:

xmlnsPrefix

The string value to which xmlnsPrefix is to be set.

void asdm::ASDM::setXmlnsPrefix

(

string

xmlnsPrefix

)

Set xmlnsPrefix with the specified string.

Parameters:

xmlnsPrefix

The string value to which xmlnsPrefix is to be set.

virtual unsigned int asdm::ASDM::size

(

)

[virtual]

Meaningless, but required for the Representable interface.

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.

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.

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.

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

(

)

[virtual]

Produces the XML representation of * this.

Returns:

a string containing the XML representation of this.

Exceptions:

ConversionException.

virtual std::string asdm::ASDM::toXML

(

)

[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

)

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::toXML

(

std::string

directory

)

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

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 983 of file ASDM.h.

AnnotationTable * asdm::ASDM::annotation [private]

The table Annotation.

Definition at line 988 of file ASDM.h.

AntennaTable * asdm::ASDM::antenna [private]

The table Antenna.

Definition at line 993 of file ASDM.h.

bool asdm::ASDM::archiveAsBin [private]

Definition at line 966 of file ASDM.h.

CalAmpliTable * asdm::ASDM::calAmpli [private]

The table CalAmpli.

Definition at line 998 of file ASDM.h.

CalAtmosphereTable * asdm::ASDM::calAtmosphere [private]

The table CalAtmosphere.

Definition at line 1003 of file ASDM.h.

CalBandpassTable * asdm::ASDM::calBandpass [private]

The table CalBandpass.

Definition at line 1008 of file ASDM.h.

CalCurveTable * asdm::ASDM::calCurve [private]

The table CalCurve.

Definition at line 1013 of file ASDM.h.

CalDataTable * asdm::ASDM::calData [private]

The table CalData.

Definition at line 1018 of file ASDM.h.

CalDelayTable * asdm::ASDM::calDelay [private]

The table CalDelay.

Definition at line 1023 of file ASDM.h.

CalDeviceTable * asdm::ASDM::calDevice [private]

The table CalDevice.

Definition at line 1028 of file ASDM.h.

CalFluxTable * asdm::ASDM::calFlux [private]

The table CalFlux.

Definition at line 1033 of file ASDM.h.

CalFocusTable * asdm::ASDM::calFocus [private]

The table CalFocus.

Definition at line 1038 of file ASDM.h.

CalFocusModelTable * asdm::ASDM::calFocusModel [private]

The table CalFocusModel.

Definition at line 1043 of file ASDM.h.

CalGainTable * asdm::ASDM::calGain [private]

The table CalGain.

Definition at line 1048 of file ASDM.h.

CalHolographyTable * asdm::ASDM::calHolography [private]

The table CalHolography.

Definition at line 1053 of file ASDM.h.

CalPhaseTable * asdm::ASDM::calPhase [private]

The table CalPhase.

Definition at line 1058 of file ASDM.h.

CalPointingTable * asdm::ASDM::calPointing [private]

The table CalPointing.

Definition at line 1063 of file ASDM.h.

CalPointingModelTable * asdm::ASDM::calPointingModel [private]

The table CalPointingModel.

Definition at line 1068 of file ASDM.h.

CalPositionTable * asdm::ASDM::calPosition [private]

The table CalPosition.

Definition at line 1073 of file ASDM.h.

CalPrimaryBeamTable * asdm::ASDM::calPrimaryBeam [private]

The table CalPrimaryBeam.

Definition at line 1078 of file ASDM.h.

CalReductionTable * asdm::ASDM::calReduction [private]

The table CalReduction.

Definition at line 1083 of file ASDM.h.

CalSeeingTable * asdm::ASDM::calSeeing [private]

The table CalSeeing.

Definition at line 1088 of file ASDM.h.

CalWVRTable * asdm::ASDM::calWVR [private]

The table CalWVR.

Definition at line 1093 of file ASDM.h.

bool asdm::ASDM::checkRowUniqueness_ [private]

Definition at line 971 of file ASDM.h.

ConfigDescriptionTable * asdm::ASDM::configDescription [private]

The table ConfigDescription.

Definition at line 1098 of file ASDM.h.

CorrelatorModeTable * asdm::ASDM::correlatorMode [private]

The table CorrelatorMode.

Definition at line 1103 of file ASDM.h.

DataDescriptionTable * asdm::ASDM::dataDescription [private]

The table DataDescription.

Definition at line 1108 of file ASDM.h.

DelayModelTable * asdm::ASDM::delayModel [private]

The table DelayModel.

Definition at line 1113 of file ASDM.h.

std::string asdm::ASDM::directory [private]

Definition at line 972 of file ASDM.h.

DopplerTable * asdm::ASDM::doppler [private]

The table Doppler.

Definition at line 1118 of file ASDM.h.

Entity asdm::ASDM::entity [private]

This Container's entity.

Definition at line 1304 of file ASDM.h.

EphemerisTable * asdm::ASDM::ephemeris [private]

The table Ephemeris.

Definition at line 1123 of file ASDM.h.

ExecBlockTable * asdm::ASDM::execBlock [private]

The table ExecBlock.

Definition at line 1128 of file ASDM.h.

FeedTable * asdm::ASDM::feed [private]

The table Feed.

Definition at line 1133 of file ASDM.h.

FieldTable * asdm::ASDM::field [private]

The table Field.

Definition at line 1138 of file ASDM.h.

bool asdm::ASDM::fileAsBin [private]

Definition at line 967 of file ASDM.h.

FlagTable * asdm::ASDM::flag [private]

The table Flag.

Definition at line 1143 of file ASDM.h.

FlagCmdTable * asdm::ASDM::flagCmd [private]

The table FlagCmd.

Definition at line 1148 of file ASDM.h.

FocusTable * asdm::ASDM::focus [private]

The table Focus.

Definition at line 1153 of file ASDM.h.

FocusModelTable * asdm::ASDM::focusModel [private]

The table FocusModel.

Definition at line 1158 of file ASDM.h.

FreqOffsetTable * asdm::ASDM::freqOffset [private]

The table FreqOffset.

Definition at line 1163 of file ASDM.h.

GainTrackingTable * asdm::ASDM::gainTracking [private]

The table GainTracking.

Definition at line 1168 of file ASDM.h.

bool asdm::ASDM::hasBeenAdded [private]

Definition at line 968 of file ASDM.h.

HistoryTable * asdm::ASDM::history [private]

The table History.

Definition at line 1173 of file ASDM.h.

HolographyTable * asdm::ASDM::holography [private]

The table Holography.

Definition at line 1178 of file ASDM.h.

bool asdm::ASDM::loadTablesOnDemand_ [private]

Definition at line 970 of file ASDM.h.

MainTable * asdm::ASDM::main [private]

The table Main.

Definition at line 978 of file ASDM.h.

ObservationTable * asdm::ASDM::observation [private]

The table Observation.

Definition at line 1183 of file ASDM.h.

Origin asdm::ASDM::origin [private]

Definition at line 969 of file ASDM.h.

PointingTable * asdm::ASDM::pointing [private]

The table Pointing.

Definition at line 1188 of file ASDM.h.

PointingModelTable * asdm::ASDM::pointingModel [private]

The table PointingModel.

Definition at line 1193 of file ASDM.h.

PolarizationTable * asdm::ASDM::polarization [private]

The table Polarization.

Definition at line 1198 of file ASDM.h.

ProcessorTable * asdm::ASDM::processor [private]

The table Processor.

Definition at line 1203 of file ASDM.h.

ReceiverTable * asdm::ASDM::receiver [private]

The table Receiver.

Definition at line 1208 of file ASDM.h.

SBSummaryTable * asdm::ASDM::sBSummary [private]

The table SBSummary.

Definition at line 1213 of file ASDM.h.

ScaleTable * asdm::ASDM::scale [private]

The table Scale.

Definition at line 1218 of file ASDM.h.

ScanTable * asdm::ASDM::scan [private]

The table Scan.

Definition at line 1223 of file ASDM.h.

SeeingTable * asdm::ASDM::seeing [private]

The table Seeing.

Definition at line 1228 of file ASDM.h.

SourceTable * asdm::ASDM::source [private]

The table Source.

Definition at line 1233 of file ASDM.h.

SpectralWindowTable * asdm::ASDM::spectralWindow [private]

The table SpectralWindow.

Definition at line 1238 of file ASDM.h.

SquareLawDetectorTable * asdm::ASDM::squareLawDetector [private]

The table SquareLawDetector.

Definition at line 1243 of file ASDM.h.

StateTable * asdm::ASDM::state [private]

The table State.

Definition at line 1248 of file ASDM.h.

StationTable * asdm::ASDM::station [private]

The table Station.

Definition at line 1253 of file ASDM.h.

SubscanTable * asdm::ASDM::subscan [private]

The table Subscan.

Definition at line 1258 of file ASDM.h.

SwitchCycleTable * asdm::ASDM::switchCycle [private]

The table SwitchCycle.

Definition at line 1263 of file ASDM.h.

SysCalTable * asdm::ASDM::sysCal [private]

The table SysCal.

Definition at line 1268 of file ASDM.h.

SysPowerTable * asdm::ASDM::sysPower [private]

The table SysPower.

Definition at line 1273 of file ASDM.h.

std::vector< Representable * > asdm::ASDM::table [private]

The list of tables as Representable.

Definition at line 1293 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 1299 of file ASDM.h.

ArrayTime asdm::ASDM::timeOfCreation [private]

===> Attribute timeOfCreation

Definition at line 1312 of file ASDM.h.

TotalPowerTable * asdm::ASDM::totalPower [private]

The table TotalPower.

Definition at line 1278 of file ASDM.h.

int asdm::ASDM::version [private]

===> Attribute version

Definition at line 1323 of file ASDM.h.

WeatherTable * asdm::ASDM::weather [private]

The table Weather.

Definition at line 1288 of file ASDM.h.

WVMCalTable * asdm::ASDM::wVMCal [private]

The table WVMCal.

Definition at line 1283 of file ASDM.h.

string asdm::ASDM::xmlnsPrefix [private]

===> Attribute xmlnsPrefix

Definition at line 1334 of file ASDM.h.

XSLTransformer asdm::ASDM::xslTransformer [private]

Definition at line 1345 of file ASDM.h.

---

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

• code/alma/ASDM/ASDM.h
• code/alma_v3/ASDM/ASDM.h