asdm::PolarizationRow Class Reference

The PolarizationRow class is a row of a PolarizationTable. More...

#include <PolarizationRow.h>

Public Member Functions
virtual	~PolarizationRow ()
	friend class asdm::TableStreamReader<PolarizationTable, PolarizationRow>;
PolarizationTable &	getTable () const
	Return the table to which this row belongs.
bool	isAdded () const
	Has this row been added to its table ?
int	getNumCorr () const
	===> Attribute numCorr
void	setNumCorr (int numCorr)
	Set numCorr with the specified int.
vector < StokesParameterMod::StokesParameter >	getCorrType () const
	===> Attribute corrType
void	setCorrType (vector< StokesParameterMod::StokesParameter > corrType)
	Set corrType with the specified vector<StokesParameterMod::StokesParameter >.
vector< vector < PolarizationTypeMod::PolarizationType > >	getCorrProduct () const
	===> Attribute corrProduct
void	setCorrProduct (vector< vector< PolarizationTypeMod::PolarizationType > > corrProduct)
	Set corrProduct with the specified vector<vector<PolarizationTypeMod::PolarizationType > >.
Extrinsic Table Attributes Links *bool	compareNoAutoInc (int numCorr, vector< StokesParameterMod::StokesParameter > corrType, vector< vector< PolarizationTypeMod::PolarizationType > > corrProduct)
	Compare each mandatory attribute except the autoincrementable one of this PolarizationRow with the corresponding parameters and return true if there is a match and false otherwise.
bool	compareRequiredValue (int numCorr, vector< StokesParameterMod::StokesParameter > corrType, vector< vector< PolarizationTypeMod::PolarizationType > > corrProduct)
	Compare each mandatory value (i.e.
bool	equalByRequiredValue (PolarizationRow *x)
	Return true if all required attributes of the value part are equal to their homologues in x and false otherwise.
asdmIDL::PolarizationRowIDL *	toIDL () const
	Return this row in the form of an IDL struct.
void	toIDL (asdmIDL::PolarizationRowIDL &x) const
	Define the content of a PolarizationRowIDL struct from the values found in this row.
void	setFromIDL (asdmIDL::PolarizationRowIDL x)
	Fill the values of this row from the IDL struct PolarizationRowIDL.
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.
	PolarizationRow (PolarizationTable &table)
	Create a PolarizationRow.
	PolarizationRow (PolarizationTable &table, PolarizationRow &row)
	Create a PolarizationRow using a copy constructor mechanism.
void	setPolarizationId (Tag polarizationId)
	Set polarizationId with the specified Tag value.
void	polarizationIdFromBin (EndianIStream &eis)
void	numCorrFromBin (EndianIStream &eis)
void	corrTypeFromBin (EndianIStream &eis)
void	corrProductFromBin (EndianIStream &eis)
void	polarizationIdFromText (const string &s)
void	numCorrFromText (const string &s)
void	corrTypeFromText (const string &s)
void	corrProductFromText (const string &s)
void	toBin (EndianOSStream &eoss)
	Serialize this into a stream of bytes written to an EndianOSStream.
Private Attributes
PolarizationTable &	table
	The table to which this row belongs.
bool	hasBeenAdded
	Whether this row has been added to the table or not.
int	numCorr
	===> Attribute numCorr
vector < StokesParameterMod::StokesParameter >	corrType
	===> Attribute corrType
vector< vector < PolarizationTypeMod::PolarizationType > >	corrProduct
	===> Attribute corrProduct
Extrinsic Table Attributes Links *binary deserialization material from an EndianIStream std::map< std::string, PolarizationAttributeFromBin >	fromBinMethods
*text deserialization material std::map< std::string, PolarizationAttributeFromText >	fromTextMethods
Friends
class	asdm::PolarizationTable
class	asdm::RowTransformer< PolarizationRow >

Detailed Description

The PolarizationRow class is a row of a PolarizationTable.

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

Definition at line 98 of file PolarizationRow.h.

Constructor & Destructor Documentation

virtual asdm::PolarizationRow::~PolarizationRow ( ) [virtual]

friend class asdm::TableStreamReader<PolarizationTable, PolarizationRow>;

asdm::PolarizationRow::PolarizationRow ( PolarizationTable & table ) [private]

Create a PolarizationRow.

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::PolarizationRow::PolarizationRow	(	PolarizationTable &	table,
		PolarizationRow &	row
	)			`[private]`

Create a PolarizationRow using a copy constructor mechanism.

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

Extrinsic Table Attributes Links* bool asdm::PolarizationRow::compareNoAutoInc	(	int	numCorr,
		vector< StokesParameterMod::StokesParameter >	corrType,
		vector< vector< PolarizationTypeMod::PolarizationType > >	corrProduct
	)

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

Parameters:

	numCorr
	corrType
	corrProduct

bool asdm::PolarizationRow::compareRequiredValue	(	int	numCorr,
		vector< StokesParameterMod::StokesParameter >	corrType,
		vector< vector< PolarizationTypeMod::PolarizationType > >	corrProduct
	)

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:

	numCorr
	corrType
	corrProduct

void asdm::PolarizationRow::corrProductFromBin ( EndianIStream & eis ) [private]

void asdm::PolarizationRow::corrProductFromText ( const string & s ) [private]

void asdm::PolarizationRow::corrTypeFromBin ( EndianIStream & eis ) [private]

void asdm::PolarizationRow::corrTypeFromText ( const string & s ) [private]

bool asdm::PolarizationRow::equalByRequiredValue ( PolarizationRow * 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 PolarizationRow whose required attributes of the value part will be compared with those of this.

Returns:: a boolean.

vector<vector<PolarizationTypeMod::PolarizationType > > asdm::PolarizationRow::getCorrProduct ( ) const

===> Attribute corrProduct

Get corrProduct.

Returns:: corrProduct as vector<vector<PolarizationTypeMod::PolarizationType > >

vector<StokesParameterMod::StokesParameter > asdm::PolarizationRow::getCorrType ( ) const

===> Attribute corrType

Get corrType.

Returns:: corrType as vector<StokesParameterMod::StokesParameter >

int asdm::PolarizationRow::getNumCorr ( ) const

===> Attribute numCorr

Get numCorr.

Returns:: numCorr as int

PolarizationTable& asdm::PolarizationRow::getTable ( ) const

Return the table to which this row belongs.

void asdm::PolarizationRow::isAdded ( bool added ) [private]

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

bool asdm::PolarizationRow::isAdded ( ) const

Has this row been added to its table ?

Returns:: true if and only if it has been added.

void asdm::PolarizationRow::numCorrFromBin ( EndianIStream & eis ) [private]

void asdm::PolarizationRow::numCorrFromText ( const string & s ) [private]

void asdm::PolarizationRow::polarizationIdFromBin ( EndianIStream & eis ) [private]

void asdm::PolarizationRow::polarizationIdFromText ( const string & s ) [private]

void asdm::PolarizationRow::setCorrProduct ( vector< vector< PolarizationTypeMod::PolarizationType > > corrProduct )

Set corrProduct with the specified vector<vector<PolarizationTypeMod::PolarizationType > >.

Parameters:

corrProduct

The vector<vector<PolarizationTypeMod::PolarizationType > > value to which corrProduct is to be set.

void asdm::PolarizationRow::setCorrType ( vector< StokesParameterMod::StokesParameter > corrType )

Set corrType with the specified vector<StokesParameterMod::StokesParameter >.

Parameters:

corrType

The vector<StokesParameterMod::StokesParameter > value to which corrType is to be set.

void asdm::PolarizationRow::setFromIDL ( asdmIDL::PolarizationRowIDL x )

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

Parameters:

x

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

Exceptions:

ConversionException

void asdm::PolarizationRow::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::PolarizationRow::setNumCorr ( int numCorr )

Set numCorr with the specified int.

Parameters:

numCorr

The int value to which numCorr is to be set.

void asdm::PolarizationRow::setPolarizationId ( Tag polarizationId ) [private]

Set polarizationId with the specified Tag value.

Parameters:

polarizationId

The Tag value to which polarizationId 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::PolarizationRow::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::PolarizationRow::toIDL ( asdmIDL::PolarizationRowIDL & x ) const

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

Parameters:

x

a reference to the PolarizationRowIDL struct to be set.

asdmIDL::PolarizationRowIDL* asdm::PolarizationRow::toIDL ( ) const

Return this row in the form of an IDL struct.

Returns:: The values of this row as a PolarizationRowIDL struct.

std::string asdm::PolarizationRow::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::PolarizationTable [friend]

Definition at line 99 of file PolarizationRow.h.

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

Definition at line 100 of file PolarizationRow.h.

Member Data Documentation

Intrinsic Table asdm::PolarizationRow::Attributes

Definition at line 123 of file PolarizationRow.h.

vector<vector<PolarizationTypeMod::PolarizationType > > asdm::PolarizationRow::corrProduct [private]

===> Attribute corrProduct

Definition at line 451 of file PolarizationRow.h.

vector<StokesParameterMod::StokesParameter > asdm::PolarizationRow::corrType [private]

===> Attribute corrType

Definition at line 440 of file PolarizationRow.h.

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

Definition at line 470 of file PolarizationRow.h.

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

Definition at line 482 of file PolarizationRow.h.

bool asdm::PolarizationRow::hasBeenAdded [private]

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

Definition at line 362 of file PolarizationRow.h.

int asdm::PolarizationRow::numCorr [private]

===> Attribute numCorr

Definition at line 429 of file PolarizationRow.h.

PolarizationTable& asdm::PolarizationRow::table [private]

The table to which this row belongs.

Definition at line 358 of file PolarizationRow.h.

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

code/alma/ASDM/PolarizationRow.h

asdm::PolarizationRow Class Reference

Public Member Functions

Public Attributes

Private Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation