asdm::CalDataRow Class Reference

#include <CalDataRow.h>

Collaboration diagram for asdm::CalDataRow:

[legend]List of all members.

---

Detailed Description

The CalDataRow class is a row of a CalDataTable.

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

Definition at line 160 of file CalDataRow.h.

Public Member Functions
virtual	~CalDataRow ()
CalDataTable &	getTable () const
	Return the table to which this row belongs.
CalDataRowIDL *	toIDL () const
	Return this row in the form of an IDL struct.
void	setFromIDL (CalDataRowIDL x) throw (ConversionException)
	Fill the values of this row from the IDL struct CalDataRowIDL.
string	toXML () const
	Return this row in the form of an XML string.
void	setFromXML (string rowDoc) throw (ConversionException)
	Fill the values of this row from an XML string that was produced by the toXML() method.
int	getNumScan () const
	Get numScan.
void	setNumScan (int numScan)
	Set numScan with the specified int.
bool	isFrequencyGroupExists () const
	The attribute frequencyGroup is optional.
int	getFrequencyGroup () const throw (IllegalAccessException)
	Get frequencyGroup, which is optional.
void	setFrequencyGroup (int frequencyGroup)
	Set frequencyGroup with the specified int.
void	clearFrequencyGroup ()
	Mark frequencyGroup, which is an optional field, as non-existent.
vector< int >	getScanSet () const
	Get scanSet.
void	setScanSet (vector< int > scanSet)
	Set scanSet with the specified vector<int >.
CalTypeMod::CalType	getCalType () const
	Get calType.
void	setCalType (CalTypeMod::CalType calType)
	Set calType with the specified CalTypeMod::CalType.
bool	isFreqGroupNameExists () const
	The attribute freqGroupName is optional.
string	getFreqGroupName () const throw (IllegalAccessException)
	Get freqGroupName, which is optional.
void	setFreqGroupName (string freqGroupName)
	Set freqGroupName with the specified string.
void	clearFreqGroupName ()
	Mark freqGroupName, which is an optional field, as non-existent.
bool	isFieldNameExists () const
	The attribute fieldName is optional.
string	getFieldName () const throw (IllegalAccessException)
	Get fieldName, which is optional.
void	setFieldName (string fieldName)
	Set fieldName with the specified string.
void	clearFieldName ()
	Mark fieldName, which is an optional field, as non-existent.
bool	isFieldCodeExists () const
	The attribute fieldCode is optional.
vector< string >	getFieldCode () const throw (IllegalAccessException)
	Get fieldCode, which is optional.
void	setFieldCode (vector< string > fieldCode)
	Set fieldCode with the specified vector<string >.
void	clearFieldCode ()
	Mark fieldCode, which is an optional field, as non-existent.
ArrayTime	getStartTimeObserved () const
	Get startTimeObserved.
void	setStartTimeObserved (ArrayTime startTimeObserved)
	Set startTimeObserved with the specified ArrayTime.
ArrayTime	getEndTimeObserved () const
	Get endTimeObserved.
void	setEndTimeObserved (ArrayTime endTimeObserved)
	Set endTimeObserved with the specified ArrayTime.
bool	isSourceNameExists () const
	The attribute sourceName is optional.
vector< string >	getSourceName () const throw (IllegalAccessException)
	Get sourceName, which is optional.
void	setSourceName (vector< string > sourceName)
	Set sourceName with the specified vector<string >.
void	clearSourceName ()
	Mark sourceName, which is an optional field, as non-existent.
bool	isSourceCodeExists () const
	The attribute sourceCode is optional.
vector< string >	getSourceCode () const throw (IllegalAccessException)
	Get sourceCode, which is optional.
void	setSourceCode (vector< string > sourceCode)
	Set sourceCode with the specified vector<string >.
void	clearSourceCode ()
	Mark sourceCode, which is an optional field, as non-existent.
bool	isScanIntentExists () const
	The attribute scanIntent is optional.
vector< ScanIntentMod::ScanIntent >	getScanIntent () const throw (IllegalAccessException)
	Get scanIntent, which is optional.
void	setScanIntent (vector< ScanIntentMod::ScanIntent > scanIntent)
	Set scanIntent with the specified vector<ScanIntentMod::ScanIntent >.
void	clearScanIntent ()
	Mark scanIntent, which is an optional field, as non-existent.
bool	isAssocCalDataIdExists () const
	The attribute assocCalDataId is optional.
Tag	getAssocCalDataId () const throw (IllegalAccessException)
	Get assocCalDataId, which is optional.
void	setAssocCalDataId (Tag assocCalDataId)
	Set assocCalDataId with the specified Tag.
void	clearAssocCalDataId ()
	Mark assocCalDataId, which is an optional field, as non-existent.
bool	isAssocCalNatureExists () const
	The attribute assocCalNature is optional.
AssociatedCalNatureMod::AssociatedCalNature	getAssocCalNature () const throw (IllegalAccessException)
	Get assocCalNature, which is optional.
void	setAssocCalNature (AssociatedCalNatureMod::AssociatedCalNature assocCalNature)
	Set assocCalNature with the specified AssociatedCalNatureMod::AssociatedCalNature.
void	clearAssocCalNature ()
	Mark assocCalNature, which is an optional field, as non-existent.
CalDataOriginMod::CalDataOrigin	getCalDataType () const
	Get calDataType.
void	setCalDataType (CalDataOriginMod::CalDataOrigin calDataType)
	Set calDataType with the specified CalDataOriginMod::CalDataOrigin.
Extrinsic Table Attributes Links *bool	compareNoAutoInc (int numScan, vector< int > scanSet, CalTypeMod::CalType calType, ArrayTime startTimeObserved, ArrayTime endTimeObserved, CalDataOriginMod::CalDataOrigin calDataType)
	Compare each mandatory attribute except the autoincrementable one of this CalDataRow with the corresponding parameters and return true if there is a match and false otherwise.
bool	compareRequiredValue (int numScan, vector< int > scanSet, CalTypeMod::CalType calType, ArrayTime startTimeObserved, ArrayTime endTimeObserved, CalDataOriginMod::CalDataOrigin calDataType)
bool	equalByRequiredValue (CalDataRow *x)
	Return true if all required attributes of the value part are equal to their homologues in x and false otherwise.
Public Attributes
Intrinsic Table	Attributes
Private Member Functions
void	isAdded ()
	This method is used by the Table class when this row is added to the table.
	CalDataRow (CalDataTable &table)
	Create a CalDataRow.
	CalDataRow (CalDataTable &table, CalDataRow &row)
	Create a CalDataRow using a copy constructor mechanism.
void	setCalDataId (Tag calDataId)
	Set calDataId with the specified Tag value.
Private Attributes
CalDataTable &	table
	The table to which this row belongs.
bool	hasBeenAdded
	Whether this row has been added to the table or not.
int	numScan
	===> Attribute numScan
bool	frequencyGroupExists
	===> Attribute frequencyGroup, which is optional
int	frequencyGroup
vector< int >	scanSet
	===> Attribute scanSet
CalTypeMod::CalType	calType
	===> Attribute calType
bool	freqGroupNameExists
	===> Attribute freqGroupName, which is optional
string	freqGroupName
bool	fieldNameExists
	===> Attribute fieldName, which is optional
string	fieldName
bool	fieldCodeExists
	===> Attribute fieldCode, which is optional
vector< string >	fieldCode
ArrayTime	startTimeObserved
	===> Attribute startTimeObserved
ArrayTime	endTimeObserved
	===> Attribute endTimeObserved
bool	sourceNameExists
	===> Attribute sourceName, which is optional
vector< string >	sourceName
bool	sourceCodeExists
	===> Attribute sourceCode, which is optional
vector< string >	sourceCode
bool	scanIntentExists
	===> Attribute scanIntent, which is optional
vector< ScanIntentMod::ScanIntent >	scanIntent
bool	assocCalDataIdExists
	===> Attribute assocCalDataId, which is optional
Tag	assocCalDataId
bool	assocCalNatureExists
	===> Attribute assocCalNature, which is optional
AssociatedCalNatureMod::AssociatedCalNature	assocCalNature
CalDataOriginMod::CalDataOrigin	calDataType
	===> Attribute calDataType
Friends
class	asdm::CalDataTable

---

Constructor & Destructor Documentation

virtual asdm::CalDataRow::~CalDataRow

(

)

[virtual]

asdm::CalDataRow::CalDataRow

(

CalDataTable &

table

)

[private]

Create a CalDataRow.

This constructor is private because only the table can create rows. All rows know the table to which they belong.

Parameters:

table

The table to which this row belongs.

asdm::CalDataRow::CalDataRow	(	CalDataTable &	table,
		CalDataRow &	row
	)			[private]

Create a CalDataRow using a copy constructor mechanism.

Given a CalDataRow row and a CalDataTable table, the method creates a new CalDataRow owned by table. Each attribute of the created row is a copy (deep) of the corresponding attribute of row. The method does not add the created row to its table, its simply parents it to table, a call to the add method has to be done in order to get the row added (very likely after having modified some of its attributes). If row is null then the method returns a row with default values for its attributes.

This constructor is private because only the table can create rows. All rows know the table to which they belong.

Parameters:

	table	The table to which this row belongs.
	row	The row which is to be copied.

---

Member Function Documentation

CalDataTable& asdm::CalDataRow::getTable

(

)

const

Return the table to which this row belongs.

CalDataRowIDL* asdm::CalDataRow::toIDL

(

)

const

Return this row in the form of an IDL struct.

Returns:

The values of this row as a CalDataRowIDL struct.

void asdm::CalDataRow::setFromIDL

(

CalDataRowIDL

x

)

throw (ConversionException)

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

Parameters:

x

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

string asdm::CalDataRow::toXML

(

)

const

Return this row in the form of an XML string.

Returns:

The values of this row as an XML string.

void asdm::CalDataRow::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.

int asdm::CalDataRow::getNumScan

(

)

const

Get numScan.

Returns:

numScan as int

void asdm::CalDataRow::setNumScan

(

int

numScan

)

Set numScan with the specified int.

Parameters:

numScan

The int value to which numScan is to be set.

bool asdm::CalDataRow::isFrequencyGroupExists

(

)

const

The attribute frequencyGroup is optional.

Return true if this attribute exists.

Returns:

true if and only if the frequencyGroup attribute exists.

int asdm::CalDataRow::getFrequencyGroup

(

)

const throw (IllegalAccessException)

Get frequencyGroup, which is optional.

Returns:

frequencyGroup as int

Exceptions:

IllegalAccessException

If frequencyGroup does not exist.

void asdm::CalDataRow::setFrequencyGroup

(

int

frequencyGroup

)

Set frequencyGroup with the specified int.

Parameters:

frequencyGroup

The int value to which frequencyGroup is to be set.

void asdm::CalDataRow::clearFrequencyGroup

(

)

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

vector<int > asdm::CalDataRow::getScanSet

(

)

const

Get scanSet.

Returns:

scanSet as vector<int >

void asdm::CalDataRow::setScanSet

(

vector< int >

scanSet

)

Set scanSet with the specified vector<int >.

Parameters:

scanSet

The vector<int > value to which scanSet is to be set.

CalTypeMod::CalType asdm::CalDataRow::getCalType

(

)

const

Get calType.

Returns:

calType as CalTypeMod::CalType

void asdm::CalDataRow::setCalType

(

CalTypeMod::CalType

calType

)

Set calType with the specified CalTypeMod::CalType.

Parameters:

calType

The CalTypeMod::CalType value to which calType is to be set.

bool asdm::CalDataRow::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::CalDataRow::getFreqGroupName

(

)

const throw (IllegalAccessException)

Get freqGroupName, which is optional.

Returns:

freqGroupName as string

Exceptions:

IllegalAccessException

If freqGroupName does not exist.

void asdm::CalDataRow::setFreqGroupName

(

string

freqGroupName

)

Set freqGroupName with the specified string.

Parameters:

freqGroupName

The string value to which freqGroupName is to be set.

void asdm::CalDataRow::clearFreqGroupName

(

)

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

bool asdm::CalDataRow::isFieldNameExists

(

)

const

The attribute fieldName is optional.

Return true if this attribute exists.

Returns:

true if and only if the fieldName attribute exists.

string asdm::CalDataRow::getFieldName

(

)

const throw (IllegalAccessException)

Get fieldName, which is optional.

Returns:

fieldName as string

Exceptions:

IllegalAccessException

If fieldName does not exist.

void asdm::CalDataRow::setFieldName

(

string

fieldName

)

Set fieldName with the specified string.

Parameters:

fieldName

The string value to which fieldName is to be set.

void asdm::CalDataRow::clearFieldName

(

)

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

bool asdm::CalDataRow::isFieldCodeExists

(

)

const

The attribute fieldCode is optional.

Return true if this attribute exists.

Returns:

true if and only if the fieldCode attribute exists.

vector<string > asdm::CalDataRow::getFieldCode

(

)

const throw (IllegalAccessException)

Get fieldCode, which is optional.

Returns:

fieldCode as vector<string >

Exceptions:

IllegalAccessException

If fieldCode does not exist.

void asdm::CalDataRow::setFieldCode

(

vector< string >

fieldCode

)

Set fieldCode with the specified vector<string >.

Parameters:

fieldCode

The vector<string > value to which fieldCode is to be set.

void asdm::CalDataRow::clearFieldCode

(

)

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

ArrayTime asdm::CalDataRow::getStartTimeObserved

(

)

const

Get startTimeObserved.

Returns:

startTimeObserved as ArrayTime

void asdm::CalDataRow::setStartTimeObserved

(

ArrayTime

startTimeObserved

)

Set startTimeObserved with the specified ArrayTime.

Parameters:

startTimeObserved

The ArrayTime value to which startTimeObserved is to be set.

ArrayTime asdm::CalDataRow::getEndTimeObserved

(

)

const

Get endTimeObserved.

Returns:

endTimeObserved as ArrayTime

void asdm::CalDataRow::setEndTimeObserved

(

ArrayTime

endTimeObserved

)

Set endTimeObserved with the specified ArrayTime.

Parameters:

endTimeObserved

The ArrayTime value to which endTimeObserved is to be set.

bool asdm::CalDataRow::isSourceNameExists

(

)

const

The attribute sourceName is optional.

Return true if this attribute exists.

Returns:

true if and only if the sourceName attribute exists.

vector<string > asdm::CalDataRow::getSourceName

(

)

const throw (IllegalAccessException)

Get sourceName, which is optional.

Returns:

sourceName as vector<string >

Exceptions:

IllegalAccessException

If sourceName does not exist.

void asdm::CalDataRow::setSourceName

(

vector< string >

sourceName

)

Set sourceName with the specified vector<string >.

Parameters:

sourceName

The vector<string > value to which sourceName is to be set.

void asdm::CalDataRow::clearSourceName

(

)

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

bool asdm::CalDataRow::isSourceCodeExists

(

)

const

The attribute sourceCode is optional.

Return true if this attribute exists.

Returns:

true if and only if the sourceCode attribute exists.

vector<string > asdm::CalDataRow::getSourceCode

(

)

const throw (IllegalAccessException)

Get sourceCode, which is optional.

Returns:

sourceCode as vector<string >

Exceptions:

IllegalAccessException

If sourceCode does not exist.

void asdm::CalDataRow::setSourceCode

(

vector< string >

sourceCode

)

Set sourceCode with the specified vector<string >.

Parameters:

sourceCode

The vector<string > value to which sourceCode is to be set.

void asdm::CalDataRow::clearSourceCode

(

)

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

bool asdm::CalDataRow::isScanIntentExists

(

)

const

The attribute scanIntent is optional.

Return true if this attribute exists.

Returns:

true if and only if the scanIntent attribute exists.

vector<ScanIntentMod::ScanIntent > asdm::CalDataRow::getScanIntent

(

)

const throw (IllegalAccessException)

Get scanIntent, which is optional.

Returns:

scanIntent as vector<ScanIntentMod::ScanIntent >

Exceptions:

IllegalAccessException

If scanIntent does not exist.

void asdm::CalDataRow::setScanIntent

(

vector< ScanIntentMod::ScanIntent >

scanIntent

)

Set scanIntent with the specified vector<ScanIntentMod::ScanIntent >.

Parameters:

scanIntent

The vector<ScanIntentMod::ScanIntent > value to which scanIntent is to be set.

void asdm::CalDataRow::clearScanIntent

(

)

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

bool asdm::CalDataRow::isAssocCalDataIdExists

(

)

const

The attribute assocCalDataId is optional.

Return true if this attribute exists.

Returns:

true if and only if the assocCalDataId attribute exists.

Tag asdm::CalDataRow::getAssocCalDataId

(

)

const throw (IllegalAccessException)

Get assocCalDataId, which is optional.

Returns:

assocCalDataId as Tag

Exceptions:

IllegalAccessException

If assocCalDataId does not exist.

void asdm::CalDataRow::setAssocCalDataId

(

Tag

assocCalDataId

)

Set assocCalDataId with the specified Tag.

Parameters:

assocCalDataId

The Tag value to which assocCalDataId is to be set.

void asdm::CalDataRow::clearAssocCalDataId

(

)

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

bool asdm::CalDataRow::isAssocCalNatureExists

(

)

const

The attribute assocCalNature is optional.

Return true if this attribute exists.

Returns:

true if and only if the assocCalNature attribute exists.

AssociatedCalNatureMod::AssociatedCalNature asdm::CalDataRow::getAssocCalNature

(

)

const throw (IllegalAccessException)

Get assocCalNature, which is optional.

Returns:

assocCalNature as AssociatedCalNatureMod::AssociatedCalNature

Exceptions:

IllegalAccessException

If assocCalNature does not exist.

void asdm::CalDataRow::setAssocCalNature

(

AssociatedCalNatureMod::AssociatedCalNature

assocCalNature

)

Set assocCalNature with the specified AssociatedCalNatureMod::AssociatedCalNature.

Parameters:

assocCalNature

The AssociatedCalNatureMod::AssociatedCalNature value to which assocCalNature is to be set.

void asdm::CalDataRow::clearAssocCalNature

(

)

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

CalDataOriginMod::CalDataOrigin asdm::CalDataRow::getCalDataType

(

)

const

Get calDataType.

Returns:

calDataType as CalDataOriginMod::CalDataOrigin

void asdm::CalDataRow::setCalDataType

(

CalDataOriginMod::CalDataOrigin

calDataType

)

Set calDataType with the specified CalDataOriginMod::CalDataOrigin.

Parameters:

calDataType

The CalDataOriginMod::CalDataOrigin value to which calDataType is to be set.

Extrinsic Table Attributes Links* bool asdm::CalDataRow::compareNoAutoInc	(	int	numScan,
		vector< int >	scanSet,
		CalTypeMod::CalType	calType,
		ArrayTime	startTimeObserved,
		ArrayTime	endTimeObserved,
		CalDataOriginMod::CalDataOrigin	calDataType
	)

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

bool asdm::CalDataRow::compareRequiredValue	(	int	numScan,
		vector< int >	scanSet,
		CalTypeMod::CalType	calType,
		ArrayTime	startTimeObserved,
		ArrayTime	endTimeObserved,
		CalDataOriginMod::CalDataOrigin	calDataType
	)

bool asdm::CalDataRow::equalByRequiredValue

(

CalDataRow *

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 CalDataRow whose required attributes of the value part will be compared with those of this.

Returns:

a boolean.

void asdm::CalDataRow::isAdded

(

)

[private]

This method is used by the Table class when this row is added to the table.

void asdm::CalDataRow::setCalDataId

(

Tag

calDataId

)

[private]

Set calDataId with the specified Tag value.

Parameters:

calDataId

The Tag value to which calDataId is to be set.

Exceptions:

IllegalAccessException

If an attempt is made to change this field after is has been added to the table.

---

Friends And Related Function Documentation

friend class asdm::CalDataTable [friend]

Definition at line 161 of file CalDataRow.h.

---

Member Data Documentation

Intrinsic Table asdm::CalDataRow::Attributes

Definition at line 206 of file CalDataRow.h.

CalDataTable& asdm::CalDataRow::table [private]

The table to which this row belongs.

Definition at line 811 of file CalDataRow.h.

bool asdm::CalDataRow::hasBeenAdded [private]

Whether this row has been added to the table or not.

Definition at line 815 of file CalDataRow.h.

int asdm::CalDataRow::numScan [private]

===> Attribute numScan

Definition at line 882 of file CalDataRow.h.

bool asdm::CalDataRow::frequencyGroupExists [private]

===> Attribute frequencyGroup, which is optional

Definition at line 892 of file CalDataRow.h.

int asdm::CalDataRow::frequencyGroup [private]

Definition at line 895 of file CalDataRow.h.

vector<int > asdm::CalDataRow::scanSet [private]

===> Attribute scanSet

Definition at line 906 of file CalDataRow.h.

CalTypeMod::CalType asdm::CalDataRow::calType [private]

===> Attribute calType

Definition at line 917 of file CalDataRow.h.

bool asdm::CalDataRow::freqGroupNameExists [private]

===> Attribute freqGroupName, which is optional

Definition at line 927 of file CalDataRow.h.

string asdm::CalDataRow::freqGroupName [private]

Definition at line 930 of file CalDataRow.h.

bool asdm::CalDataRow::fieldNameExists [private]

===> Attribute fieldName, which is optional

Definition at line 940 of file CalDataRow.h.

string asdm::CalDataRow::fieldName [private]

Definition at line 943 of file CalDataRow.h.

bool asdm::CalDataRow::fieldCodeExists [private]

===> Attribute fieldCode, which is optional

Definition at line 953 of file CalDataRow.h.

vector<string > asdm::CalDataRow::fieldCode [private]

Definition at line 956 of file CalDataRow.h.

ArrayTime asdm::CalDataRow::startTimeObserved [private]

===> Attribute startTimeObserved

Definition at line 967 of file CalDataRow.h.

ArrayTime asdm::CalDataRow::endTimeObserved [private]

===> Attribute endTimeObserved

Definition at line 978 of file CalDataRow.h.

bool asdm::CalDataRow::sourceNameExists [private]

===> Attribute sourceName, which is optional

Definition at line 988 of file CalDataRow.h.

vector<string > asdm::CalDataRow::sourceName [private]

Definition at line 991 of file CalDataRow.h.

bool asdm::CalDataRow::sourceCodeExists [private]

===> Attribute sourceCode, which is optional

Definition at line 1001 of file CalDataRow.h.

vector<string > asdm::CalDataRow::sourceCode [private]

Definition at line 1004 of file CalDataRow.h.

bool asdm::CalDataRow::scanIntentExists [private]

===> Attribute scanIntent, which is optional

Definition at line 1014 of file CalDataRow.h.

vector<ScanIntentMod::ScanIntent > asdm::CalDataRow::scanIntent [private]

Definition at line 1017 of file CalDataRow.h.

bool asdm::CalDataRow::assocCalDataIdExists [private]

===> Attribute assocCalDataId, which is optional

Definition at line 1027 of file CalDataRow.h.

Tag asdm::CalDataRow::assocCalDataId [private]

Definition at line 1030 of file CalDataRow.h.

bool asdm::CalDataRow::assocCalNatureExists [private]

===> Attribute assocCalNature, which is optional

Definition at line 1040 of file CalDataRow.h.

AssociatedCalNatureMod::AssociatedCalNature asdm::CalDataRow::assocCalNature [private]

Definition at line 1043 of file CalDataRow.h.

CalDataOriginMod::CalDataOrigin asdm::CalDataRow::calDataType [private]

===> Attribute calDataType

Definition at line 1054 of file CalDataRow.h.

---

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

• alma/implement/ASDM/CalDataRow.h

---