The SwitchCycleRow class is a row of a SwitchCycleTable. More...

#include <SwitchCycleRow.h>

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

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

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

int	getNumStep () const
	===> Attribute numStep More...

void	setNumStep (int numStep)
	Set numStep with the specified int. More...

std::vector< float >	getWeightArray () const
	===> Attribute weightArray More...

void	setWeightArray (std::vector< float > weightArray)
	Set weightArray with the specified std::vector<float >. More...

std::vector< std::vector< Angle > >	getDirOffsetArray () const
	===> Attribute dirOffsetArray More...

void	setDirOffsetArray (std::vector< std::vector< Angle > > dirOffsetArray)
	Set dirOffsetArray with the specified std::vector<std::vector<Angle > >. More...

std::vector< Frequency >	getFreqOffsetArray () const
	===> Attribute freqOffsetArray More...

void	setFreqOffsetArray (std::vector< Frequency > freqOffsetArray)
	Set freqOffsetArray with the specified std::vector<Frequency >. More...

std::vector< Interval >	getStepDurationArray () const
	===> Attribute stepDurationArray More...

void	setStepDurationArray (std::vector< Interval > stepDurationArray)
	Set stepDurationArray with the specified std::vector<Interval >. More...

bool	isDirectionCodeExists () const
	===> Attribute directionCode, which is optional More...

DirectionReferenceCodeMod::DirectionReferenceCode	getDirectionCode () const
	Get directionCode, which is optional. More...

void	setDirectionCode (DirectionReferenceCodeMod::DirectionReferenceCode directionCode)
	Set directionCode with the specified DirectionReferenceCodeMod::DirectionReferenceCode. More...

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

bool	isDirectionEquinoxExists () const
	===> Attribute directionEquinox, which is optional More...

ArrayTime	getDirectionEquinox () const
	Get directionEquinox, which is optional. More...

void	setDirectionEquinox (ArrayTime directionEquinox)
	Set directionEquinox with the specified ArrayTime. More...

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

Extrinsic Table Attributes Links *bool	compareNoAutoInc (int numStep, std::vector< float > weightArray, std::vector< std::vector< Angle > > dirOffsetArray, std::vector< Frequency > freqOffsetArray, std::vector< Interval > stepDurationArray)
	Compare each mandatory attribute except the autoincrementable one of this SwitchCycleRow with the corresponding parameters and return true if there is a match and false otherwise. More...

bool	compareRequiredValue (int numStep, std::vector< float > weightArray, std::vector< std::vector< Angle > > dirOffsetArray, std::vector< Frequency > freqOffsetArray, std::vector< Interval > stepDurationArray)
	Compare each mandatory value (i.e. More...

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

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

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

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

	SwitchCycleRow (SwitchCycleTable &table)
	Create a SwitchCycleRow. More...

	SwitchCycleRow (SwitchCycleTable &table, SwitchCycleRow *row)
	Create a SwitchCycleRow using a copy constructor mechanism. More...

void	setSwitchCycleId (Tag switchCycleId)
	Set switchCycleId with the specified Tag value. More...

void	switchCycleIdFromBin (EndianIStream &eis)

void	numStepFromBin (EndianIStream &eis)

void	weightArrayFromBin (EndianIStream &eis)

void	dirOffsetArrayFromBin (EndianIStream &eis)

void	freqOffsetArrayFromBin (EndianIStream &eis)

void	stepDurationArrayFromBin (EndianIStream &eis)

void	directionCodeFromBin (EndianIStream &eis)

void	directionEquinoxFromBin (EndianIStream &eis)

void	switchCycleIdFromText (const std::string &s)

void	numStepFromText (const std::string &s)

void	weightArrayFromText (const std::string &s)

void	dirOffsetArrayFromText (const std::string &s)

void	freqOffsetArrayFromText (const std::string &s)

void	stepDurationArrayFromText (const std::string &s)

void	directionCodeFromText (const std::string &s)

void	directionEquinoxFromText (const std::string &s)

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

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

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

int	numStep
	===> Attribute numStep More...

std::vector< float >	weightArray
	===> Attribute weightArray More...

std::vector< std::vector< Angle > >	dirOffsetArray
	===> Attribute dirOffsetArray More...

std::vector< Frequency >	freqOffsetArray
	===> Attribute freqOffsetArray More...

std::vector< Interval >	stepDurationArray
	===> Attribute stepDurationArray More...

bool	directionCodeExists
	===> Attribute directionCode, which is optional More...

DirectionReferenceCodeMod::DirectionReferenceCode	directionCode

bool	directionEquinoxExists
	===> Attribute directionEquinox, which is optional More...

ArrayTime	directionEquinox

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

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

Friends
class	asdm::SwitchCycleTable

class	asdm::RowTransformer< SwitchCycleRow >

Detailed Description

The SwitchCycleRow class is a row of a SwitchCycleTable.

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

Definition at line 120 of file SwitchCycleRow.h.

Constructor & Destructor Documentation

virtual asdm::SwitchCycleRow::~SwitchCycleRow ( )

virtual

friend class asdm::TableStreamReader<SwitchCycleTable, SwitchCycleRow>;

asdm::SwitchCycleRow::SwitchCycleRow ( SwitchCycleTable & table )

private

Create a SwitchCycleRow.

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

private

Create a SwitchCycleRow using a copy constructor mechanism.

Given a SwitchCycleRow row and a SwitchCycleTable table, the method creates a new SwitchCycleRow 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::SwitchCycleRow::clearDirectionCode ( )

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

void asdm::SwitchCycleRow::clearDirectionEquinox ( )

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

Extrinsic Table Attributes Links* bool asdm::SwitchCycleRow::compareNoAutoInc	(	int	numStep,
		std::vector< float >	weightArray,
		std::vector< std::vector< Angle > >	dirOffsetArray,
		std::vector< Frequency >	freqOffsetArray,
		std::vector< Interval >	stepDurationArray
	)

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

Parameters

numStep
weightArray
dirOffsetArray
freqOffsetArray
stepDurationArray

bool asdm::SwitchCycleRow::compareRequiredValue	(	int	numStep,
		std::vector< float >	weightArray,
		std::vector< std::vector< Angle > >	dirOffsetArray,
		std::vector< Frequency >	freqOffsetArray,
		std::vector< Interval >	stepDurationArray
	)

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

numStep
weightArray
dirOffsetArray
freqOffsetArray
stepDurationArray

void asdm::SwitchCycleRow::directionCodeFromBin ( EndianIStream & eis )

private

void asdm::SwitchCycleRow::directionCodeFromText ( const std::string & s )

private

void asdm::SwitchCycleRow::directionEquinoxFromBin ( EndianIStream & eis )

private

void asdm::SwitchCycleRow::directionEquinoxFromText ( const std::string & s )

private

void asdm::SwitchCycleRow::dirOffsetArrayFromBin ( EndianIStream & eis )

private

void asdm::SwitchCycleRow::dirOffsetArrayFromText ( const std::string & s )

private

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

Returns: a boolean.

void asdm::SwitchCycleRow::freqOffsetArrayFromBin ( EndianIStream & eis )

private

void asdm::SwitchCycleRow::freqOffsetArrayFromText ( const std::string & s )

private

DirectionReferenceCodeMod::DirectionReferenceCode asdm::SwitchCycleRow::getDirectionCode ( ) const

Get directionCode, which is optional.

Returns: directionCode as DirectionReferenceCodeMod::DirectionReferenceCode

Exceptions

IllegalAccessException If directionCode does not exist.

ArrayTime asdm::SwitchCycleRow::getDirectionEquinox ( ) const

Get directionEquinox, which is optional.

Returns: directionEquinox as ArrayTime

Exceptions

IllegalAccessException If directionEquinox does not exist.

std::vector<std::vector<Angle > > asdm::SwitchCycleRow::getDirOffsetArray ( ) const

===> Attribute dirOffsetArray

Get dirOffsetArray.

Returns: dirOffsetArray as std::vector<std::vector<Angle > >

std::vector<Frequency > asdm::SwitchCycleRow::getFreqOffsetArray ( ) const

===> Attribute freqOffsetArray

Get freqOffsetArray.

Returns: freqOffsetArray as std::vector<Frequency >

int asdm::SwitchCycleRow::getNumStep ( ) const

===> Attribute numStep

Get numStep.

Returns: numStep as int

std::vector<Interval > asdm::SwitchCycleRow::getStepDurationArray ( ) const

===> Attribute stepDurationArray

Get stepDurationArray.

Returns: stepDurationArray as std::vector<Interval >

SwitchCycleTable& asdm::SwitchCycleRow::getTable ( ) const

Return the table to which this row belongs.

std::vector<float > asdm::SwitchCycleRow::getWeightArray ( ) const

===> Attribute weightArray

Get weightArray.

Returns: weightArray as std::vector<float >

bool asdm::SwitchCycleRow::isAdded ( ) const

Has this row been added to its table ?

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

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

private

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

bool asdm::SwitchCycleRow::isDirectionCodeExists ( ) const

===> Attribute directionCode, which is optional

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

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

bool asdm::SwitchCycleRow::isDirectionEquinoxExists ( ) const

===> Attribute directionEquinox, which is optional

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

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

void asdm::SwitchCycleRow::numStepFromBin ( EndianIStream & eis )

private

void asdm::SwitchCycleRow::numStepFromText ( const std::string & s )

private

void asdm::SwitchCycleRow::setDirectionCode ( DirectionReferenceCodeMod::DirectionReferenceCode directionCode )

Set directionCode with the specified DirectionReferenceCodeMod::DirectionReferenceCode.

Parameters

directionCode The DirectionReferenceCodeMod::DirectionReferenceCode value to which directionCode is to be set.

void asdm::SwitchCycleRow::setDirectionEquinox ( ArrayTime directionEquinox )

Set directionEquinox with the specified ArrayTime.

Parameters

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

void asdm::SwitchCycleRow::setDirOffsetArray ( std::vector< std::vector< Angle > > dirOffsetArray )

Set dirOffsetArray with the specified std::vector<std::vector<Angle > >.

Parameters

dirOffsetArray The std::vector<std::vector<Angle > > value to which dirOffsetArray is to be set.

void asdm::SwitchCycleRow::setFreqOffsetArray ( std::vector< Frequency > freqOffsetArray )

Set freqOffsetArray with the specified std::vector<Frequency >.

Parameters

freqOffsetArray The std::vector<Frequency > value to which freqOffsetArray is to be set.

void asdm::SwitchCycleRow::setFromIDL ( asdmIDL::SwitchCycleRowIDL x )

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

Parameters

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

Exceptions

ConversionException

void asdm::SwitchCycleRow::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::SwitchCycleRow::setNumStep ( int numStep )

Set numStep with the specified int.

Parameters

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

void asdm::SwitchCycleRow::setStepDurationArray ( std::vector< Interval > stepDurationArray )

Set stepDurationArray with the specified std::vector<Interval >.

Parameters

stepDurationArray The std::vector<Interval > value to which stepDurationArray is to be set.

void asdm::SwitchCycleRow::setSwitchCycleId ( Tag switchCycleId )

private

Set switchCycleId with the specified Tag value.

Parameters

switchCycleId The Tag value to which switchCycleId 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::SwitchCycleRow::setWeightArray ( std::vector< float > weightArray )

Set weightArray with the specified std::vector<float >.

Parameters

weightArray The std::vector<float > value to which weightArray is to be set.

void asdm::SwitchCycleRow::stepDurationArrayFromBin ( EndianIStream & eis )

private

void asdm::SwitchCycleRow::stepDurationArrayFromText ( const std::string & s )

private

void asdm::SwitchCycleRow::switchCycleIdFromBin ( EndianIStream & eis )

private

void asdm::SwitchCycleRow::switchCycleIdFromText ( const std::string & s )

private

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

private

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

Parameters

eoss	the EndianOSStream to be written to

asdmIDL::SwitchCycleRowIDL* asdm::SwitchCycleRow::toIDL ( ) const

Return this row in the form of an IDL struct.

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

void asdm::SwitchCycleRow::toIDL ( asdmIDL::SwitchCycleRowIDL & x ) const

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

Parameters

x	a reference to the SwitchCycleRowIDL struct to be set.

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

Return this row in the form of an XML string.

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

void asdm::SwitchCycleRow::weightArrayFromBin ( EndianIStream & eis )

private

void asdm::SwitchCycleRow::weightArrayFromText ( const std::string & s )

private

Friends And Related Function Documentation

friend class asdm::RowTransformer< SwitchCycleRow >

friend

Definition at line 122 of file SwitchCycleRow.h.

friend class asdm::SwitchCycleTable

friend

Definition at line 121 of file SwitchCycleRow.h.

Member Data Documentation

Intrinsic Table asdm::SwitchCycleRow::Attributes

Definition at line 145 of file SwitchCycleRow.h.

DirectionReferenceCodeMod::DirectionReferenceCode asdm::SwitchCycleRow::directionCode

private

Definition at line 662 of file SwitchCycleRow.h.

bool asdm::SwitchCycleRow::directionCodeExists

private

===> Attribute directionCode, which is optional

Definition at line 659 of file SwitchCycleRow.h.

ArrayTime asdm::SwitchCycleRow::directionEquinox

private

Definition at line 675 of file SwitchCycleRow.h.

bool asdm::SwitchCycleRow::directionEquinoxExists

private

===> Attribute directionEquinox, which is optional

Definition at line 672 of file SwitchCycleRow.h.

std::vector<std::vector<Angle > > asdm::SwitchCycleRow::dirOffsetArray

private

===> Attribute dirOffsetArray

Definition at line 627 of file SwitchCycleRow.h.

std::vector<Frequency > asdm::SwitchCycleRow::freqOffsetArray

private

===> Attribute freqOffsetArray

Definition at line 638 of file SwitchCycleRow.h.

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

private

Definition at line 694 of file SwitchCycleRow.h.

* text deserialization material std::map<std::string, SwitchCycleAttributeFromText> asdm::SwitchCycleRow::fromTextMethods

private

Definition at line 710 of file SwitchCycleRow.h.

bool asdm::SwitchCycleRow::hasBeenAdded

private

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

Definition at line 538 of file SwitchCycleRow.h.

int asdm::SwitchCycleRow::numStep

private

===> Attribute numStep

Definition at line 605 of file SwitchCycleRow.h.

std::vector<Interval > asdm::SwitchCycleRow::stepDurationArray

private

===> Attribute stepDurationArray

Definition at line 649 of file SwitchCycleRow.h.

SwitchCycleTable& asdm::SwitchCycleRow::table

private

The table to which this row belongs.

Definition at line 534 of file SwitchCycleRow.h.

std::vector<float > asdm::SwitchCycleRow::weightArray

private

===> Attribute weightArray

Definition at line 616 of file SwitchCycleRow.h.

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

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