cMethodStructure Class Reference

The cMethodStructure class. More...

Inherits QObject.

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

Public Member Functions
int	getMethodID () const
	getMethodID slot. More...
int	getMethodObjectID () const
	getMethodObjectID slot. More...
int	getMethodOrderNumber () const
	getMethodObjectID slot. More...
QList< cMethodParameterStructure * >	getMethodParameterList () const
	getMethodParameterList slot. More...
QString	getMethodSignature () const
	getMethodSignature slot. More...
int	getMethodType () const
	getMethodType slot. More...
bool	insertMethodParameter (cMethodParameterStructure *pMethodParamStrcValue)
	insertMethodParameter slot. More...
void	setMethodObjectID (const int &nValue)
	setMethodeObjectID slot. More...
void	setMethodOrderNumber (const int &nValue)
	setMethodOrderNumber slot. More...
void	setMethodSignature (const QString &sValue)
	setMethodSignature slot. More...
void	setMethodType (const int &nValue)
	setMethodType slot. More...

Static Public Member Functions
static int	methodTypeStringToInteger (const QString &sValue)
	methodTypeStringToInteger slot. More...
static QString	methodTypeToString (const int &nValue)
	methodTypeToString slot. More...

Properties
int	MethodID
	MethodID property. More...
QString	MethodSignature
	MethodSignature property. More...
int	MethodType
	MethodType property. More...
int	OrderNumber
	OrderNumber property. More...
int	SourceObjectID
	SourceMethodID property. More...

Detailed Description

The cMethodStructure class.

The cMethodStructure class is a container to store a Method structure from a specific Object structure, see cObjectStructure.

Member Function Documentation

int cMethodStructure::getMethodID ( ) const

inline

getMethodID slot.

This function returns the Method ID.

Returns

a integer value containing the requested Method ID.

int cMethodStructure::getMethodObjectID ( ) const

inline

getMethodObjectID slot.

This function returns the Method Object ID.

Returns

a integer value containing the requested Method Object ID.

int cMethodStructure::getMethodOrderNumber ( ) const

inline

getMethodObjectID slot.

This function returns the Method Order Number.

Returns

a integer value containing the requested Method Order Number.

QList<cMethodParameterStructure*> cMethodStructure::getMethodParameterList ( ) const

inline

getMethodParameterList slot.

This function returns the inserted Method Parameters List (see cMethodStructure::insertMethodParameter).

Returns

a list containing the the inserted Method Parameters (see ExperimentStructuresNameSpace::cMethodParameterStructure).

QString cMethodStructure::getMethodSignature ( ) const

inline

getMethodSignature slot.

This function returns the Method Signature.

Returns

a string value containing the requested Method Signature.

int cMethodStructure::getMethodType ( ) const

inline

getMethodType slot.

This function returns the Method Type, see ExperimentStructuresNameSpace::MethodType.

Returns

a integer value (see ExperimentStructuresNameSpace::MethodType) containing the requested Method Type.

bool cMethodStructure::insertMethodParameter

(

cMethodParameterStructure *

pMethodParamStrcValue

)

insertMethodParameter slot.

This function inserts a Method Parameter (see ExperimentStructuresNameSpace::cMethodParameterStructure) from the provided data structure.

Parameters

pMethodParamStrcValue

a pointer to an ExperimentStructuresNameSpace::cMethodParameterStructure structure holding the Method Parameter data to insert.

Returns

a boolean value determining whether the function executed successfully.

static int cMethodStructure::methodTypeStringToInteger ( const QString &  sValue )

inlinestatic

methodTypeStringToInteger slot.

This function returns from the provided Method Type String the corresponding Method Type Integer value, see ExperimentStructuresNameSpace::MethodType.

Parameters

sValue

a string value holding the new Method Type.

Returns

a integer value containing the requested Method Type.

static QString cMethodStructure::methodTypeToString ( const int &  nValue )

inlinestatic

methodTypeToString slot.

This function returns from the provided Method Type the corresponding Method Type String value, see ExperimentStructuresNameSpace::MethodType.

Parameters

nValue

a integer value holding the Method Type.

Returns

a string value containing the requested corresponding Method Type value as string.

void cMethodStructure::setMethodID ( const int &  nValue )

inlineslot

setMethodID slot.

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

Parameters

nValue

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

void cMethodStructure::setMethodObjectID ( const int &  nValue )

inline

setMethodeObjectID slot.

This function sets the Method Object ID to the new provided value.

Parameters

nValue

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

void cMethodStructure::setMethodOrderNumber ( const int &  nValue )

inline

setMethodOrderNumber slot.

This function sets the Method Order Number to the new provided value.

Parameters

nValue

a integer value (>0) holding the new Method Order Number.

void cMethodStructure::setMethodSignature ( const QString &  sValue )

inline

setMethodSignature slot.

This function sets the Method Signature to the new provided value.

Parameters

sValue

a string value holding the new Method Signature.

void cMethodStructure::setMethodType ( const int &  nValue )

inline

setMethodType slot.

This function sets the Method Type to the new provided value, see ExperimentStructuresNameSpace::MethodType.

Parameters

nValue

a integer value (see ExperimentStructuresNameSpace::MethodType) holding the new Method Type.

Property Documentation

int cMethodStructure::MethodID

readwrite

MethodID property.

Use this property to set or retrieve the Method ID.

QString cMethodStructure::MethodSignature

readwrite

MethodSignature property.

Use this property to set or retrieve the Method Signature.

int cMethodStructure::MethodType

readwrite

MethodType property.

Use this property to set or retrieve the Method Type.

int cMethodStructure::OrderNumber

readwrite

OrderNumber property.

Use this property to set or retrieve the Method Order Number.

int cMethodStructure::SourceObjectID

readwrite

SourceMethodID property.

Use this property to set or retrieve the Method Object ID.