asdm::CorrelatorModeRow Class Reference

The CorrelatorModeRow class is a row of a CorrelatorModeTable. More...

#include <CorrelatorModeRow.h>

List of all members.

Public Member Functions
virtual	~CorrelatorModeRow ()
	friend class asdm::TableStreamReader<CorrelatorModeTable, CorrelatorModeRow>;
CorrelatorModeTable &	getTable () const
	Return the table to which this row belongs.
bool	isAdded () const
	Has this row been added to its table ?
int	getNumBaseband () const
	===> Attribute numBaseband
void	setNumBaseband (int numBaseband)
	Set numBaseband with the specified int.
vector < BasebandNameMod::BasebandName >	getBasebandNames () const
	===> Attribute basebandNames
void	setBasebandNames (vector< BasebandNameMod::BasebandName > basebandNames)
	Set basebandNames with the specified vector<BasebandNameMod::BasebandName >.
vector< int >	getBasebandConfig () const
	===> Attribute basebandConfig
void	setBasebandConfig (vector< int > basebandConfig)
	Set basebandConfig with the specified vector<int >.
AccumModeMod::AccumMode	getAccumMode () const
	===> Attribute accumMode
void	setAccumMode (AccumModeMod::AccumMode accumMode)
	Set accumMode with the specified AccumModeMod::AccumMode.
int	getBinMode () const
	===> Attribute binMode
void	setBinMode (int binMode)
	Set binMode with the specified int.
int	getNumAxes () const
	===> Attribute numAxes
void	setNumAxes (int numAxes)
	Set numAxes with the specified int.
vector< AxisNameMod::AxisName >	getAxesOrderArray () const
	===> Attribute axesOrderArray
void	setAxesOrderArray (vector< AxisNameMod::AxisName > axesOrderArray)
	Set axesOrderArray with the specified vector<AxisNameMod::AxisName >.
vector< FilterModeMod::FilterMode >	getFilterMode () const
	===> Attribute filterMode
void	setFilterMode (vector< FilterModeMod::FilterMode > filterMode)
	Set filterMode with the specified vector<FilterModeMod::FilterMode >.
CorrelatorNameMod::CorrelatorName	getCorrelatorName () const
	===> Attribute correlatorName
void	setCorrelatorName (CorrelatorNameMod::CorrelatorName correlatorName)
	Set correlatorName with the specified CorrelatorNameMod::CorrelatorName.
Extrinsic Table Attributes Links *bool	compareNoAutoInc (int numBaseband, vector< BasebandNameMod::BasebandName > basebandNames, vector< int > basebandConfig, AccumModeMod::AccumMode accumMode, int binMode, int numAxes, vector< AxisNameMod::AxisName > axesOrderArray, vector< FilterModeMod::FilterMode > filterMode, CorrelatorNameMod::CorrelatorName correlatorName)
	Compare each mandatory attribute except the autoincrementable one of this CorrelatorModeRow with the corresponding parameters and return true if there is a match and false otherwise.
bool	compareRequiredValue (int numBaseband, vector< BasebandNameMod::BasebandName > basebandNames, vector< int > basebandConfig, AccumModeMod::AccumMode accumMode, int binMode, int numAxes, vector< AxisNameMod::AxisName > axesOrderArray, vector< FilterModeMod::FilterMode > filterMode, CorrelatorNameMod::CorrelatorName correlatorName)
	Compare each mandatory value (i.e.
bool	equalByRequiredValue (CorrelatorModeRow *x)
	Return true if all required attributes of the value part are equal to their homologues in x and false otherwise.
asdmIDL::CorrelatorModeRowIDL *	toIDL () const
	Return this row in the form of an IDL struct.
void	toIDL (asdmIDL::CorrelatorModeRowIDL &x) const
	Define the content of a CorrelatorModeRowIDL struct from the values found in this row.
void	setFromIDL (asdmIDL::CorrelatorModeRowIDL x)
	Fill the values of this row from the IDL struct CorrelatorModeRowIDL.
std::string	toXML () const
	Return this row in the form of an XML string.
void	setFromXML (std::string rowDoc)
	Fill the values of this row from an XML string that was produced by the toXML() method.
Public Attributes
Intrinsic Table	Attributes
Private Member Functions
void	isAdded (bool added)
	This method is used by the Table class when this row is added to the table.
	CorrelatorModeRow (CorrelatorModeTable &table)
	Create a CorrelatorModeRow.
	CorrelatorModeRow (CorrelatorModeTable &table, CorrelatorModeRow &row)
	Create a CorrelatorModeRow using a copy constructor mechanism.
void	setCorrelatorModeId (Tag correlatorModeId)
	Set correlatorModeId with the specified Tag value.
void	correlatorModeIdFromBin (EndianIStream &eis)
void	numBasebandFromBin (EndianIStream &eis)
void	basebandNamesFromBin (EndianIStream &eis)
void	basebandConfigFromBin (EndianIStream &eis)
void	accumModeFromBin (EndianIStream &eis)
void	binModeFromBin (EndianIStream &eis)
void	numAxesFromBin (EndianIStream &eis)
void	axesOrderArrayFromBin (EndianIStream &eis)
void	filterModeFromBin (EndianIStream &eis)
void	correlatorNameFromBin (EndianIStream &eis)
void	correlatorModeIdFromText (const string &s)
void	numBasebandFromText (const string &s)
void	basebandNamesFromText (const string &s)
void	basebandConfigFromText (const string &s)
void	accumModeFromText (const string &s)
void	binModeFromText (const string &s)
void	numAxesFromText (const string &s)
void	axesOrderArrayFromText (const string &s)
void	filterModeFromText (const string &s)
void	correlatorNameFromText (const string &s)
void	toBin (EndianOSStream &eoss)
	Serialize this into a stream of bytes written to an EndianOSStream.
Private Attributes
CorrelatorModeTable &	table
	The table to which this row belongs.
bool	hasBeenAdded
	Whether this row has been added to the table or not.
int	numBaseband
	===> Attribute numBaseband
vector < BasebandNameMod::BasebandName >	basebandNames
	===> Attribute basebandNames
vector< int >	basebandConfig
	===> Attribute basebandConfig
AccumModeMod::AccumMode	accumMode
	===> Attribute accumMode
int	binMode
	===> Attribute binMode
int	numAxes
	===> Attribute numAxes
vector< AxisNameMod::AxisName >	axesOrderArray
	===> Attribute axesOrderArray
vector< FilterModeMod::FilterMode >	filterMode
	===> Attribute filterMode
CorrelatorNameMod::CorrelatorName	correlatorName
	===> Attribute correlatorName
Extrinsic Table Attributes Links *binary deserialization material from an EndianIStream std::map< std::string, CorrelatorModeAttributeFromBin >	fromBinMethods
*text deserialization material std::map< std::string, CorrelatorModeAttributeFromText >	fromTextMethods
Friends
class	asdm::CorrelatorModeTable
class	asdm::RowTransformer< CorrelatorModeRow >

---

Detailed Description

The CorrelatorModeRow class is a row of a CorrelatorModeTable.

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

Definition at line 116 of file CorrelatorModeRow.h.

---

Constructor & Destructor Documentation

virtual asdm::CorrelatorModeRow::~CorrelatorModeRow

(

)

[virtual]

friend class asdm::TableStreamReader<CorrelatorModeTable, CorrelatorModeRow>;

asdm::CorrelatorModeRow::CorrelatorModeRow

(

CorrelatorModeTable &

table

)

[private]

Create a CorrelatorModeRow.

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::CorrelatorModeRow::CorrelatorModeRow	(	CorrelatorModeTable &	table,
		CorrelatorModeRow &	row
	)			[private]

Create a CorrelatorModeRow using a copy constructor mechanism.

Given a CorrelatorModeRow row and a CorrelatorModeTable table, the method creates a new CorrelatorModeRow 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

void asdm::CorrelatorModeRow::accumModeFromBin

(

EndianIStream &

eis

)

[private]

void asdm::CorrelatorModeRow::accumModeFromText

(

const string &

s

)

[private]

void asdm::CorrelatorModeRow::axesOrderArrayFromBin

(

EndianIStream &

eis

)

[private]

void asdm::CorrelatorModeRow::axesOrderArrayFromText

(

const string &

s

)

[private]

void asdm::CorrelatorModeRow::basebandConfigFromBin

(

EndianIStream &

eis

)

[private]

void asdm::CorrelatorModeRow::basebandConfigFromText

(

const string &

s

)

[private]

void asdm::CorrelatorModeRow::basebandNamesFromBin

(

EndianIStream &

eis

)

[private]

void asdm::CorrelatorModeRow::basebandNamesFromText

(

const string &

s

)

[private]

void asdm::CorrelatorModeRow::binModeFromBin

(

EndianIStream &

eis

)

[private]

void asdm::CorrelatorModeRow::binModeFromText

(

const string &

s

)

[private]

Extrinsic Table Attributes Links* bool asdm::CorrelatorModeRow::compareNoAutoInc	(	int	numBaseband,
		vector< BasebandNameMod::BasebandName >	basebandNames,
		vector< int >	basebandConfig,
		AccumModeMod::AccumMode	accumMode,
		int	binMode,
		int	numAxes,
		vector< AxisNameMod::AxisName >	axesOrderArray,
		vector< FilterModeMod::FilterMode >	filterMode,
		CorrelatorNameMod::CorrelatorName	correlatorName
	)

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

Parameters:

	numBaseband
	basebandNames
	basebandConfig
	accumMode
	binMode
	numAxes
	axesOrderArray
	filterMode
	correlatorName

bool asdm::CorrelatorModeRow::compareRequiredValue	(	int	numBaseband,
		vector< BasebandNameMod::BasebandName >	basebandNames,
		vector< int >	basebandConfig,
		AccumModeMod::AccumMode	accumMode,
		int	binMode,
		int	numAxes,
		vector< AxisNameMod::AxisName >	axesOrderArray,
		vector< FilterModeMod::FilterMode >	filterMode,
		CorrelatorNameMod::CorrelatorName	correlatorName
	)

Compare each mandatory value (i.e.

not in the key) attribute with the corresponding parameters and return true if there is a match and false otherwise.

Parameters:

	numBaseband
	basebandNames
	basebandConfig
	accumMode
	binMode
	numAxes
	axesOrderArray
	filterMode
	correlatorName

void asdm::CorrelatorModeRow::correlatorModeIdFromBin

(

EndianIStream &

eis

)

[private]

void asdm::CorrelatorModeRow::correlatorModeIdFromText

(

const string &

s

)

[private]

void asdm::CorrelatorModeRow::correlatorNameFromBin

(

EndianIStream &

eis

)

[private]

void asdm::CorrelatorModeRow::correlatorNameFromText

(

const string &

s

)

[private]

bool asdm::CorrelatorModeRow::equalByRequiredValue

(

CorrelatorModeRow *

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

Returns:

a boolean.

void asdm::CorrelatorModeRow::filterModeFromBin

(

EndianIStream &

eis

)

[private]

void asdm::CorrelatorModeRow::filterModeFromText

(

const string &

s

)

[private]

AccumModeMod::AccumMode asdm::CorrelatorModeRow::getAccumMode

(

)

const

===> Attribute accumMode

Get accumMode.

Returns:

accumMode as AccumModeMod::AccumMode

vector<AxisNameMod::AxisName > asdm::CorrelatorModeRow::getAxesOrderArray

(

)

const

===> Attribute axesOrderArray

Get axesOrderArray.

Returns:

axesOrderArray as vector<AxisNameMod::AxisName >

vector<int > asdm::CorrelatorModeRow::getBasebandConfig

(

)

const

===> Attribute basebandConfig

Get basebandConfig.

Returns:

basebandConfig as vector<int >

vector<BasebandNameMod::BasebandName > asdm::CorrelatorModeRow::getBasebandNames

(

)

const

===> Attribute basebandNames

Get basebandNames.

Returns:

basebandNames as vector<BasebandNameMod::BasebandName >

int asdm::CorrelatorModeRow::getBinMode

(

)

const

===> Attribute binMode

Get binMode.

Returns:

binMode as int

CorrelatorNameMod::CorrelatorName asdm::CorrelatorModeRow::getCorrelatorName

(

)

const

===> Attribute correlatorName

Get correlatorName.

Returns:

correlatorName as CorrelatorNameMod::CorrelatorName

vector<FilterModeMod::FilterMode > asdm::CorrelatorModeRow::getFilterMode

(

)

const

===> Attribute filterMode

Get filterMode.

Returns:

filterMode as vector<FilterModeMod::FilterMode >

int asdm::CorrelatorModeRow::getNumAxes

(

)

const

===> Attribute numAxes

Get numAxes.

Returns:

numAxes as int

int asdm::CorrelatorModeRow::getNumBaseband

(

)

const

===> Attribute numBaseband

Get numBaseband.

Returns:

numBaseband as int

CorrelatorModeTable& asdm::CorrelatorModeRow::getTable

(

)

const

Return the table to which this row belongs.

void asdm::CorrelatorModeRow::isAdded

(

bool

added

)

[private]

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

bool asdm::CorrelatorModeRow::isAdded

(

)

const

Has this row been added to its table ?

Returns:

true if and only if it has been added.

void asdm::CorrelatorModeRow::numAxesFromBin

(

EndianIStream &

eis

)

[private]

void asdm::CorrelatorModeRow::numAxesFromText

(

const string &

s

)

[private]

void asdm::CorrelatorModeRow::numBasebandFromBin

(

EndianIStream &

eis

)

[private]

void asdm::CorrelatorModeRow::numBasebandFromText

(

const string &

s

)

[private]

void asdm::CorrelatorModeRow::setAccumMode

(

AccumModeMod::AccumMode

accumMode

)

Set accumMode with the specified AccumModeMod::AccumMode.

Parameters:

accumMode

The AccumModeMod::AccumMode value to which accumMode is to be set.

void asdm::CorrelatorModeRow::setAxesOrderArray

(

vector< AxisNameMod::AxisName >

axesOrderArray

)

Set axesOrderArray with the specified vector<AxisNameMod::AxisName >.

Parameters:

axesOrderArray

The vector<AxisNameMod::AxisName > value to which axesOrderArray is to be set.

void asdm::CorrelatorModeRow::setBasebandConfig

(

vector< int >

basebandConfig

)

Set basebandConfig with the specified vector<int >.

Parameters:

basebandConfig

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

void asdm::CorrelatorModeRow::setBasebandNames

(

vector< BasebandNameMod::BasebandName >

basebandNames

)

Set basebandNames with the specified vector<BasebandNameMod::BasebandName >.

Parameters:

basebandNames

The vector<BasebandNameMod::BasebandName > value to which basebandNames is to be set.

void asdm::CorrelatorModeRow::setBinMode

(

int

binMode

)

Set binMode with the specified int.

Parameters:

binMode

The int value to which binMode is to be set.

void asdm::CorrelatorModeRow::setCorrelatorModeId

(

Tag

correlatorModeId

)

[private]

Set correlatorModeId with the specified Tag value.

Parameters:

correlatorModeId

The Tag value to which correlatorModeId is to be set.

Exceptions:

IllegalAccessException

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

void asdm::CorrelatorModeRow::setCorrelatorName

(

CorrelatorNameMod::CorrelatorName

correlatorName

)

Set correlatorName with the specified CorrelatorNameMod::CorrelatorName.

Parameters:

correlatorName

The CorrelatorNameMod::CorrelatorName value to which correlatorName is to be set.

void asdm::CorrelatorModeRow::setFilterMode

(

vector< FilterModeMod::FilterMode >

filterMode

)

Set filterMode with the specified vector<FilterModeMod::FilterMode >.

Parameters:

filterMode

The vector<FilterModeMod::FilterMode > value to which filterMode is to be set.

void asdm::CorrelatorModeRow::setFromIDL

(

asdmIDL::CorrelatorModeRowIDL

x

)

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

Parameters:

x

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

Exceptions:

ConversionException

void asdm::CorrelatorModeRow::setFromXML

(

std::string

rowDoc

)

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

Parameters:

rowDoc

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

Exceptions:

ConversionException

void asdm::CorrelatorModeRow::setNumAxes

(

int

numAxes

)

Set numAxes with the specified int.

Parameters:

numAxes

The int value to which numAxes is to be set.

void asdm::CorrelatorModeRow::setNumBaseband

(

int

numBaseband

)

Set numBaseband with the specified int.

Parameters:

numBaseband

The int value to which numBaseband is to be set.

void asdm::CorrelatorModeRow::toBin

(

EndianOSStream &

eoss

)

[private]

Serialize this into a stream of bytes written to an EndianOSStream.

Parameters:

eoss

the EndianOSStream to be written to

void asdm::CorrelatorModeRow::toIDL

(

asdmIDL::CorrelatorModeRowIDL &

x

)

const

Define the content of a CorrelatorModeRowIDL struct from the values found in this row.

Parameters:

x

a reference to the CorrelatorModeRowIDL struct to be set.

asdmIDL::CorrelatorModeRowIDL* asdm::CorrelatorModeRow::toIDL

(

)

const

Return this row in the form of an IDL struct.

Returns:

The values of this row as a CorrelatorModeRowIDL struct.

std::string asdm::CorrelatorModeRow::toXML

(

)

const

Return this row in the form of an XML string.

Returns:

The values of this row as an XML string.

---

Friends And Related Function Documentation

friend class asdm::CorrelatorModeTable [friend]

Definition at line 117 of file CorrelatorModeRow.h.

friend class asdm::RowTransformer< CorrelatorModeRow > [friend]

Definition at line 118 of file CorrelatorModeRow.h.

---

Member Data Documentation

AccumModeMod::AccumMode asdm::CorrelatorModeRow::accumMode [private]

===> Attribute accumMode

Definition at line 690 of file CorrelatorModeRow.h.

Intrinsic Table asdm::CorrelatorModeRow::Attributes

Definition at line 141 of file CorrelatorModeRow.h.

vector<AxisNameMod::AxisName > asdm::CorrelatorModeRow::axesOrderArray [private]

===> Attribute axesOrderArray

Definition at line 723 of file CorrelatorModeRow.h.

vector<int > asdm::CorrelatorModeRow::basebandConfig [private]

===> Attribute basebandConfig

Definition at line 679 of file CorrelatorModeRow.h.

vector<BasebandNameMod::BasebandName > asdm::CorrelatorModeRow::basebandNames [private]

===> Attribute basebandNames

Definition at line 668 of file CorrelatorModeRow.h.

int asdm::CorrelatorModeRow::binMode [private]

===> Attribute binMode

Definition at line 701 of file CorrelatorModeRow.h.

CorrelatorNameMod::CorrelatorName asdm::CorrelatorModeRow::correlatorName [private]

===> Attribute correlatorName

Definition at line 745 of file CorrelatorModeRow.h.

vector<FilterModeMod::FilterMode > asdm::CorrelatorModeRow::filterMode [private]

===> Attribute filterMode

Definition at line 734 of file CorrelatorModeRow.h.

Extrinsic Table Attributes Links* binary deserialization material from an EndianIStream std::map<std::string, CorrelatorModeAttributeFromBin> asdm::CorrelatorModeRow::fromBinMethods [private]

Definition at line 764 of file CorrelatorModeRow.h.

* text deserialization material std::map<std::string, CorrelatorModeAttributeFromText> asdm::CorrelatorModeRow::fromTextMethods [private]

Definition at line 782 of file CorrelatorModeRow.h.

bool asdm::CorrelatorModeRow::hasBeenAdded [private]

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

Definition at line 590 of file CorrelatorModeRow.h.

int asdm::CorrelatorModeRow::numAxes [private]

===> Attribute numAxes

Definition at line 712 of file CorrelatorModeRow.h.

int asdm::CorrelatorModeRow::numBaseband [private]

===> Attribute numBaseband

Definition at line 657 of file CorrelatorModeRow.h.

CorrelatorModeTable& asdm::CorrelatorModeRow::table [private]

The table to which this row belongs.

Definition at line 586 of file CorrelatorModeRow.h.

---

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

• code/alma/ASDM/CorrelatorModeRow.h