The HolographyRow class is a row of a HolographyTable. More...

#include <HolographyRow.h>

Public Member Functions
virtual	~HolographyRow ()
	friend class asdm::TableStreamReader<HolographyTable, HolographyRow>; More...

HolographyTable &	getTable () const
	Return the table to which this row belongs. More...

bool	isAdded () const
	Has this row been added to its table ? More...

Length	getDistance () const
	===> Attribute distance More...

void	setDistance (Length distance)
	Set distance with the specified Length. More...

Length	getFocus () const
	===> Attribute focus More...

void	setFocus (Length focus)
	Set focus with the specified Length. More...

int	getNumCorr () const
	===> Attribute numCorr More...

void	setNumCorr (int numCorr)
	Set numCorr with the specified int. More...

std::vector < HolographyChannelTypeMod::HolographyChannelType >	getType () const
	===> Attribute type More...

void	setType (std::vector< HolographyChannelTypeMod::HolographyChannelType > type)
	Set type with the specified std::vector<HolographyChannelTypeMod::HolographyChannelType >. More...

Extrinsic Table Attributes Links *bool	compareNoAutoInc (Length distance, Length focus, int numCorr, std::vector< HolographyChannelTypeMod::HolographyChannelType > type)
	Compare each mandatory attribute except the autoincrementable one of this HolographyRow with the corresponding parameters and return true if there is a match and false otherwise. More...

bool	compareRequiredValue (Length distance, Length focus, int numCorr, std::vector< HolographyChannelTypeMod::HolographyChannelType > type)
	Compare each mandatory value (i.e. More...

bool	equalByRequiredValue (HolographyRow *x)
	Return true if all required attributes of the value part are equal to their homologues in x and false otherwise. More...

asdmIDL::HolographyRowIDL *	toIDL () const
	Return this row in the form of an IDL struct. More...

void	toIDL (asdmIDL::HolographyRowIDL &x) const
	Define the content of a HolographyRowIDL struct from the values found in this row. More...

void	setFromIDL (asdmIDL::HolographyRowIDL x)
	Fill the values of this row from the IDL struct HolographyRowIDL. More...

std::string	toXML () const
	Return this row in the form of an XML string. More...

void	setFromXML (std::string rowDoc)
	Fill the values of this row from an XML string that was produced by the toXML() method. More...

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. More...

	HolographyRow (HolographyTable &table)
	Create a HolographyRow. More...

	HolographyRow (HolographyTable &table, HolographyRow *row)
	Create a HolographyRow using a copy constructor mechanism. More...

void	setHolographyId (Tag holographyId)
	Set holographyId with the specified Tag value. More...

void	holographyIdFromBin (EndianIStream &eis)

void	distanceFromBin (EndianIStream &eis)

void	focusFromBin (EndianIStream &eis)

void	numCorrFromBin (EndianIStream &eis)

void	typeFromBin (EndianIStream &eis)

void	holographyIdFromText (const std::string &s)

void	distanceFromText (const std::string &s)

void	focusFromText (const std::string &s)

void	numCorrFromText (const std::string &s)

void	typeFromText (const std::string &s)

void	toBin (EndianOSStream &eoss)
	Serialize this into a stream of bytes written to an EndianOSStream. More...

Private Attributes
HolographyTable &	table
	The table to which this row belongs. More...

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

Length	distance
	===> Attribute distance More...

Length	focus
	===> Attribute focus More...

int	numCorr
	===> Attribute numCorr More...

std::vector < HolographyChannelTypeMod::HolographyChannelType >	type
	===> Attribute type More...

Extrinsic Table Attributes Links *binary deserialization material from an EndianIStream std::map< std::string, HolographyAttributeFromBin >	fromBinMethods

*text deserialization material std::map< std::string, HolographyAttributeFromText >	fromTextMethods

Friends
class	asdm::HolographyTable

class	asdm::RowTransformer< HolographyRow >

Detailed Description

The HolographyRow class is a row of a HolographyTable.

Generated from model's revision "-1", branch ""

Definition at line 102 of file HolographyRow.h.

Constructor & Destructor Documentation

virtual asdm::HolographyRow::~HolographyRow ( )

virtual

friend class asdm::TableStreamReader<HolographyTable, HolographyRow>;

asdm::HolographyRow::HolographyRow ( HolographyTable & table )

private

Create a HolographyRow.

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::HolographyRow::HolographyRow	(	HolographyTable &	table,
		HolographyRow *	row
	)

private

Create a HolographyRow using a copy constructor mechanism.

Given a HolographyRow row and a HolographyTable table, the method creates a new HolographyRow 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::HolographyRow::compareNoAutoInc	(	Length	distance,
		Length	focus,
		int	numCorr,
		std::vector< HolographyChannelTypeMod::HolographyChannelType >	type
	)

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

Parameters

distance
focus
numCorr
type

bool asdm::HolographyRow::compareRequiredValue	(	Length	distance,
		Length	focus,
		int	numCorr,
		std::vector< HolographyChannelTypeMod::HolographyChannelType >	type
	)

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

distance
focus
numCorr
type

void asdm::HolographyRow::distanceFromBin ( EndianIStream & eis )

private

void asdm::HolographyRow::distanceFromText ( const std::string & s )

private

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

Returns: a boolean.

void asdm::HolographyRow::focusFromBin ( EndianIStream & eis )

private

void asdm::HolographyRow::focusFromText ( const std::string & s )

private

Length asdm::HolographyRow::getDistance ( ) const

===> Attribute distance

Get distance.

Returns: distance as Length

Length asdm::HolographyRow::getFocus ( ) const

===> Attribute focus

Get focus.

Returns: focus as Length

int asdm::HolographyRow::getNumCorr ( ) const

===> Attribute numCorr

Get numCorr.

Returns: numCorr as int

HolographyTable& asdm::HolographyRow::getTable ( ) const

Return the table to which this row belongs.

std::vector<HolographyChannelTypeMod::HolographyChannelType > asdm::HolographyRow::getType ( ) const

===> Attribute type

Get type.

Returns: type as std::vector<HolographyChannelTypeMod::HolographyChannelType >

void asdm::HolographyRow::holographyIdFromBin ( EndianIStream & eis )

private

void asdm::HolographyRow::holographyIdFromText ( const std::string & s )

private

bool asdm::HolographyRow::isAdded ( ) const

Has this row been added to its table ?

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

void asdm::HolographyRow::isAdded ( bool added )

private

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

void asdm::HolographyRow::numCorrFromBin ( EndianIStream & eis )

private

void asdm::HolographyRow::numCorrFromText ( const std::string & s )

private

void asdm::HolographyRow::setDistance ( Length distance )

Set distance with the specified Length.

Parameters

distance The Length value to which distance is to be set.

void asdm::HolographyRow::setFocus ( Length focus )

Set focus with the specified Length.

Parameters

focus The Length value to which focus is to be set.

void asdm::HolographyRow::setFromIDL ( asdmIDL::HolographyRowIDL x )

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

Parameters

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

Exceptions

ConversionException

void asdm::HolographyRow::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::HolographyRow::setHolographyId ( Tag holographyId )

private

Set holographyId with the specified Tag value.

Parameters

holographyId The Tag value to which holographyId 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::HolographyRow::setNumCorr ( int numCorr )

Set numCorr with the specified int.

Parameters

numCorr The int value to which numCorr is to be set.

void asdm::HolographyRow::setType ( std::vector< HolographyChannelTypeMod::HolographyChannelType > type )

Set type with the specified std::vector<HolographyChannelTypeMod::HolographyChannelType >.

Parameters

type	The std::vector<HolographyChannelTypeMod::HolographyChannelType > value to which type is to be set.

void asdm::HolographyRow::toBin ( EndianOSStream & eoss )

private

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

Parameters

eoss	the EndianOSStream to be written to

asdmIDL::HolographyRowIDL* asdm::HolographyRow::toIDL ( ) const

Return this row in the form of an IDL struct.

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

void asdm::HolographyRow::toIDL ( asdmIDL::HolographyRowIDL & x ) const

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

Parameters

x	a reference to the HolographyRowIDL struct to be set.

std::string asdm::HolographyRow::toXML ( ) const

Return this row in the form of an XML string.

Returns: The values of this row as an XML string.

void asdm::HolographyRow::typeFromBin ( EndianIStream & eis )

private

void asdm::HolographyRow::typeFromText ( const std::string & s )

private

Friends And Related Function Documentation

friend class asdm::HolographyTable

friend

Definition at line 103 of file HolographyRow.h.

friend class asdm::RowTransformer< HolographyRow >

friend

Definition at line 104 of file HolographyRow.h.

Member Data Documentation

Intrinsic Table asdm::HolographyRow::Attributes

Definition at line 127 of file HolographyRow.h.

Length asdm::HolographyRow::distance

private

===> Attribute distance

Definition at line 468 of file HolographyRow.h.

Length asdm::HolographyRow::focus

private

===> Attribute focus

Definition at line 479 of file HolographyRow.h.

Extrinsic Table Attributes Links* binary deserialization material from an EndianIStream std::map<std::string, HolographyAttributeFromBin> asdm::HolographyRow::fromBinMethods

private

Definition at line 520 of file HolographyRow.h.

* text deserialization material std::map<std::string, HolographyAttributeFromText> asdm::HolographyRow::fromTextMethods

private

Definition at line 533 of file HolographyRow.h.

bool asdm::HolographyRow::hasBeenAdded

private

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

Definition at line 401 of file HolographyRow.h.

int asdm::HolographyRow::numCorr

private

===> Attribute numCorr

Definition at line 490 of file HolographyRow.h.

HolographyTable& asdm::HolographyRow::table

private

The table to which this row belongs.

Definition at line 397 of file HolographyRow.h.

std::vector<HolographyChannelTypeMod::HolographyChannelType > asdm::HolographyRow::type

private

===> Attribute type

Definition at line 501 of file HolographyRow.h.

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

casa/code/alma/ASDM/HolographyRow.h

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