covise::WSParameter Class Reference

#include <WSParameter.h>

Inheritance diagram for covise::WSParameter:

Collaboration diagram for covise::WSParameter:

Public Slots
const QString &	getName () const
const QString &	getType () const
const QString &	getDescription () const
void	setEnabled (bool state)
bool	isEnabled () const
void	setMapped (bool mapped)
bool	isMapped () const
virtual int	getComponentCount () const
virtual QString	toString () const =0
virtual WSParameter *	clone () const =0
virtual const covise::covise__Parameter *	getSerialisable ()=0
virtual bool	setValueFromSerialisable (const covise::covise__Parameter *serialisable)=0
virtual QString	toCoviseString () const
static WSParameter *	create (covise::covise__Parameter *parameter)

Signals
void	parameterChanged (covise::WSParameter *parameter)

Public Member Functions
	WSParameter (const QString &name, const QString &description, const QString &type)
virtual	~WSParameter ()

Protected Member Functions
const covise::covise__Parameter *	getSerialisable (covise::covise__Parameter *parameter) const
bool	equals (const covise::covise__Parameter *, const covise::covise__Parameter *)
	WSParameter (const WSParameter &)

Static Protected Member Functions
static WSParameter *	addPrototype (QString className, WSParameter *prototype)

Properties
QString	name
QString	type
QString	description
bool	enabled
bool	mapped

Private Member Functions
void	setName (const QString &inName)
void	setType (const QString &inType)
void	setDescription (const QString &inDescription)

Static Private Attributes
static std::map< QString, WSParameter * > *	prototypes = 0

Constructor & Destructor Documentation

WSParameter() [1/2]

WSParameter::WSParameter	(	const QString &	name,
		const QString &	description,
		const QString &	type
	)

~WSParameter()

WSParameter::~WSParameter ( )

virtual

WSParameter() [2/2]

WSParameter::WSParameter ( const WSParameter &  other )

protected

Member Function Documentation

addPrototype()

static WSParameter * covise::WSParameter::addPrototype ( QString  className, WSParameter *  prototype  )

inlinestaticprotected

clone

virtual WSParameter * covise::WSParameter::clone ( ) const

pure virtualslot

Implemented in covise::WSBooleanParameter, covise::WSChoiceParameter, covise::WSColormapChoiceParameter, covise::WSFileBrowserParameter, covise::WSFloatScalarParameter, covise::WSFloatSliderParameter, covise::WSFloatVectorParameter, covise::WSIntScalarParameter, covise::WSIntSliderParameter, covise::WSIntVectorParameter, and covise::WSStringParameter.

create

covise::WSParameter * WSParameter::create ( covise::covise__Parameter *  parameter )

staticslot

equals()

bool WSParameter::equals ( const covise::covise__Parameter *  first, const covise::covise__Parameter *  second  )

protected

getComponentCount

int WSParameter::getComponentCount ( ) const

virtualslot

Gets the number of components in a parameter. For non-vector parameter returns 1.

Returns

int: The number of vector components

getDescription

const QString & covise::WSParameter::getDescription ( ) const

inlineslot

Get the description of the paramter

Returns

QString: description

getName

const QString & covise::WSParameter::getName ( ) const

inlineslot

Get the name of the parameter

Returns

QString: name

getSerialisable [1/2]

virtual const covise::covise__Parameter * covise::WSParameter::getSerialisable ( )

pure virtualslot

Implemented in covise::WSBooleanParameter, covise::WSChoiceParameter, covise::WSColormapChoiceParameter, covise::WSFileBrowserParameter, covise::WSFloatScalarParameter, covise::WSFloatSliderParameter, covise::WSFloatVectorParameter, covise::WSIntScalarParameter, covise::WSIntSliderParameter, covise::WSIntVectorParameter, and covise::WSStringParameter.

getSerialisable() [2/2]

const covise::covise__Parameter * WSParameter::getSerialisable ( covise::covise__Parameter *  parameter ) const

protected

getType

const QString & covise::WSParameter::getType ( ) const

inlineslot

Get type of the parameter

Returns

QString: type

isEnabled

bool covise::WSParameter::isEnabled ( ) const

inlineslot

Get the parameter state (enabled or disabled)

Returns

bool: true, when enabled

isMapped

bool covise::WSParameter::isMapped ( ) const

inlineslot

Returns true, if the parameter is mapped in the control panel

Returns

bool: true, when mapped

parameterChanged

void covise::WSParameter::parameterChanged ( covise::WSParameter *  parameter )

signal

setDescription()

void covise::WSParameter::setDescription ( const QString &  inDescription )

inlineprivate

Set description of the parameter

Parameters

inDescription

The new value of description

setEnabled

void covise::WSParameter::setEnabled ( bool  state )

inlineslot

Enable or disable a parameter

Parameters

state

true when the parameter should be enabled.

setMapped

void covise::WSParameter::setMapped ( bool  mapped )

inlineslot

Map the parameter to the control panel;

setName()

void covise::WSParameter::setName ( const QString &  inName )

inlineprivate

Set the name of the parameter

Parameters

inName

The new value of name

setType()

void covise::WSParameter::setType ( const QString &  inType )

inlineprivate

Set type of the parameter

Parameters

inType

The new value of type

setValueFromSerialisable

virtual bool covise::WSParameter::setValueFromSerialisable ( const covise::covise__Parameter *  serialisable )

pure virtualslot

Sets the value from a native WS parameter

Returns

true, if the parameter was changed, false if the parameter did not change.

Implemented in covise::WSBooleanParameter, covise::WSChoiceParameter, covise::WSColormapChoiceParameter, covise::WSFileBrowserParameter, covise::WSFloatScalarParameter, covise::WSFloatSliderParameter, covise::WSFloatVectorParameter, covise::WSIntScalarParameter, covise::WSIntSliderParameter, covise::WSIntVectorParameter, and covise::WSStringParameter.

toCoviseString

virtual QString covise::WSParameter::toCoviseString ( ) const

inlinevirtualslot

Reimplemented in covise::WSChoiceParameter, covise::WSColormapChoiceParameter, covise::WSFileBrowserParameter, and covise::WSStringParameter.

toString

virtual QString covise::WSParameter::toString ( ) const

pure virtualslot

Get the value as string

Returns

QString: string representation of the value

Implemented in covise::WSChoiceParameter, and covise::WSColormapChoiceParameter.

Member Data Documentation

prototypes

std::map< QString, covise::WSParameter * > * WSParameter::prototypes = 0

staticprivate

Property Documentation

description

QString WSParameter::description

read

enabled

bool WSParameter::enabled

readwrite

mapped

bool WSParameter::mapped

readwrite

name

QString WSParameter::name

read

type

QString WSParameter::type

read

---

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

• wslib/WSParameter.h
• wslib/WSParameter.cpp