cLoopStructure Class Reference

The cLoopStructure class. More...

Inherits QObject.

Public Slots
void	setLoopID (const int &nValue)
	setLoopID slot. More...

Public Member Functions
int	getLoopCounter () const
	getLoopCounter slot. More...
int	getLoopID () const
	getLoopID slot. More...
QString	getLoopName () const
	getLoopName slot. More...
int	getLoopNumber () const
	getLoopNumber slot. More...
int	getNumberOfLoops () const
	getNumberOfLoops slot. More...
int	getTargetBlockID () const
	getTargetBlockID slot. More...
void	setLoopName (const QString &sValue)
	setLoopName slot. More...
void	setLoopNumber (const int &nValue)
	setLoopNumber slot. More...
void	setNumberOfLoops (const int &nValue)
	setNumberOfLoops slot. More...
void	setTargetBlockID (const int &nValue)
	setTargetBlockID slot. More...

Properties
int	LoopCounter
	LoopCounter property. More...
int	LoopID
	LoopID property. More...
QString	LoopName
	LoopName property. More...
int	LoopNumber
	LoopNumber property. More...
int	NumberOfLoops
	NumberOfLoops property. More...
int	TargetBlockID
	TargetBlockID property. More...

Detailed Description

The cLoopStructure class.

The cLoopStructure class is a container to store a Loop structure from a block structure, see cBlockStructure.

Member Function Documentation

int cLoopStructure::getLoopCounter ( ) const

inline

getLoopCounter slot.

This function returns the loop counter value for the current loop.

Returns

a integer value containing the loop counter value for the current loop.

int cLoopStructure::getLoopID ( ) const

inline

getLoopID slot.

This function returns the loop ID.

Returns

a integer value containing the requested loop ID.

QString cLoopStructure::getLoopName ( ) const

inline

getLoopName slot.

This function returns the loop name.

Returns

a string value containing the requested loop name.

int cLoopStructure::getLoopNumber ( ) const

inline

getLoopNumber slot.

This function returns the loop number.

Returns

a integer value containing the requested loop number.

int cLoopStructure::getNumberOfLoops ( ) const

inline

getNumberOfLoops slot.

This function returns the number of defined loops.

Returns

a integer value containing number of defined loops.

int cLoopStructure::getTargetBlockID ( ) const

inline

getTargetBlockID slot.

This function returns the current loop target block ID.

Returns

a integer value containing the current loop target block ID.

void cLoopStructure::setLoopID ( const int &  nValue )

inlineslot

setLoopID slot.

This function sets the loop ID to the new provided value.

Parameters

nValue

a integer value (>0) holding the new loop ID.

void cLoopStructure::setLoopName ( const QString &  sValue )

inline

setLoopName slot.

This function sets the loop name to the new provided value.

Parameters

sValue

a string value holding the new loop name.

void cLoopStructure::setLoopNumber ( const int &  nValue )

inline

setLoopNumber slot.

This function sets the loop number to the new provided value.

Parameters

nValue

a integer value (>0) holding the new loop number.

void cLoopStructure::setNumberOfLoops ( const int &  nValue )

inline

setNumberOfLoops slot.

This function set the number of loops to the new provided value.

Parameters

nValue

a integer value holding the number of loops.

void cLoopStructure::setTargetBlockID ( const int &  nValue )

inline

setTargetBlockID slot.

This function sets the target block ID for the current loop to the new provided value.

Parameters

nValue

a integer value (>0) holding the new target block ID.

Property Documentation

int cLoopStructure::LoopCounter

read

LoopCounter property.

Use this property to set or retrieve the LoopCounter.

int cLoopStructure::LoopID

readwrite

LoopID property.

Use this property to set or retrieve the LoopID.

QString cLoopStructure::LoopName

readwrite

LoopName property.

Use this property to set or retrieve the LoopName.

int cLoopStructure::LoopNumber

readwrite

LoopNumber property.

Use this property to set or retrieve the LoopNumber.

int cLoopStructure::NumberOfLoops

readwrite

NumberOfLoops property.

Use this property to set or retrieve the NumberOfLoops.

int cLoopStructure::TargetBlockID

readwrite

TargetBlockID property.

Use this property to set or retrieve the TargetBlockID.