The cBlockStructure class. More...

Inherits QObject.

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

Public Member Functions
cLoopStructure *	createLoop ()
	createLoop slot. More...

int	getBlockID () const
	getBlockID slot. More...

QString	getBlockName () const
	getBlockName slot. More...

int	getBlockNumber () const
	getBlockNumber slot. More...

int	getLoopCount () const
	getLoopCount slot. More...

cLoopStructure *	getLoopPointerByID (const int &nLoopID)
	slot. More...

cLoopStructure *	getNextClosestLoopIDByFromID (const int &startLoopID)
	getNextClosestLoopIDByFromID slot. More...

cLoopStructure *	getNextClosestLoopIDByFromLoopNumber (const int &startLoopNumber)
	getNextClosestLoopIDByFromLoopNumber slot. More...

int	getNumberOfExternalTriggers () const
	getNumberOfExternalTriggers slot. More...

int	getNumberOfInternalTriggers () const
	getNumberOfInternalTriggers slot. More...

int	getNumberOfTrials () const
	getNumberOfTrials slot. More...

cLoopStructure *	incrementToNextLoopPointer (cLoopStructure *pCurrentLoop=NULL)
	incrementToNextLoopPointer slot. More...

bool	insertLoop (cLoopStructure *cLoop)
	insertLoop slot. More...

bool	insertObjectParameter (int nObjectID, cBlockParameterStructure *cBlockParameter, bool bIsCustom=false)
	insertObjectParameter slot. More...

void	resetAllInnerLoopCounters (const int &nCurrentLoopCounter)
	resetAllInnerLoopCounters slot. More...

void	resetAllLoopCounters ()
	resetAllLoopCounters slot. More...

cLoopStructure *	resetToFirstFreeLoopPointer ()
	resetToFirstFreeLoopPointer slot. More...

void	setBlockName (const QString &sValue)
	setBlockName slot. More...

void	setBlockNumber (const int &nValue)
	setBlockNumber slot. More...

void	setNumberOfExternalTriggers (const int &nValue)
	setNumberOfExternalTriggers slot. More...

void	setNumberOfInternalTriggers (const int &nValue)
	setNumberOfInternalTriggers slot. More...

void	setNumberOfTrials (const int &nValue)
	setNumberOfTrials slot. More...

Properties
int	BlockID
	BlockID property. More...

QString	BlockName
	BlockName property. More...

int	BlockNumber
	BlockNumber property. More...

int	NumberOfExternalTriggers
	NumberOfExternalTriggers property. More...

int	NumberOfInternalTriggers
	NumberOfInternalTriggers property. More...

int	NumberOfTrials
	NumberOfTrials property. More...

Detailed Description

The cBlockStructure class.

The cBlockStructure class is a container to store a Block structure from a experiment structure, see cExperimentStructure.

Member Function Documentation

cLoopStructure* cBlockStructure::createLoop ( )

createLoop slot.

This function constructs a new cLoopStructure structure object and inserts it in the current Experiment Structure Block.

Returns: a pointer to a cLoopStructure of the inserted object, if unsuccessful then it returns null.

int cBlockStructure::getBlockID ( ) const

inline

getBlockID slot.

This function returns the block ID.

Returns: a integer containing the block ID.

QString cBlockStructure::getBlockName ( ) const

inline

getBlockName slot.

This function returns the block name.

Returns: a string containing the block name.

int cBlockStructure::getBlockNumber ( ) const

inline

getBlockNumber slot.

This function returns the block number.

Returns: a integer containing the block number.

int cBlockStructure::getLoopCount ( ) const

inline

getLoopCount slot.

This function return the amount of defined cLoopStructure structures in the block.

Returns: a integer value holding the amount of defined cLoopStructure structures.

cLoopStructure* cBlockStructure::getLoopPointerByID ( const int & nLoopID )

slot.

This function returns a pointer to a cLoopStructure specified by the provided loop ID.

Parameters

nLoopID a integer value holding the value for the specified loop ID.

Returns: a pointer to the cLoopStructure structure specified by the provided loop ID, if it's unavailable then NULL is returned.

cLoopStructure* cBlockStructure::getNextClosestLoopIDByFromID ( const int & startLoopID )

getNextClosestLoopIDByFromID slot.

This function returns a pointer to the next first cLoopStructureloop where the loop ID value is bigger then the provided loop ID.

Parameters

startLoopID a integer value determining the value for the requested cLoopStructureloop where the loop ID value is bigger then this value.

Returns: a pointer to the next first cLoopStructure structure, if no cLoopStructure is available then this function returns NULL.

cLoopStructure* cBlockStructure::getNextClosestLoopIDByFromLoopNumber ( const int & startLoopNumber )

getNextClosestLoopIDByFromLoopNumber slot.

This function returns a pointer to the next first cLoopStructureloop where the Loop Number value is bigger or the same as the provided Loop Number.

Parameters

startLoopNumber a integer value determining the value for the requested cLoopStructureloop where the Loop Number value is bigger or the same as this value.

Returns: a pointer to the next first cLoopStructure structure, if no cLoopStructure is available then this function returns NULL.

int cBlockStructure::getNumberOfExternalTriggers ( ) const

inline

getNumberOfExternalTriggers slot.

This function returns the number of external triggers for the block.

Returns: a integer value containing the number of external triggers from the block.

int cBlockStructure::getNumberOfInternalTriggers ( ) const

inline

getNumberOfInternalTriggers slot.

This function returns the number of internal triggers for the block.

Returns: a integer value containing the number of internal triggers from the block.

int cBlockStructure::getNumberOfTrials ( ) const

inline

getNumberOfTrials slot.

This function returns the number of trials for the block.

Returns: a integer value containing the number of trials from the block.

cLoopStructure* cBlockStructure::incrementToNextLoopPointer ( cLoopStructure * pCurrentLoop = NULL )

incrementToNextLoopPointer slot.

This function increments and returns the provided cLoopStructure pointer to the next available cLoopStructure pointer. If the provided cLoopStructure is NULL, then the internal cLoopStructure is reset and returns the first available cLoopStructure for this block. If there's no next available cLoopStructure the this function returns NULL.

Parameters

pCurrentLoop a pointer to a cLoopStructure that should be incremented.

Returns: a pointer to a cLoopStructure or a NULL value.

bool cBlockStructure::insertLoop ( cLoopStructure * cLoop )

insertLoop slot.

This function inserts a new cLoopStructure in the block.

Parameters

cLoop a pointer to a cLoopStructure that should be inserted.

Returns: a boolean value determining whether the new cLoopStructure structure could be inserted.

bool cBlockStructure::insertObjectParameter	(	int	nObjectID,
		cBlockParameterStructure *	cBlockParameter,
		bool	bIsCustom = `false`
	)

insertObjectParameter slot.

This function inserts a new cBlockParameterStructure in the block for a specified object by referring to it's object id.

Parameters

nObjectID	a integer value holding the Object ID for the cBlockParameterStructure that should be inserted.
cBlockParameter	a pointer to a cBlockParameterStructure that should be inserted.
bIsCustom	a boolean value determining whether the parameter is a custom parameter (default=false).

Returns: a boolean value determining whether the new cBlockParameterStructure structure could be inserted.

void cBlockStructure::resetAllInnerLoopCounters ( const int & nCurrentLoopCounter )

resetAllInnerLoopCounters slot.

This function resets all cLoopStructure structures from the block which have loop number(s) smaller than the provided loop number.

Parameters

nCurrentLoopCounter a integer value that holds the first outer loop number that should not be reset by this function.

void cBlockStructure::resetAllLoopCounters ( )

resetAllLoopCounters slot.

This function resets all cLoopStructure structures from the block.

cLoopStructure* cBlockStructure::resetToFirstFreeLoopPointer ( )

resetToFirstFreeLoopPointer slot.

This function resets the provided cLoopStructure to the first free (unprocessed) cLoopStructure and return a pointer to this.

Returns: a pointer to a cLoopStructure, if there's no available free cLoopStructure the NULL is returned.

void cBlockStructure::setBlockID ( const int & nValue )

inlineslot

setBlockID slot.

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

Parameters

nValue a integer value (>0) containing the new block ID.

void cBlockStructure::setBlockName ( const QString & sValue )

inline

setBlockName slot.

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

Parameters

sValue a string value containing the new block name.

void cBlockStructure::setBlockNumber ( const int & nValue )

inline

setBlockNumber slot.

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

Parameters

nValue a integer value (>0) containing the new block number.

void cBlockStructure::setNumberOfExternalTriggers ( const int & nValue )

inline

setNumberOfExternalTriggers slot.

This function sets the number of external triggers for the block to the new provided value.

Parameters

nValue a integer value containing the new number of external triggers.

void cBlockStructure::setNumberOfInternalTriggers ( const int & nValue )

inline

setNumberOfInternalTriggers slot.

This function sets the number of internal triggers for the block to the new provided value.

Parameters

nValue a integer value containing the new number of internal triggers.

void cBlockStructure::setNumberOfTrials ( const int & nValue )

inline

setNumberOfTrials slot.

This function sets the number of trials for the block to the new provided value.

Parameters

nValue a integer value containing the new number of trials.

Property Documentation

int cBlockStructure::BlockID

readwrite

BlockID property.

Use this property to set or retrieve the BlockID.

QString cBlockStructure::BlockName

readwrite

BlockName property.

Use this property to set or retrieve the BlockName.

int cBlockStructure::BlockNumber

readwrite

BlockNumber property.

Use this property to set or retrieve the BlockNumber.

int cBlockStructure::NumberOfExternalTriggers

readwrite

NumberOfExternalTriggers property.

Use this property to set or retrieve the NumberOfExternalTriggers.

int cBlockStructure::NumberOfInternalTriggers

readwrite

NumberOfInternalTriggers property.

Use this property to set or retrieve the NumberOfInternalTriggers.

int cBlockStructure::NumberOfTrials

readwrite

NumberOfTrials property.

Use this property to set or retrieve the NumberOfTrials.

Public Slots

Public Member Functions

Properties

Detailed Description

Member Function Documentation

Property Documentation