covise::WSFloatScalarParameter Class Reference

#include <WSFloatScalarParameter.h>

Inheritance diagram for covise::WSFloatScalarParameter:

Collaboration diagram for covise::WSFloatScalarParameter:

Public Slots
bool	setValue (float inValue)
float	getValue () const
virtual QString	toString () const
Public Slots inherited from covise::WSParameter
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)

Public Member Functions
	WSFloatScalarParameter (const QString &name, const QString &description, float value=0.0f)
virtual	~WSFloatScalarParameter ()
virtual WSParameter *	clone () const
virtual const covise::covise__Parameter *	getSerialisable ()
Public Member Functions inherited from covise::WSParameter
	WSParameter (const QString &name, const QString &description, const QString &type)
virtual	~WSParameter ()

Protected Member Functions
virtual bool	setValueFromSerialisable (const covise::covise__Parameter *serialisable)
Protected Member Functions inherited from covise::WSParameter
const covise::covise__Parameter *	getSerialisable (covise::covise__Parameter *parameter) const
bool	equals (const covise::covise__Parameter *, const covise::covise__Parameter *)
	WSParameter (const WSParameter &)

Properties
float	value
Properties inherited from covise::WSParameter
QString	name
QString	type
QString	description
bool	enabled
bool	mapped

Private Member Functions
	WSFloatScalarParameter ()

Private Attributes
covise::covise__FloatScalarParameter	parameter

Static Private Attributes
static WSFloatScalarParameter *	prototype = new covise::WSFloatScalarParameter()

Additional Inherited Members
Signals inherited from covise::WSParameter
void	parameterChanged (covise::WSParameter *parameter)
Static Protected Member Functions inherited from covise::WSParameter
static WSParameter *	addPrototype (QString className, WSParameter *prototype)

Constructor & Destructor Documentation

WSFloatScalarParameter() [1/2]

covise::WSFloatScalarParameter::WSFloatScalarParameter	(	const QString &	name,
		const QString &	description,
		float	value = 0.0f
	)

~WSFloatScalarParameter()

covise::WSFloatScalarParameter::~WSFloatScalarParameter ( )

virtual

WSFloatScalarParameter() [2/2]

covise::WSFloatScalarParameter::WSFloatScalarParameter ( )

private

Member Function Documentation

clone()

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

virtual

Implements covise::WSParameter.

getSerialisable()

const covise::covise__Parameter * covise::WSFloatScalarParameter::getSerialisable ( )

virtual

Implements covise::WSParameter.

getValue

float covise::WSFloatScalarParameter::getValue ( ) const

slot

Get the value of the scalar parameter

Returns

value

setValue

bool covise::WSFloatScalarParameter::setValue ( float  inValue )

slot

Set the value of the scalar parameter

Parameters

inValue

The new value of value

Returns

true if the parameter was changed

setValueFromSerialisable()

bool covise::WSFloatScalarParameter::setValueFromSerialisable ( const covise::covise__Parameter *  serialisable )

protectedvirtual

Sets the value from a native WS parameter

Returns

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

Implements covise::WSParameter.

toString

QString covise::WSFloatScalarParameter::toString ( ) const

virtualslot

Member Data Documentation

parameter

covise::covise__FloatScalarParameter covise::WSFloatScalarParameter::parameter

private

prototype

covise::WSFloatScalarParameter * covise::WSFloatScalarParameter::prototype = new covise::WSFloatScalarParameter()

staticprivate

Property Documentation

value

float covise::WSFloatScalarParameter::value

readwrite

---

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

• wslib/WSFloatScalarParameter.h
• wslib/WSFloatScalarParameter.cpp