asdm::SpectralWindowRow Class Reference

#include <SpectralWindowRow.h>

List of all members.

---

Detailed Description

The SpectralWindowRow class is a row of a SpectralWindowTable.

Generated from model's revision "1.41", branch "HEAD"

Public Member Functions
SpectralWindowTable &	getTable () const
SpectralWindowRowIDL *	toIDL () const
void	setFromIDL (SpectralWindowRowIDL x) throw (ConversionException)
string	toXML () const
void	setFromXML (string rowDoc) throw (ConversionException)
Tag	getSpectralWindowId () const
int	getNumChan () const
void	setNumChan (int numChan)
bool	isNameExists () const
string	getName () const throw (IllegalAccessException)
void	setName (string name)
void	clearName ()
Frequency	getRefFreq () const
void	setRefFreq (Frequency refFreq)
vector< Frequency >	getChanFreq () const
void	setChanFreq (vector< Frequency > chanFreq)
vector< Frequency >	getChanWidth () const
void	setChanWidth (vector< Frequency > chanWidth)
bool	isMeasFreqRefExists () const
int	getMeasFreqRef () const throw (IllegalAccessException)
void	setMeasFreqRef (int measFreqRef)
void	clearMeasFreqRef ()
vector< Frequency >	getEffectiveBw () const
void	setEffectiveBw (vector< Frequency > effectiveBw)
vector< Frequency >	getResolution () const
void	setResolution (vector< Frequency > resolution)
Frequency	getTotBandwidth () const
void	setTotBandwidth (Frequency totBandwidth)
NetSideband	getNetSideband () const
void	setNetSideband (NetSideband netSideband)
SidebandProcessingMode	getSidebandProcessingMode () const
void	setSidebandProcessingMode (SidebandProcessingMode sidebandProcessingMode)
bool	isBasebandNameExists () const
BasebandName	getBasebandName () const throw (IllegalAccessException)
void	setBasebandName (BasebandName basebandName)
void	clearBasebandName ()
bool	isBbcSidebandExists () const
int	getBbcSideband () const throw (IllegalAccessException)
void	setBbcSideband (int bbcSideband)
void	clearBbcSideband ()
bool	isIfConvChainExists () const
int	getIfConvChain () const throw (IllegalAccessException)
void	setIfConvChain (int ifConvChain)
void	clearIfConvChain ()
bool	isFreqGroupExists () const
int	getFreqGroup () const throw (IllegalAccessException)
void	setFreqGroup (int freqGroup)
void	clearFreqGroup ()
bool	isFreqGroupNameExists () const
string	getFreqGroupName () const throw (IllegalAccessException)
void	setFreqGroupName (string freqGroupName)
void	clearFreqGroupName ()
bool	isAssocNatureExists () const
vector< SpectralResolutionType >	getAssocNature () const throw (IllegalAccessException)
void	setAssocNature (vector< SpectralResolutionType > assocNature)
void	clearAssocNature ()
bool	getQuantization () const
void	setQuantization (bool quantization)
WindowFunction	getWindowFunction () const
void	setWindowFunction (WindowFunction windowFunction)
bool	getOversampling () const
void	setOversampling (bool oversampling)
CorrelationBit	getCorrelationBit () const
void	setCorrelationBit (CorrelationBit correlationBit)
bool	getFlagRow () const
void	setFlagRow (bool flagRow)
bool	isAssocSpectralWindowIdExists () const
vector< Tag >	getAssocSpectralWindowId () const throw (IllegalAccessException)
void	setAssocSpectralWindowId (vector< Tag > assocSpectralWindowId)
void	clearAssocSpectralWindowId ()
bool	isDopplerIdExists () const
int	getDopplerId () const throw (IllegalAccessException)
void	setDopplerId (int dopplerId)
void	clearDopplerId ()
bool	isImageSpectralWindowIdExists () const
Tag	getImageSpectralWindowId () const throw (IllegalAccessException)
void	setImageSpectralWindowId (Tag imageSpectralWindowId)
void	clearImageSpectralWindowId ()
vector< DopplerRow * >	getDopplers ()
void	setAssocSpectralWindowId (int i, Tag assocSpectralWindowId) throw (IllegalAccessException, OutOfBoundsException)
void	addAssocSpectralWindowId (Tag id)
void	addAssocSpectralWindowId (const vector< Tag > &id)
const Tag	getAssocSpectralWindowId (int i)
SpectralWindowRow *	getSpectralWindow (int i)
vector< SpectralWindowRow * >	getSpectralWindows ()
SpectralWindowRow *	getSpectralWindowUsingImageSpectralWindowId ()
bool	compareNoAutoInc (int numChan, Frequency refFreq, vector< Frequency > chanFreq, vector< Frequency > chanWidth, vector< Frequency > effectiveBw, vector< Frequency > resolution, Frequency totBandwidth, NetSideband netSideband, SidebandProcessingMode sidebandProcessingMode, bool quantization, WindowFunction windowFunction, bool oversampling, CorrelationBit correlationBit, bool flagRow)
bool	compareRequiredValue (int numChan, Frequency refFreq, vector< Frequency > chanFreq, vector< Frequency > chanWidth, vector< Frequency > effectiveBw, vector< Frequency > resolution, Frequency totBandwidth, NetSideband netSideband, SidebandProcessingMode sidebandProcessingMode, bool quantization, WindowFunction windowFunction, bool oversampling, CorrelationBit correlationBit, bool flagRow)
bool	equalByRequiredValue (SpectralWindowRow *x)
Friends
class	asdm::SpectralWindowTable

---

Member Function Documentation

SpectralWindowTable& asdm::SpectralWindowRow::getTable

(

)

const

Return the table to which this row belongs.

SpectralWindowRowIDL* asdm::SpectralWindowRow::toIDL

(

)

const

Return this row in the form of an IDL struct.

Returns:

The values of this row as a SpectralWindowRowIDL struct.

void asdm::SpectralWindowRow::setFromIDL

(

SpectralWindowRowIDL

x

)

throw (ConversionException)

Fill the values of this row from the IDL struct SpectralWindowRowIDL.

Parameters:

x

The IDL struct containing the values used to fill this row.

string asdm::SpectralWindowRow::toXML

(

)

const

Return this row in the form of an XML string.

Returns:

The values of this row as an XML string.

void asdm::SpectralWindowRow::setFromXML

(

string

rowDoc

)

throw (ConversionException)

Fill the values of this row from an XML string that was produced by the toXML() method.

Parameters:

x

The XML string being used to set the values of this row.

Tag asdm::SpectralWindowRow::getSpectralWindowId

(

)

const

Get spectralWindowId.

Returns:

spectralWindowId as Tag

int asdm::SpectralWindowRow::getNumChan

(

)

const

Get numChan.

Returns:

numChan as int

void asdm::SpectralWindowRow::setNumChan

(

int

numChan

)

Set numChan with the specified int.

Parameters:

numChan

The int value to which numChan is to be set.

bool asdm::SpectralWindowRow::isNameExists

(

)

const

The attribute name is optional. Return true if this attribute exists.

Returns:

true if and only if the name attribute exists.

string asdm::SpectralWindowRow::getName

(

)

const throw (IllegalAccessException)

Get name, which is optional.

Returns:

name as string

Exceptions:

IllegalAccessException

If name does not exist.

void asdm::SpectralWindowRow::setName

(

string

name

)

Set name with the specified string.

Parameters:

name

The string value to which name is to be set.

void asdm::SpectralWindowRow::clearName

(

)

Mark name, which is an optional field, as non-existent.

Frequency asdm::SpectralWindowRow::getRefFreq

(

)

const

Get refFreq.

Returns:

refFreq as Frequency

void asdm::SpectralWindowRow::setRefFreq

(

Frequency

refFreq

)

Set refFreq with the specified Frequency.

Parameters:

refFreq

The Frequency value to which refFreq is to be set.

vector<Frequency > asdm::SpectralWindowRow::getChanFreq

(

)

const

Get chanFreq.

Returns:

chanFreq as vector<Frequency >

void asdm::SpectralWindowRow::setChanFreq

(

vector< Frequency >

chanFreq

)

Set chanFreq with the specified vector<Frequency >.

Parameters:

chanFreq

The vector<Frequency > value to which chanFreq is to be set.

vector<Frequency > asdm::SpectralWindowRow::getChanWidth

(

)

const

Get chanWidth.

Returns:

chanWidth as vector<Frequency >

void asdm::SpectralWindowRow::setChanWidth

(

vector< Frequency >

chanWidth

)

Set chanWidth with the specified vector<Frequency >.

Parameters:

chanWidth

The vector<Frequency > value to which chanWidth is to be set.

bool asdm::SpectralWindowRow::isMeasFreqRefExists

(

)

const

The attribute measFreqRef is optional. Return true if this attribute exists.

Returns:

true if and only if the measFreqRef attribute exists.

int asdm::SpectralWindowRow::getMeasFreqRef

(

)

const throw (IllegalAccessException)

Get measFreqRef, which is optional.

Returns:

measFreqRef as int

Exceptions:

IllegalAccessException

If measFreqRef does not exist.

void asdm::SpectralWindowRow::setMeasFreqRef

(

int

measFreqRef

)

Set measFreqRef with the specified int.

Parameters:

measFreqRef

The int value to which measFreqRef is to be set.

void asdm::SpectralWindowRow::clearMeasFreqRef

(

)

Mark measFreqRef, which is an optional field, as non-existent.

vector<Frequency > asdm::SpectralWindowRow::getEffectiveBw

(

)

const

Get effectiveBw.

Returns:

effectiveBw as vector<Frequency >

void asdm::SpectralWindowRow::setEffectiveBw

(

vector< Frequency >

effectiveBw

)

Set effectiveBw with the specified vector<Frequency >.

Parameters:

effectiveBw

The vector<Frequency > value to which effectiveBw is to be set.

vector<Frequency > asdm::SpectralWindowRow::getResolution

(

)

const

Get resolution.

Returns:

resolution as vector<Frequency >

void asdm::SpectralWindowRow::setResolution

(

vector< Frequency >

resolution

)

Set resolution with the specified vector<Frequency >.

Parameters:

resolution

The vector<Frequency > value to which resolution is to be set.

Frequency asdm::SpectralWindowRow::getTotBandwidth

(

)

const

Get totBandwidth.

Returns:

totBandwidth as Frequency

void asdm::SpectralWindowRow::setTotBandwidth

(

Frequency

totBandwidth

)

Set totBandwidth with the specified Frequency.

Parameters:

totBandwidth

The Frequency value to which totBandwidth is to be set.

NetSideband asdm::SpectralWindowRow::getNetSideband

(

)

const

Get netSideband.

Returns:

netSideband as NetSideband

void asdm::SpectralWindowRow::setNetSideband

(

NetSideband

netSideband

)

Set netSideband with the specified NetSideband.

Parameters:

netSideband

The NetSideband value to which netSideband is to be set.

SidebandProcessingMode asdm::SpectralWindowRow::getSidebandProcessingMode

(

)

const

Get sidebandProcessingMode.

Returns:

sidebandProcessingMode as SidebandProcessingMode

void asdm::SpectralWindowRow::setSidebandProcessingMode

(

SidebandProcessingMode

sidebandProcessingMode

)

Set sidebandProcessingMode with the specified SidebandProcessingMode.

Parameters:

sidebandProcessingMode

The SidebandProcessingMode value to which sidebandProcessingMode is to be set.

bool asdm::SpectralWindowRow::isBasebandNameExists

(

)

const

The attribute basebandName is optional. Return true if this attribute exists.

Returns:

true if and only if the basebandName attribute exists.

BasebandName asdm::SpectralWindowRow::getBasebandName

(

)

const throw (IllegalAccessException)

Get basebandName, which is optional.

Returns:

basebandName as BasebandName

Exceptions:

IllegalAccessException

If basebandName does not exist.

void asdm::SpectralWindowRow::setBasebandName

(

BasebandName

basebandName

)

Set basebandName with the specified BasebandName.

Parameters:

basebandName

The BasebandName value to which basebandName is to be set.

void asdm::SpectralWindowRow::clearBasebandName

(

)

Mark basebandName, which is an optional field, as non-existent.

bool asdm::SpectralWindowRow::isBbcSidebandExists

(

)

const

The attribute bbcSideband is optional. Return true if this attribute exists.

Returns:

true if and only if the bbcSideband attribute exists.

int asdm::SpectralWindowRow::getBbcSideband

(

)

const throw (IllegalAccessException)

Get bbcSideband, which is optional.

Returns:

bbcSideband as int

Exceptions:

IllegalAccessException

If bbcSideband does not exist.

void asdm::SpectralWindowRow::setBbcSideband

(

int

bbcSideband

)

Set bbcSideband with the specified int.

Parameters:

bbcSideband

The int value to which bbcSideband is to be set.

void asdm::SpectralWindowRow::clearBbcSideband

(

)

Mark bbcSideband, which is an optional field, as non-existent.

bool asdm::SpectralWindowRow::isIfConvChainExists

(

)

const

The attribute ifConvChain is optional. Return true if this attribute exists.

Returns:

true if and only if the ifConvChain attribute exists.

int asdm::SpectralWindowRow::getIfConvChain

(

)

const throw (IllegalAccessException)

Get ifConvChain, which is optional.

Returns:

ifConvChain as int

Exceptions:

IllegalAccessException

If ifConvChain does not exist.

void asdm::SpectralWindowRow::setIfConvChain

(

int

ifConvChain

)

Set ifConvChain with the specified int.

Parameters:

ifConvChain

The int value to which ifConvChain is to be set.

void asdm::SpectralWindowRow::clearIfConvChain

(

)

Mark ifConvChain, which is an optional field, as non-existent.

bool asdm::SpectralWindowRow::isFreqGroupExists

(

)

const

The attribute freqGroup is optional. Return true if this attribute exists.

Returns:

true if and only if the freqGroup attribute exists.

int asdm::SpectralWindowRow::getFreqGroup

(

)

const throw (IllegalAccessException)

Get freqGroup, which is optional.

Returns:

freqGroup as int

Exceptions:

IllegalAccessException

If freqGroup does not exist.

void asdm::SpectralWindowRow::setFreqGroup

(

int

freqGroup

)

Set freqGroup with the specified int.

Parameters:

freqGroup

The int value to which freqGroup is to be set.

void asdm::SpectralWindowRow::clearFreqGroup

(

)

Mark freqGroup, which is an optional field, as non-existent.

bool asdm::SpectralWindowRow::isFreqGroupNameExists

(

)

const

The attribute freqGroupName is optional. Return true if this attribute exists.

Returns:

true if and only if the freqGroupName attribute exists.

string asdm::SpectralWindowRow::getFreqGroupName

(

)

const throw (IllegalAccessException)

Get freqGroupName, which is optional.

Returns:

freqGroupName as string

Exceptions:

IllegalAccessException

If freqGroupName does not exist.

void asdm::SpectralWindowRow::setFreqGroupName

(

string

freqGroupName

)

Set freqGroupName with the specified string.

Parameters:

freqGroupName

The string value to which freqGroupName is to be set.

void asdm::SpectralWindowRow::clearFreqGroupName

(

)

Mark freqGroupName, which is an optional field, as non-existent.

bool asdm::SpectralWindowRow::isAssocNatureExists

(

)

const

The attribute assocNature is optional. Return true if this attribute exists.

Returns:

true if and only if the assocNature attribute exists.

vector<SpectralResolutionType > asdm::SpectralWindowRow::getAssocNature

(

)

const throw (IllegalAccessException)

Get assocNature, which is optional.

Returns:

assocNature as vector<SpectralResolutionType >

Exceptions:

IllegalAccessException

If assocNature does not exist.

void asdm::SpectralWindowRow::setAssocNature

(

vector< SpectralResolutionType >

assocNature

)

Set assocNature with the specified vector<SpectralResolutionType >.

Parameters:

assocNature

The vector<SpectralResolutionType > value to which assocNature is to be set.

void asdm::SpectralWindowRow::clearAssocNature

(

)

Mark assocNature, which is an optional field, as non-existent.

bool asdm::SpectralWindowRow::getQuantization

(

)

const

Get quantization.

Returns:

quantization as bool

void asdm::SpectralWindowRow::setQuantization

(

bool

quantization

)

Set quantization with the specified bool.

Parameters:

quantization

The bool value to which quantization is to be set.

WindowFunction asdm::SpectralWindowRow::getWindowFunction

(

)

const

Get windowFunction.

Returns:

windowFunction as WindowFunction

void asdm::SpectralWindowRow::setWindowFunction

(

WindowFunction

windowFunction

)

Set windowFunction with the specified WindowFunction.

Parameters:

windowFunction

The WindowFunction value to which windowFunction is to be set.

bool asdm::SpectralWindowRow::getOversampling

(

)

const

Get oversampling.

Returns:

oversampling as bool

void asdm::SpectralWindowRow::setOversampling

(

bool

oversampling

)

Set oversampling with the specified bool.

Parameters:

oversampling

The bool value to which oversampling is to be set.

CorrelationBit asdm::SpectralWindowRow::getCorrelationBit

(

)

const

Get correlationBit.

Returns:

correlationBit as CorrelationBit

void asdm::SpectralWindowRow::setCorrelationBit

(

CorrelationBit

correlationBit

)

Set correlationBit with the specified CorrelationBit.

Parameters:

correlationBit

The CorrelationBit value to which correlationBit is to be set.

bool asdm::SpectralWindowRow::getFlagRow

(

)

const

Get flagRow.

Returns:

flagRow as bool

void asdm::SpectralWindowRow::setFlagRow

(

bool

flagRow

)

Set flagRow with the specified bool.

Parameters:

flagRow

The bool value to which flagRow is to be set.

bool asdm::SpectralWindowRow::isAssocSpectralWindowIdExists

(

)

const

The attribute assocSpectralWindowId is optional. Return true if this attribute exists.

Returns:

true if and only if the assocSpectralWindowId attribute exists.

vector<Tag> asdm::SpectralWindowRow::getAssocSpectralWindowId

(

)

const throw (IllegalAccessException)

Get assocSpectralWindowId, which is optional.

Returns:

assocSpectralWindowId as vector<Tag>

Exceptions:

IllegalAccessException

If assocSpectralWindowId does not exist.

void asdm::SpectralWindowRow::setAssocSpectralWindowId

(

vector< Tag >

assocSpectralWindowId

)

Set assocSpectralWindowId with the specified vector<Tag> .

Parameters:

assocSpectralWindowId

The vector<Tag> value to which assocSpectralWindowId is to be set.

void asdm::SpectralWindowRow::clearAssocSpectralWindowId

(

)

Mark assocSpectralWindowId, which is an optional field, as non-existent.

bool asdm::SpectralWindowRow::isDopplerIdExists

(

)

const

The attribute dopplerId is optional. Return true if this attribute exists.

Returns:

true if and only if the dopplerId attribute exists.

int asdm::SpectralWindowRow::getDopplerId

(

)

const throw (IllegalAccessException)

Get dopplerId, which is optional.

Returns:

dopplerId as int

Exceptions:

IllegalAccessException

If dopplerId does not exist.

void asdm::SpectralWindowRow::setDopplerId

(

int

dopplerId

)

Set dopplerId with the specified int.

Parameters:

dopplerId

The int value to which dopplerId is to be set.

void asdm::SpectralWindowRow::clearDopplerId

(

)

Mark dopplerId, which is an optional field, as non-existent.

bool asdm::SpectralWindowRow::isImageSpectralWindowIdExists

(

)

const

The attribute imageSpectralWindowId is optional. Return true if this attribute exists.

Returns:

true if and only if the imageSpectralWindowId attribute exists.

Tag asdm::SpectralWindowRow::getImageSpectralWindowId

(

)

const throw (IllegalAccessException)

Get imageSpectralWindowId, which is optional.

Returns:

imageSpectralWindowId as Tag

Exceptions:

IllegalAccessException

If imageSpectralWindowId does not exist.

void asdm::SpectralWindowRow::setImageSpectralWindowId

(

Tag

imageSpectralWindowId

)

Set imageSpectralWindowId with the specified Tag.

Parameters:

imageSpectralWindowId

The Tag value to which imageSpectralWindowId is to be set.

void asdm::SpectralWindowRow::clearImageSpectralWindowId

(

)

Mark imageSpectralWindowId, which is an optional field, as non-existent.

vector<DopplerRow *> asdm::SpectralWindowRow::getDopplers

(

)

Get the collection of row in the Doppler table having dopplerId == this.dopplerId

Returns:

a vector of DopplerRow *

void asdm::SpectralWindowRow::setAssocSpectralWindowId	(	int	i,
		Tag	assocSpectralWindowId
	)			throw (IllegalAccessException, OutOfBoundsException)

Set assocSpectralWindowId[i] with the specified Tag.

Parameters:

	i	The index in assocSpectralWindowId where to set the Tag value.
	assocSpectralWindowId	The Tag value to which assocSpectralWindowId[i] is to be set.

Exceptions:

	IllegalException
	IndexOutOfBoundsException

void asdm::SpectralWindowRow::addAssocSpectralWindowId

(

Tag

id

)

Append a Tag to assocSpectralWindowId.

Parameters:

id

the Tag to be appended to assocSpectralWindowId

void asdm::SpectralWindowRow::addAssocSpectralWindowId

(

const vector< Tag > &

id

)

Append a vector of Tag to assocSpectralWindowId.

Parameters:

id

an array of Tag to be appended to assocSpectralWindowId

const Tag asdm::SpectralWindowRow::getAssocSpectralWindowId

(

int

i

)

Returns the Tag stored in assocSpectralWindowId at position i.

Parameters:

i

the position in assocSpectralWindowId where the Tag is retrieved.

Returns:

the Tag stored at position i in assocSpectralWindowId.

SpectralWindowRow* asdm::SpectralWindowRow::getSpectralWindow

(

int

i

)

Returns the SpectralWindowRow linked to this row via the tag stored in assocSpectralWindowId at position i.

Parameters:

i

the position in assocSpectralWindowId.

Returns:

a pointer on a SpectralWindowRow whose key (a Tag) is equal to the Tag stored at position i in the assocSpectralWindowId.

vector<SpectralWindowRow *> asdm::SpectralWindowRow::getSpectralWindows

(

)

Returns the vector of SpectralWindowRow* linked to this row via the Tags stored in assocSpectralWindowId

Returns:

an array of pointers on SpectralWindowRow.

SpectralWindowRow* asdm::SpectralWindowRow::getSpectralWindowUsingImageSpectralWindowId

(

)

imageSpectralWindowId pointer to the row in the SpectralWindow table having SpectralWindow.imageSpectralWindowId == imageSpectralWindowId

Returns:

a SpectralWindowRow*

throws IllegalAccessException

bool asdm::SpectralWindowRow::compareNoAutoInc	(	int	numChan,
		Frequency	refFreq,
		vector< Frequency >	chanFreq,
		vector< Frequency >	chanWidth,
		vector< Frequency >	effectiveBw,
		vector< Frequency >	resolution,
		Frequency	totBandwidth,
		NetSideband	netSideband,
		SidebandProcessingMode	sidebandProcessingMode,
		bool	quantization,
		WindowFunction	windowFunction,
		bool	oversampling,
		CorrelationBit	correlationBit,
		bool	flagRow
	)

Compare each mandatory attribute except the autoincrementable one of this SpectralWindowRow with the corresponding parameters and return true if there is a match and false otherwise.

bool asdm::SpectralWindowRow::equalByRequiredValue

(

SpectralWindowRow *

x

)

Return true if all required attributes of the value part are equal to their homologues in x and false otherwise.

Parameters:

x

a pointer on the SpectralWindowRow whose required attributes of the value part will be compared with those of this.

Returns:

a boolean.

---

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

• SpectralWindowRow.h

---