The SubscanRow class is a row of a SubscanTable. More...

#include <SubscanRow.h>

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

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

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

void	setScanNumber (int scanNumber)
	Set scanNumber with the specified int. More...

int	getSubscanNumber () const
	===> Attribute subscanNumber More...

void	setSubscanNumber (int subscanNumber)
	Set subscanNumber with the specified int. More...

ArrayTime	getStartTime () const
	===> Attribute startTime More...

void	setStartTime (ArrayTime startTime)
	Set startTime with the specified ArrayTime. More...

ArrayTime	getEndTime () const
	===> Attribute endTime More...

void	setEndTime (ArrayTime endTime)
	Set endTime with the specified ArrayTime. More...

std::string	getFieldName () const
	===> Attribute fieldName More...

void	setFieldName (std::string fieldName)
	Set fieldName with the specified std::string. More...

SubscanIntentMod::SubscanIntent	getSubscanIntent () const
	===> Attribute subscanIntent More...

void	setSubscanIntent (SubscanIntentMod::SubscanIntent subscanIntent)
	Set subscanIntent with the specified SubscanIntentMod::SubscanIntent. More...

bool	isSubscanModeExists () const
	===> Attribute subscanMode, which is optional More...

SwitchingModeMod::SwitchingMode	getSubscanMode () const
	Get subscanMode, which is optional. More...

void	setSubscanMode (SwitchingModeMod::SwitchingMode subscanMode)
	Set subscanMode with the specified SwitchingModeMod::SwitchingMode. More...

void	clearSubscanMode ()
	Mark subscanMode, which is an optional field, as non-existent. More...

int	getNumIntegration () const
	===> Attribute numIntegration More...

void	setNumIntegration (int numIntegration)
	Set numIntegration with the specified int. More...

std::vector< int >	getNumSubintegration () const
	===> Attribute numSubintegration More...

void	setNumSubintegration (std::vector< int > numSubintegration)
	Set numSubintegration with the specified std::vector<int >. More...

bool	isCorrelatorCalibrationExists () const
	===> Attribute correlatorCalibration, which is optional More...

CorrelatorCalibrationMod::CorrelatorCalibration	getCorrelatorCalibration () const
	Get correlatorCalibration, which is optional. More...

void	setCorrelatorCalibration (CorrelatorCalibrationMod::CorrelatorCalibration correlatorCalibration)
	Set correlatorCalibration with the specified CorrelatorCalibrationMod::CorrelatorCalibration. More...

void	clearCorrelatorCalibration ()
	Mark correlatorCalibration, which is an optional field, as non-existent. More...

void	setExecBlockId (Tag execBlockId)
	Set execBlockId with the specified Tag. More...

Links ExecBlockRow	getExecBlockUsingExecBlockId ()
	execBlockId pointer to the row in the ExecBlock table having ExecBlock.execBlockId == execBlockId More...

bool	compareNoAutoInc (Tag execBlockId, int scanNumber, int subscanNumber, ArrayTime startTime, ArrayTime endTime, std::string fieldName, SubscanIntentMod::SubscanIntent subscanIntent, int numIntegration, std::vector< int > numSubintegration)
	Compare each mandatory attribute except the autoincrementable one of this SubscanRow with the corresponding parameters and return true if there is a match and false otherwise. More...

bool	compareRequiredValue (ArrayTime startTime, ArrayTime endTime, std::string fieldName, SubscanIntentMod::SubscanIntent subscanIntent, int numIntegration, std::vector< int > numSubintegration)
	Compare each mandatory value (i.e. More...

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

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

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

void	setFromIDL (asdmIDL::SubscanRowIDL x)
	Fill the values of this row from the IDL struct SubscanRowIDL. 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

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

	SubscanRow (SubscanTable &table)
	Create a SubscanRow. More...

	SubscanRow (SubscanTable &table, SubscanRow *row)
	Create a SubscanRow using a copy constructor mechanism. More...

void	execBlockIdFromBin (EndianIStream &eis)

void	scanNumberFromBin (EndianIStream &eis)

void	subscanNumberFromBin (EndianIStream &eis)

void	startTimeFromBin (EndianIStream &eis)

void	endTimeFromBin (EndianIStream &eis)

void	fieldNameFromBin (EndianIStream &eis)

void	subscanIntentFromBin (EndianIStream &eis)

void	numIntegrationFromBin (EndianIStream &eis)

void	numSubintegrationFromBin (EndianIStream &eis)

void	subscanModeFromBin (EndianIStream &eis)

void	correlatorCalibrationFromBin (EndianIStream &eis)

void	execBlockIdFromText (const std::string &s)

void	scanNumberFromText (const std::string &s)

void	subscanNumberFromText (const std::string &s)

void	startTimeFromText (const std::string &s)

void	endTimeFromText (const std::string &s)

void	fieldNameFromText (const std::string &s)

void	subscanIntentFromText (const std::string &s)

void	numIntegrationFromText (const std::string &s)

void	numSubintegrationFromText (const std::string &s)

void	subscanModeFromText (const std::string &s)

void	correlatorCalibrationFromText (const std::string &s)

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

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

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

int	subscanNumber
	===> Attribute subscanNumber More...

ArrayTime	startTime
	===> Attribute startTime More...

ArrayTime	endTime
	===> Attribute endTime More...

std::string	fieldName
	===> Attribute fieldName More...

SubscanIntentMod::SubscanIntent	subscanIntent
	===> Attribute subscanIntent More...

bool	subscanModeExists
	===> Attribute subscanMode, which is optional More...

SwitchingModeMod::SwitchingMode	subscanMode

int	numIntegration
	===> Attribute numIntegration More...

std::vector< int >	numSubintegration
	===> Attribute numSubintegration More...

bool	correlatorCalibrationExists
	===> Attribute correlatorCalibration, which is optional More...

CorrelatorCalibrationMod::CorrelatorCalibration	correlatorCalibration

Links *binary deserialization material from an EndianIStream std::map< std::string, SubscanAttributeFromBin >	fromBinMethods

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

Friends
class	asdm::SubscanTable

class	asdm::RowTransformer< SubscanRow >

Detailed Description

The SubscanRow class is a row of a SubscanTable.

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

Definition at line 119 of file SubscanRow.h.

Constructor & Destructor Documentation

virtual asdm::SubscanRow::~SubscanRow ( )

virtual

friend class asdm::TableStreamReader<SubscanTable, SubscanRow>;

asdm::SubscanRow::SubscanRow ( SubscanTable & table )

private

Create a SubscanRow.

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

private

Create a SubscanRow using a copy constructor mechanism.

Given a SubscanRow row and a SubscanTable table, the method creates a new SubscanRow 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::SubscanRow::clearCorrelatorCalibration ( )

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

void asdm::SubscanRow::clearSubscanMode ( )

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

bool asdm::SubscanRow::compareNoAutoInc	(	Tag	execBlockId,
		int	scanNumber,
		int	subscanNumber,
		ArrayTime	startTime,
		ArrayTime	endTime,
		std::string	fieldName,
		SubscanIntentMod::SubscanIntent	subscanIntent,
		int	numIntegration,
		std::vector< int >	numSubintegration
	)

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

Parameters

execBlockId
scanNumber
subscanNumber
startTime
endTime
fieldName
subscanIntent
numIntegration
numSubintegration

bool asdm::SubscanRow::compareRequiredValue	(	ArrayTime	startTime,
		ArrayTime	endTime,
		std::string	fieldName,
		SubscanIntentMod::SubscanIntent	subscanIntent,
		int	numIntegration,
		std::vector< int >	numSubintegration
	)

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

startTime
endTime
fieldName
subscanIntent
numIntegration
numSubintegration

void asdm::SubscanRow::correlatorCalibrationFromBin ( EndianIStream & eis )

private

void asdm::SubscanRow::correlatorCalibrationFromText ( const std::string & s )

private

void asdm::SubscanRow::endTimeFromBin ( EndianIStream & eis )

private

void asdm::SubscanRow::endTimeFromText ( const std::string & s )

private

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

Returns: a boolean.

void asdm::SubscanRow::execBlockIdFromBin ( EndianIStream & eis )

private

void asdm::SubscanRow::execBlockIdFromText ( const std::string & s )

private

void asdm::SubscanRow::fieldNameFromBin ( EndianIStream & eis )

private

void asdm::SubscanRow::fieldNameFromText ( const std::string & s )

private

CorrelatorCalibrationMod::CorrelatorCalibration asdm::SubscanRow::getCorrelatorCalibration ( ) const

Get correlatorCalibration, which is optional.

Returns: correlatorCalibration as CorrelatorCalibrationMod::CorrelatorCalibration

Exceptions

IllegalAccessException If correlatorCalibration does not exist.

ArrayTime asdm::SubscanRow::getEndTime ( ) const

===> Attribute endTime

Get endTime.

Returns: endTime as ArrayTime

Links* ExecBlockRow* asdm::SubscanRow::getExecBlockUsingExecBlockId ( )

execBlockId pointer to the row in the ExecBlock table having ExecBlock.execBlockId == execBlockId

Returns: a ExecBlockRow*

std::string asdm::SubscanRow::getFieldName ( ) const

===> Attribute fieldName

Get fieldName.

Returns: fieldName as std::string

int asdm::SubscanRow::getNumIntegration ( ) const

===> Attribute numIntegration

Get numIntegration.

Returns: numIntegration as int

std::vector<int > asdm::SubscanRow::getNumSubintegration ( ) const

===> Attribute numSubintegration

Get numSubintegration.

Returns: numSubintegration as std::vector<int >

ArrayTime asdm::SubscanRow::getStartTime ( ) const

===> Attribute startTime

Get startTime.

Returns: startTime as ArrayTime

SubscanIntentMod::SubscanIntent asdm::SubscanRow::getSubscanIntent ( ) const

===> Attribute subscanIntent

Get subscanIntent.

Returns: subscanIntent as SubscanIntentMod::SubscanIntent

SwitchingModeMod::SwitchingMode asdm::SubscanRow::getSubscanMode ( ) const

Get subscanMode, which is optional.

Returns: subscanMode as SwitchingModeMod::SwitchingMode

Exceptions

IllegalAccessException If subscanMode does not exist.

int asdm::SubscanRow::getSubscanNumber ( ) const

===> Attribute subscanNumber

Get subscanNumber.

Returns: subscanNumber as int

SubscanTable& asdm::SubscanRow::getTable ( ) const

Return the table to which this row belongs.

bool asdm::SubscanRow::isAdded ( ) const

Has this row been added to its table ?

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

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

private

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

bool asdm::SubscanRow::isCorrelatorCalibrationExists ( ) const

===> Attribute correlatorCalibration, which is optional

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

Returns: true if and only if the correlatorCalibration attribute exists.

bool asdm::SubscanRow::isSubscanModeExists ( ) const

===> Attribute subscanMode, which is optional

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

Returns: true if and only if the subscanMode attribute exists.

void asdm::SubscanRow::numIntegrationFromBin ( EndianIStream & eis )

private

void asdm::SubscanRow::numIntegrationFromText ( const std::string & s )

private

void asdm::SubscanRow::numSubintegrationFromBin ( EndianIStream & eis )

private

void asdm::SubscanRow::numSubintegrationFromText ( const std::string & s )

private

void asdm::SubscanRow::scanNumberFromBin ( EndianIStream & eis )

private

void asdm::SubscanRow::scanNumberFromText ( const std::string & s )

private

void asdm::SubscanRow::setCorrelatorCalibration ( CorrelatorCalibrationMod::CorrelatorCalibration correlatorCalibration )

Set correlatorCalibration with the specified CorrelatorCalibrationMod::CorrelatorCalibration.

Parameters

correlatorCalibration The CorrelatorCalibrationMod::CorrelatorCalibration value to which correlatorCalibration is to be set.

void asdm::SubscanRow::setEndTime ( ArrayTime endTime )

Set endTime with the specified ArrayTime.

Parameters

endTime The ArrayTime value to which endTime is to be set.

void asdm::SubscanRow::setExecBlockId ( Tag execBlockId )

Set execBlockId with the specified Tag.

Parameters

execBlockId The Tag value to which execBlockId 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::SubscanRow::setFieldName ( std::string fieldName )

Set fieldName with the specified std::string.

Parameters

fieldName The std::string value to which fieldName is to be set.

void asdm::SubscanRow::setFromIDL ( asdmIDL::SubscanRowIDL x )

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

Parameters

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

Exceptions

ConversionException

void asdm::SubscanRow::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::SubscanRow::setNumIntegration ( int numIntegration )

Set numIntegration with the specified int.

Parameters

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

void asdm::SubscanRow::setNumSubintegration ( std::vector< int > numSubintegration )

Set numSubintegration with the specified std::vector<int >.

Parameters

numSubintegration The std::vector<int > value to which numSubintegration is to be set.

void asdm::SubscanRow::setScanNumber ( int scanNumber )

Set scanNumber with the specified int.

Parameters

scanNumber The int value to which scanNumber 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::SubscanRow::setStartTime ( ArrayTime startTime )

Set startTime with the specified ArrayTime.

Parameters

startTime The ArrayTime value to which startTime is to be set.

void asdm::SubscanRow::setSubscanIntent ( SubscanIntentMod::SubscanIntent subscanIntent )

Set subscanIntent with the specified SubscanIntentMod::SubscanIntent.

Parameters

subscanIntent The SubscanIntentMod::SubscanIntent value to which subscanIntent is to be set.

void asdm::SubscanRow::setSubscanMode ( SwitchingModeMod::SwitchingMode subscanMode )

Set subscanMode with the specified SwitchingModeMod::SwitchingMode.

Parameters

subscanMode The SwitchingModeMod::SwitchingMode value to which subscanMode is to be set.

void asdm::SubscanRow::setSubscanNumber ( int subscanNumber )

Set subscanNumber with the specified int.

Parameters

subscanNumber The int value to which subscanNumber 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::SubscanRow::startTimeFromBin ( EndianIStream & eis )

private

void asdm::SubscanRow::startTimeFromText ( const std::string & s )

private

void asdm::SubscanRow::subscanIntentFromBin ( EndianIStream & eis )

private

void asdm::SubscanRow::subscanIntentFromText ( const std::string & s )

private

void asdm::SubscanRow::subscanModeFromBin ( EndianIStream & eis )

private

void asdm::SubscanRow::subscanModeFromText ( const std::string & s )

private

void asdm::SubscanRow::subscanNumberFromBin ( EndianIStream & eis )

private

void asdm::SubscanRow::subscanNumberFromText ( const std::string & s )

private

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

private

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

Parameters

eoss	the EndianOSStream to be written to

asdmIDL::SubscanRowIDL* asdm::SubscanRow::toIDL ( ) const

Return this row in the form of an IDL struct.

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

void asdm::SubscanRow::toIDL ( asdmIDL::SubscanRowIDL & x ) const

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

Parameters

x	a reference to the SubscanRowIDL struct to be set.

std::string asdm::SubscanRow::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::RowTransformer< SubscanRow >

friend

Definition at line 121 of file SubscanRow.h.

friend class asdm::SubscanTable

friend

Definition at line 120 of file SubscanRow.h.

Member Data Documentation

Extrinsic Table asdm::SubscanRow::Attributes

Definition at line 144 of file SubscanRow.h.

Extrinsic Table asdm::SubscanRow::Attributes

Definition at line 474 of file SubscanRow.h.

CorrelatorCalibrationMod::CorrelatorCalibration asdm::SubscanRow::correlatorCalibration

private

Definition at line 818 of file SubscanRow.h.

bool asdm::SubscanRow::correlatorCalibrationExists

private

===> Attribute correlatorCalibration, which is optional

Definition at line 815 of file SubscanRow.h.

ArrayTime asdm::SubscanRow::endTime

private

===> Attribute endTime

Definition at line 748 of file SubscanRow.h.

std::string asdm::SubscanRow::fieldName

private

===> Attribute fieldName

Definition at line 759 of file SubscanRow.h.

Links* binary deserialization material from an EndianIStream std::map<std::string, SubscanAttributeFromBin> asdm::SubscanRow::fromBinMethods

private

Definition at line 855 of file SubscanRow.h.

* text deserialization material std::map<std::string, SubscanAttributeFromText> asdm::SubscanRow::fromTextMethods

private

Definition at line 874 of file SubscanRow.h.

bool asdm::SubscanRow::hasBeenAdded

private

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

Definition at line 671 of file SubscanRow.h.

int asdm::SubscanRow::numIntegration

private

===> Attribute numIntegration

Definition at line 794 of file SubscanRow.h.

std::vector<int > asdm::SubscanRow::numSubintegration

private

===> Attribute numSubintegration

Definition at line 805 of file SubscanRow.h.

ArrayTime asdm::SubscanRow::startTime

private

===> Attribute startTime

Definition at line 737 of file SubscanRow.h.

SubscanIntentMod::SubscanIntent asdm::SubscanRow::subscanIntent

private

===> Attribute subscanIntent

Definition at line 770 of file SubscanRow.h.

SwitchingModeMod::SwitchingMode asdm::SubscanRow::subscanMode

private

Definition at line 783 of file SubscanRow.h.

bool asdm::SubscanRow::subscanModeExists

private

===> Attribute subscanMode, which is optional

Definition at line 780 of file SubscanRow.h.

int asdm::SubscanRow::subscanNumber

private

===> Attribute subscanNumber

Definition at line 726 of file SubscanRow.h.

SubscanTable& asdm::SubscanRow::table

private

The table to which this row belongs.

Definition at line 667 of file SubscanRow.h.

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

casa/code/alma/ASDM/SubscanRow.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