asdm::SwitchCycleRow Class Reference

#include <SwitchCycleRow.h>

List of all members.

---

Detailed Description

The SwitchCycleRow class is a row of a SwitchCycleTable.

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

Public Member Functions
SwitchCycleTable &	getTable () const
SwitchCycleRowIDL *	toIDL () const
void	setFromIDL (SwitchCycleRowIDL x) throw (ConversionException)
string	toXML () const
void	setFromXML (string rowDoc) throw (ConversionException)
Tag	getSwitchCycleId () const
int	getNumStep () const
void	setNumStep (int numStep)
vector< float >	getWeightArray () const
void	setWeightArray (vector< float > weightArray)
vector< vector< Angle > >	getDirOffsetArray () const
void	setDirOffsetArray (vector< vector< Angle > > dirOffsetArray)
vector< Frequency >	getFreqOffsetArray () const
void	setFreqOffsetArray (vector< Frequency > freqOffsetArray)
vector< Interval >	getStepDurationArray () const
void	setStepDurationArray (vector< Interval > stepDurationArray)
bool	compareNoAutoInc (int numStep, vector< float > weightArray, vector< vector< Angle > > dirOffsetArray, vector< Frequency > freqOffsetArray, vector< Interval > stepDurationArray)
bool	compareRequiredValue (int numStep, vector< float > weightArray, vector< vector< Angle > > dirOffsetArray, vector< Frequency > freqOffsetArray, vector< Interval > stepDurationArray)
bool	equalByRequiredValue (SwitchCycleRow *x)
Friends
class	asdm::SwitchCycleTable

---

Member Function Documentation

SwitchCycleTable& asdm::SwitchCycleRow::getTable

(

)

const

Return the table to which this row belongs.

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::setFromIDL

(

SwitchCycleRowIDL

x

)

throw (ConversionException)

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

Parameters:

x

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

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::setFromXML

(

string

rowDoc

)

throw (ConversionException)

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

Parameters:

x

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

Tag asdm::SwitchCycleRow::getSwitchCycleId

(

)

const

Get switchCycleId.

Returns:

switchCycleId as Tag

int asdm::SwitchCycleRow::getNumStep

(

)

const

Get numStep.

Returns:

numStep as int

void asdm::SwitchCycleRow::setNumStep

(

int

numStep

)

Set numStep with the specified int.

Parameters:

numStep

The int value to which numStep is to be set.

vector<float > asdm::SwitchCycleRow::getWeightArray

(

)

const

Get weightArray.

Returns:

weightArray as vector<float >

void asdm::SwitchCycleRow::setWeightArray

(

vector< float >

weightArray

)

Set weightArray with the specified vector<float >.

Parameters:

weightArray

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

vector<vector<Angle > > asdm::SwitchCycleRow::getDirOffsetArray

(

)

const

Get dirOffsetArray.

Returns:

dirOffsetArray as vector<vector<Angle > >

void asdm::SwitchCycleRow::setDirOffsetArray

(

vector< vector< Angle > >

dirOffsetArray

)

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

Parameters:

dirOffsetArray

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

vector<Frequency > asdm::SwitchCycleRow::getFreqOffsetArray

(

)

const

Get freqOffsetArray.

Returns:

freqOffsetArray as vector<Frequency >

void asdm::SwitchCycleRow::setFreqOffsetArray

(

vector< Frequency >

freqOffsetArray

)

Set freqOffsetArray with the specified vector<Frequency >.

Parameters:

freqOffsetArray

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

vector<Interval > asdm::SwitchCycleRow::getStepDurationArray

(

)

const

Get stepDurationArray.

Returns:

stepDurationArray as vector<Interval >

void asdm::SwitchCycleRow::setStepDurationArray

(

vector< Interval >

stepDurationArray

)

Set stepDurationArray with the specified vector<Interval >.

Parameters:

stepDurationArray

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

bool asdm::SwitchCycleRow::compareNoAutoInc	(	int	numStep,
		vector< float >	weightArray,
		vector< vector< Angle > >	dirOffsetArray,
		vector< Frequency >	freqOffsetArray,
		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.

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.

---

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

• SwitchCycleRow.h

---