asdm::ASDM Class Reference

#include <ASDM.h>

Inherits asdm::Representable.

List of all members.

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.46", branch "HEAD"


Public Member Functions

 ASDM ()
MainTable & getMain () const
AlmaRadiometerTable & getAlmaRadiometer () const
AnnotationTable & getAnnotation () const
AntennaTable & getAntenna () const
BeamTable & getBeam () const
CalAmpliTable & getCalAmpli () const
CalAtmosphereTable & getCalAtmosphere () const
CalBandpassTable & getCalBandpass () const
CalCurveTable & getCalCurve () const
CalDataTable & getCalData () const
CalDelayTable & getCalDelay () const
CalDeviceTable & getCalDevice () const
CalFluxTable & getCalFlux () const
CalFocusTable & getCalFocus () const
CalFocusModelTable & getCalFocusModel () const
CalGainTable & getCalGain () const
CalHolographyTable & getCalHolography () const
CalPhaseTable & getCalPhase () const
CalPointingTable & getCalPointing () const
CalPointingModelTable & getCalPointingModel () const
CalPositionTable & getCalPosition () const
CalPrimaryBeamTable & getCalPrimaryBeam () const
CalReductionTable & getCalReduction () const
CalSeeingTable & getCalSeeing () const
CalWVRTable & getCalWVR () const
ConfigDescriptionTable & getConfigDescription () const
CorrelatorModeTable & getCorrelatorMode () const
DataDescriptionTable & getDataDescription () const
DopplerTable & getDoppler () const
EphemerisTable & getEphemeris () const
ExecBlockTable & getExecBlock () const
FeedTable & getFeed () const
FieldTable & getField () const
FlagCmdTable & getFlagCmd () const
FocusTable & getFocus () const
FocusModelTable & getFocusModel () const
FreqOffsetTable & getFreqOffset () const
GainTrackingTable & getGainTracking () const
HistoryTable & getHistory () const
HolographyTable & getHolography () const
ObservationTable & getObservation () const
PointingTable & getPointing () const
PointingModelTable & getPointingModel () const
PolarizationTable & getPolarization () const
ProcessorTable & getProcessor () const
ReceiverTable & getReceiver () const
SBSummaryTable & getSBSummary () const
ScanTable & getScan () const
SeeingTable & getSeeing () const
SourceTable & getSource () const
SourceParameterTable & getSourceParameter () const
SpectralWindowTable & getSpectralWindow () const
SquareLawDetectorTable & getSquareLawDetector () const
StateTable & getState () const
StationTable & getStation () const
SubscanTable & getSubscan () const
SwitchCycleTable & getSwitchCycle () const
SysCalTable & getSysCal () const
TotalPowerTable & getTotalPower () const
WVMCalTable & getWVMCal () const
WeatherTable & getWeather () const
virtual string toXML ()
void toXML (string directory)
virtual void fromXML (string xml)
string toMIME ()
void setFromMIME (const string &mimeMsg)
void toFile (string directory)
void setFromFile (string directory)
virtual ASDMDataSetIDL * toIDL ()
virtual void fromIDL (ASDMDataSetIDL *x)
virtual string toVOTable () const throw (ConversionException)
virtual void fromVOTable (string vo) throw (ConversionException)
virtual char * toFITS () const throw (ConversionException)
virtual void fromFITS (char *fits) throw (ConversionException)
virtual Entity getEntity () const
virtual void setEntity (Entity e)
virtual string getName () const
virtual unsigned int size ()
void updateArchive () const throw (ConversionException)
Representable & getTable (string tableName) throw (InvalidArgumentException)
ArrayTime getTimeOfCreation () const
void setTimeOfCreation (ArrayTime timeOfCreation)

Static Public Member Functions

ASDM * getFromXML (string xmlDirectory)
ASDM * fromArchive (EntityId datasetId) throw (ConversionException)

Constructor & Destructor Documentation

asdm::ASDM::ASDM (   ) 
 

Create an instance of the tables that belong to this model.

Member Function Documentation

ASDM* asdm::ASDM::fromArchive (  EntityId  datasetId  )  throw (ConversionException) [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.

virtual void asdm::ASDM::fromIDL (  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 (  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.

Implements asdm::Representable.

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.

BeamTable& asdm::ASDM::getBeam (   )  const
 

Get the table Beam.

Returns:
The table Beam as a BeamTable.

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.

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.

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

Get the table Doppler.

Returns:
The table Doppler as a DopplerTable.

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.

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.

ASDM* asdm::ASDM::getFromXML (  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 string asdm::ASDM::getName (   )  const [virtual]
 

Meaningless, but required for the Representable interface.

Implements asdm::Representable.

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

Get the table Observation.

Returns:
The table Observation as a ObservationTable.

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.

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.

SourceParameterTable& asdm::ASDM::getSourceParameter (   )  const
 

Get the table SourceParameter.

Returns:
The table SourceParameter as a SourceParameterTable.

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.

Representable& asdm::ASDM::getTable (  string  tableName  )  throw (InvalidArgumentException)
 

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

ArrayTime asdm::ASDM::getTimeOfCreation (   )  const
 

Get timeOfCreation.

Returns:
timeOfCreation as ArrayTime

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

Get the table TotalPower.

Returns:
The table TotalPower as a TotalPowerTable.

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.

void asdm::ASDM::setFromFile (  string  directory  ) 
 

Reads and parses a collection of files as those produced by the toFile method. This dataset is populated with the result of the parsing.

Parameters:
directory The name of the directory containing the files.
Exceptions:
ConversionException If any error occurs while reading the files in the directory or parsing them.

void asdm::ASDM::setFromMIME (  const 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.

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

Meaningless, but required for the Representable interface.

Implements asdm::Representable.

void asdm::ASDM::toFile (  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 ASDMDataSetIDL* asdm::ASDM::toIDL (   )  [virtual]
 

Converts this ASDM into an ASDMDataSetIDL CORBA structure

Returns:
a pointer to a ASDMDataSetIDL.

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 (  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 string asdm::ASDM::toXML (   )  [virtual]
 

Produces the XML representation of * this.

Returns:
a string containing the XML representation of this.
Exceptions:
ConversionException. 

Implements asdm::Representable.

void asdm::ASDM::updateArchive (   )  const throw (ConversionException)
 

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

The documentation for this class was generated from the following file:
Generated on Tue Nov 18 17:43:42 2008 for ASDM C++ Implementation by doxygen 1.3.8