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
}
 

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

More...

Public Member Functions

 ASDM ()
 Constructs an empty ASDM.
virtual ~ASDM ()
MainTablegetMain () const
 Get the table Main.
AlmaRadiometerTablegetAlmaRadiometer () const
 Get the table AlmaRadiometer.
AnnotationTablegetAnnotation () const
 Get the table Annotation.
AntennaTablegetAntenna () const
 Get the table Antenna.
CalAmpliTablegetCalAmpli () const
 Get the table CalAmpli.
CalAppPhaseTablegetCalAppPhase () const
 Get the table CalAppPhase.
CalAtmosphereTablegetCalAtmosphere () const
 Get the table CalAtmosphere.
CalBandpassTablegetCalBandpass () const
 Get the table CalBandpass.
CalCurveTablegetCalCurve () const
 Get the table CalCurve.
CalDataTablegetCalData () const
 Get the table CalData.
CalDelayTablegetCalDelay () const
 Get the table CalDelay.
CalDeviceTablegetCalDevice () const
 Get the table CalDevice.
CalFluxTablegetCalFlux () const
 Get the table CalFlux.
CalFocusTablegetCalFocus () const
 Get the table CalFocus.
CalFocusModelTablegetCalFocusModel () const
 Get the table CalFocusModel.
CalGainTablegetCalGain () const
 Get the table CalGain.
CalHolographyTablegetCalHolography () const
 Get the table CalHolography.
CalPhaseTablegetCalPhase () const
 Get the table CalPhase.
CalPointingTablegetCalPointing () const
 Get the table CalPointing.
CalPointingModelTablegetCalPointingModel () const
 Get the table CalPointingModel.
CalPositionTablegetCalPosition () const
 Get the table CalPosition.
CalPrimaryBeamTablegetCalPrimaryBeam () const
 Get the table CalPrimaryBeam.
CalReductionTablegetCalReduction () const
 Get the table CalReduction.
CalSeeingTablegetCalSeeing () const
 Get the table CalSeeing.
CalWVRTablegetCalWVR () const
 Get the table CalWVR.
ConfigDescriptionTablegetConfigDescription () const
 Get the table ConfigDescription.
CorrelatorModeTablegetCorrelatorMode () const
 Get the table CorrelatorMode.
DataDescriptionTablegetDataDescription () const
 Get the table DataDescription.
DelayModelTablegetDelayModel () const
 Get the table DelayModel.
DelayModelFixedParametersTablegetDelayModelFixedParameters () const
 Get the table DelayModelFixedParameters.
DelayModelVariableParametersTablegetDelayModelVariableParameters () const
 Get the table DelayModelVariableParameters.
DopplerTablegetDoppler () const
 Get the table Doppler.
EphemerisTablegetEphemeris () const
 Get the table Ephemeris.
ExecBlockTablegetExecBlock () const
 Get the table ExecBlock.
FeedTablegetFeed () const
 Get the table Feed.
FieldTablegetField () const
 Get the table Field.
FlagTablegetFlag () const
 Get the table Flag.
FlagCmdTablegetFlagCmd () const
 Get the table FlagCmd.
FocusTablegetFocus () const
 Get the table Focus.
FocusModelTablegetFocusModel () const
 Get the table FocusModel.
FreqOffsetTablegetFreqOffset () const
 Get the table FreqOffset.
GainTrackingTablegetGainTracking () const
 Get the table GainTracking.
HistoryTablegetHistory () const
 Get the table History.
HolographyTablegetHolography () const
 Get the table Holography.
ObservationTablegetObservation () const
 Get the table Observation.
PointingTablegetPointing () const
 Get the table Pointing.
PointingModelTablegetPointingModel () const
 Get the table PointingModel.
PolarizationTablegetPolarization () const
 Get the table Polarization.
ProcessorTablegetProcessor () const
 Get the table Processor.
ReceiverTablegetReceiver () const
 Get the table Receiver.
SBSummaryTablegetSBSummary () const
 Get the table SBSummary.
ScaleTablegetScale () const
 Get the table Scale.
ScanTablegetScan () const
 Get the table Scan.
SeeingTablegetSeeing () const
 Get the table Seeing.
SourceTablegetSource () const
 Get the table Source.
SpectralWindowTablegetSpectralWindow () const
 Get the table SpectralWindow.
SquareLawDetectorTablegetSquareLawDetector () const
 Get the table SquareLawDetector.
StateTablegetState () const
 Get the table State.
StationTablegetStation () const
 Get the table Station.
SubscanTablegetSubscan () const
 Get the table Subscan.
SwitchCycleTablegetSwitchCycle () const
 Get the table SwitchCycle.
SysCalTablegetSysCal () const
 Get the table SysCal.
SysPowerTablegetSysPower () const
 Get the table SysPower.
TotalPowerTablegetTotalPower () const
 Get the table TotalPower.
WVMCalTablegetWVMCal () const
 Get the table WVMCal.
WeatherTablegetWeather () 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.
RepresentablegetTable (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.
XSLTransformergetXSLTransformer ()

Static Public Member Functions

static ASDMgetFromXML (std::string xmlDirectory)
 Get an ASDM dataset, given the full path name of the directory containing the XML version of the dataset.
static ASDMfromArchive (EntityId datasetId)
 Create an ASDM dataset from the ALMA archive, given the entityId of its container.

Private Member Functions

void error ()

Static Private Member Functions

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_
MainTablemain
 The table Main.
AlmaRadiometerTablealmaRadiometer
 The table AlmaRadiometer.
AnnotationTableannotation
 The table Annotation.
AntennaTableantenna
 The table Antenna.
CalAmpliTablecalAmpli
 The table CalAmpli.
CalAppPhaseTablecalAppPhase
 The table CalAppPhase.
CalAtmosphereTablecalAtmosphere
 The table CalAtmosphere.
CalBandpassTablecalBandpass
 The table CalBandpass.
CalCurveTablecalCurve
 The table CalCurve.
CalDataTablecalData
 The table CalData.
CalDelayTablecalDelay
 The table CalDelay.
CalDeviceTablecalDevice
 The table CalDevice.
CalFluxTablecalFlux
 The table CalFlux.
CalFocusTablecalFocus
 The table CalFocus.
CalFocusModelTablecalFocusModel
 The table CalFocusModel.
CalGainTablecalGain
 The table CalGain.
CalHolographyTablecalHolography
 The table CalHolography.
CalPhaseTablecalPhase
 The table CalPhase.
CalPointingTablecalPointing
 The table CalPointing.
CalPointingModelTablecalPointingModel
 The table CalPointingModel.
CalPositionTablecalPosition
 The table CalPosition.
CalPrimaryBeamTablecalPrimaryBeam
 The table CalPrimaryBeam.
CalReductionTablecalReduction
 The table CalReduction.
CalSeeingTablecalSeeing
 The table CalSeeing.
CalWVRTablecalWVR
 The table CalWVR.
ConfigDescriptionTableconfigDescription
 The table ConfigDescription.
CorrelatorModeTablecorrelatorMode
 The table CorrelatorMode.
DataDescriptionTabledataDescription
 The table DataDescription.
DelayModelTabledelayModel
 The table DelayModel.
DelayModelFixedParametersTabledelayModelFixedParameters
 The table DelayModelFixedParameters.
DelayModelVariableParametersTabledelayModelVariableParameters
 The table DelayModelVariableParameters.
DopplerTabledoppler
 The table Doppler.
EphemerisTableephemeris
 The table Ephemeris.
ExecBlockTableexecBlock
 The table ExecBlock.
FeedTablefeed
 The table Feed.
FieldTablefield
 The table Field.
FlagTableflag
 The table Flag.
FlagCmdTableflagCmd
 The table FlagCmd.
FocusTablefocus
 The table Focus.
FocusModelTablefocusModel
 The table FocusModel.
FreqOffsetTablefreqOffset
 The table FreqOffset.
GainTrackingTablegainTracking
 The table GainTracking.
HistoryTablehistory
 The table History.
HolographyTableholography
 The table Holography.
ObservationTableobservation
 The table Observation.
PointingTablepointing
 The table Pointing.
PointingModelTablepointingModel
 The table PointingModel.
PolarizationTablepolarization
 The table Polarization.
ProcessorTableprocessor
 The table Processor.
ReceiverTablereceiver
 The table Receiver.
SBSummaryTablesBSummary
 The table SBSummary.
ScaleTablescale
 The table Scale.
ScanTablescan
 The table Scan.
SeeingTableseeing
 The table Seeing.
SourceTablesource
 The table Source.
SpectralWindowTablespectralWindow
 The table SpectralWindow.
SquareLawDetectorTablesquareLawDetector
 The table SquareLawDetector.
StateTablestate
 The table State.
StationTablestation
 The table Station.
SubscanTablesubscan
 The table Subscan.
SwitchCycleTableswitchCycle
 The table SwitchCycle.
SysCalTablesysCal
 The table SysCal.
SysPowerTablesysPower
 The table SysPower.
TotalPowerTabletotalPower
 The table TotalPower.
WVMCalTablewVMCal
 The table WVMCal.
WeatherTableweather
 The table Weather.
std::vector< Representable * > table
 The list of tables as Representable.
std::map< std::string, EntitytableEntity
 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", branch ""class ASDM : public Representable {

Definition at line 268 of file ASDM.h.


Member Enumeration Documentation

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 967 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.
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.
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  id  )  [static, private]
string asdm::ASDM::getXmlnsPrefix (  )  const

===> Attribute xmlnsPrefix

Get xmlnsPrefix.

Returns:
xmlnsPrefix as string
XSLTransformer& asdm::ASDM::getXSLTransformer (  ) 
static void asdm::ASDM::putXMLEntity ( std::string  xml  )  [static, private]
virtual void asdm::ASDM::setEntity ( Entity  e  )  [virtual]
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,
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::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::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.
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.
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.
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::updateArchive (  )  const

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

Exceptions:
ConversionException 

Member Data Documentation

The table AlmaRadiometer.

Definition at line 1010 of file ASDM.h.

The table Annotation.

Definition at line 1015 of file ASDM.h.

The table Antenna.

Definition at line 1020 of file ASDM.h.

bool asdm::ASDM::archiveAsBin [private]

Definition at line 993 of file ASDM.h.

The table CalAmpli.

Definition at line 1025 of file ASDM.h.

The table CalAppPhase.

Definition at line 1030 of file ASDM.h.

The table CalAtmosphere.

Definition at line 1035 of file ASDM.h.

The table CalBandpass.

Definition at line 1040 of file ASDM.h.

The table CalCurve.

Definition at line 1045 of file ASDM.h.

The table CalData.

Definition at line 1050 of file ASDM.h.

The table CalDelay.

Definition at line 1055 of file ASDM.h.

The table CalDevice.

Definition at line 1060 of file ASDM.h.

The table CalFlux.

Definition at line 1065 of file ASDM.h.

The table CalFocus.

Definition at line 1070 of file ASDM.h.

The table CalFocusModel.

Definition at line 1075 of file ASDM.h.

The table CalGain.

Definition at line 1080 of file ASDM.h.

The table CalHolography.

Definition at line 1085 of file ASDM.h.

The table CalPhase.

Definition at line 1090 of file ASDM.h.

The table CalPointing.

Definition at line 1095 of file ASDM.h.

The table CalPointingModel.

Definition at line 1100 of file ASDM.h.

The table CalPosition.

Definition at line 1105 of file ASDM.h.

The table CalPrimaryBeam.

Definition at line 1110 of file ASDM.h.

The table CalReduction.

Definition at line 1115 of file ASDM.h.

The table CalSeeing.

Definition at line 1120 of file ASDM.h.

The table CalWVR.

Definition at line 1125 of file ASDM.h.

Definition at line 998 of file ASDM.h.

The table ConfigDescription.

Definition at line 1130 of file ASDM.h.

The table CorrelatorMode.

Definition at line 1135 of file ASDM.h.

The table DataDescription.

Definition at line 1140 of file ASDM.h.

The table DelayModel.

Definition at line 1145 of file ASDM.h.

The table DelayModelFixedParameters.

Definition at line 1150 of file ASDM.h.

The table DelayModelVariableParameters.

Definition at line 1155 of file ASDM.h.

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

Definition at line 999 of file ASDM.h.

The table Doppler.

Definition at line 1160 of file ASDM.h.

This Container's entity.

Definition at line 1346 of file ASDM.h.

The table Ephemeris.

Definition at line 1165 of file ASDM.h.

The table ExecBlock.

Definition at line 1170 of file ASDM.h.

The table Feed.

Definition at line 1175 of file ASDM.h.

The table Field.

Definition at line 1180 of file ASDM.h.

bool asdm::ASDM::fileAsBin [private]

Definition at line 994 of file ASDM.h.

The table Flag.

Definition at line 1185 of file ASDM.h.

The table FlagCmd.

Definition at line 1190 of file ASDM.h.

The table Focus.

Definition at line 1195 of file ASDM.h.

The table FocusModel.

Definition at line 1200 of file ASDM.h.

The table FreqOffset.

Definition at line 1205 of file ASDM.h.

The table GainTracking.

Definition at line 1210 of file ASDM.h.

bool asdm::ASDM::hasBeenAdded [private]

Definition at line 995 of file ASDM.h.

The table History.

Definition at line 1215 of file ASDM.h.

The table Holography.

Definition at line 1220 of file ASDM.h.

Definition at line 997 of file ASDM.h.

The table Main.

Definition at line 1005 of file ASDM.h.

The table Observation.

Definition at line 1225 of file ASDM.h.

Definition at line 996 of file ASDM.h.

The table Pointing.

Definition at line 1230 of file ASDM.h.

The table PointingModel.

Definition at line 1235 of file ASDM.h.

The table Polarization.

Definition at line 1240 of file ASDM.h.

The table Processor.

Definition at line 1245 of file ASDM.h.

The table Receiver.

Definition at line 1250 of file ASDM.h.

The table SBSummary.

Definition at line 1255 of file ASDM.h.

The table Scale.

Definition at line 1260 of file ASDM.h.

The table Scan.

Definition at line 1265 of file ASDM.h.

The table Seeing.

Definition at line 1270 of file ASDM.h.

The table Source.

Definition at line 1275 of file ASDM.h.

The table SpectralWindow.

Definition at line 1280 of file ASDM.h.

The table SquareLawDetector.

Definition at line 1285 of file ASDM.h.

The table State.

Definition at line 1290 of file ASDM.h.

The table Station.

Definition at line 1295 of file ASDM.h.

The table Subscan.

Definition at line 1300 of file ASDM.h.

The table SwitchCycle.

Definition at line 1305 of file ASDM.h.

The table SysCal.

Definition at line 1310 of file ASDM.h.

The table SysPower.

Definition at line 1315 of file ASDM.h.

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

The list of tables as Representable.

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

===> Attribute timeOfCreation

Definition at line 1354 of file ASDM.h.

The table TotalPower.

Definition at line 1320 of file ASDM.h.

int asdm::ASDM::version [private]

===> Attribute version

Definition at line 1365 of file ASDM.h.

The table Weather.

Definition at line 1330 of file ASDM.h.

The table WVMCal.

Definition at line 1325 of file ASDM.h.

string asdm::ASDM::xmlnsPrefix [private]

===> Attribute xmlnsPrefix

Definition at line 1376 of file ASDM.h.

Definition at line 1387 of file ASDM.h.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

Generated on 31 Aug 2016 for casa by  doxygen 1.6.1