cBlockParameterStructure Class Reference

The cBlockParameterStructure class. More...

Inherits QObject.

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

Public Member Functions
int	getBlockParameterID () const
	getBlockParameterID slot. More...
bool	getBlockParameterIsCustom () const
	getBlockParameterIsCustom slot. More...
QString	getBlockParameterName () const
	getBlockParameterName slot. More...
QString	getBlockParameterValue () const
	getBlockParameterValue slot. More...
void	setBlockParameterIsCustom (const bool &bIsCustom)
	setBlockParameterIsCustom slot. More...
void	setBlockParameterName (const QString &sValue)
	setBlockParameterName slot. More...
void	setBlockParameterValue (const QString &sValue)
	setBlockParameterValue slot. More...

Properties
int	BlockParameterID
	BlockParameterID property. More...
bool	BlockParameterIsCustom
	BlockParameterIsCustom property. More...
QString	BlockParameterName
	BlockParameterName property. More...
QString	BlockParameterValue
	BlockParameterValue property. More...

Detailed Description

The cBlockParameterStructure class.

The cBlockParameterStructure class is a container to store a Block Parameter structure that can be used by a Block structure definition for a specific Object Structure, see cBlockStructure, cObjectStructure.

Member Function Documentation

int cBlockParameterStructure::getBlockParameterID ( ) const

inline

getBlockParameterID slot.

This function returns the Block Parameter ID.

Returns

a integer value containing the requested Block Parameter ID.

bool cBlockParameterStructure::getBlockParameterIsCustom ( ) const

inline

getBlockParameterIsCustom slot.

This function returns the Block Parameter IsCustom property value.

Returns

a boolean value containing the requested Block Parameter IsCustom property value.

QString cBlockParameterStructure::getBlockParameterName ( ) const

inline

getBlockParameterName slot.

This function returns the Block Parameter Name.

Returns

a string value containing the requested Block Parameter Name.

QString cBlockParameterStructure::getBlockParameterValue ( ) const

inline

getBlockParameterValue slot.

This function returns the Block Parameter Value.

Returns

a string value containing the requested Block Parameter Value.

void cBlockParameterStructure::setBlockParameterID ( const int &  nValue )

inlineslot

setBlockParameterID slot.

This function sets the Block Parameter ID to the new provided value.

Parameters

nValue

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

void cBlockParameterStructure::setBlockParameterIsCustom ( const bool &  bIsCustom )

inline

setBlockParameterIsCustom slot.

This function sets the IsCustom Block Parameter property to the new provided value.

Parameters

bIsCustom

a boolean value holding the new IsCustom Block Parameter property value.

void cBlockParameterStructure::setBlockParameterName ( const QString &  sValue )

inline

setBlockParameterName slot.

This function sets the Block Parameter Name to the new provided value.

Parameters

sValue

a string value holding the new Block Parameter Name.

void cBlockParameterStructure::setBlockParameterValue ( const QString &  sValue )

inline

setBlockParameterValue slot.

This function sets the Block Parameter Value to the new provided value.

Parameters

sValue

a string value holding the new Block Parameter Value.

Property Documentation

int cBlockParameterStructure::BlockParameterID

readwrite

BlockParameterID property.

Use this property to set or retrieve the Block Parameter ID.

bool cBlockParameterStructure::BlockParameterIsCustom

readwrite

BlockParameterIsCustom property.

Use this property to set or retrieve whether the Block Parameter is custom or not.

QString cBlockParameterStructure::BlockParameterName

readwrite

BlockParameterName property.

Use this property to set or retrieve the Block Parameter Name.

QString cBlockParameterStructure::BlockParameterValue

readwrite

BlockParameterValue property.

Use this property to set or retrieve the Block Parameter Value.