COVISE Core
Public Slots | Public Member Functions | Protected Member Functions | Properties | Private Member Functions | Private Attributes | Static Private Attributes | List of all members
covise::WSStringParameter Class Reference

#include <WSStringParameter.h>

Inheritance diagram for covise::WSStringParameter:
Inheritance graph
[legend]
Collaboration diagram for covise::WSStringParameter:
Collaboration graph
[legend]

Public Slots

bool setValue (const QString &inValue)
 
const QString 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 WSParameterclone () const =0
 
virtual const covise::covise__Parameter * getSerialisable ()=0
 
virtual bool setValueFromSerialisable (const covise::covise__Parameter *serialisable)=0
 
virtual QString toCoviseString () const
 
static WSParametercreate (covise::covise__Parameter *parameter)
 

Public Member Functions

 WSStringParameter (const QString &name, const QString &description, const QString &value=QString::null)
 
virtual ~WSStringParameter ()
 
virtual WSParameterclone () 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)
 
virtual QString toCoviseString () const
 
- 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

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

Private Member Functions

 WSStringParameter ()
 

Private Attributes

covise::covise__StringParameter parameter
 

Static Private Attributes

static WSStringParameterprototype = new covise::WSStringParameter()
 

Additional Inherited Members

- Signals inherited from covise::WSParameter
void parameterChanged (covise::WSParameter *parameter)
 
- Static Protected Member Functions inherited from covise::WSParameter
static WSParameteraddPrototype (QString className, WSParameter *prototype)
 

Constructor & Destructor Documentation

◆ WSStringParameter() [1/2]

covise::WSStringParameter::WSStringParameter ( const QString &  name,
const QString &  description,
const QString &  value = QString::null 
)

◆ ~WSStringParameter()

covise::WSStringParameter::~WSStringParameter ( )
virtual

◆ WSStringParameter() [2/2]

covise::WSStringParameter::WSStringParameter ( )
private

Member Function Documentation

◆ clone()

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

Implements covise::WSParameter.

◆ getSerialisable()

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

Implements covise::WSParameter.

◆ getValue

const QString covise::WSStringParameter::getValue ( ) const
slot

Get the value of the parameter

Returns
value

◆ setValue

bool covise::WSStringParameter::setValue ( const QString &  inValue)
slot

Set the value of the parameter

Parameters
inValueThe new value of value
Returns
true if the parameter was changed

◆ setValueFromSerialisable()

bool covise::WSStringParameter::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.

◆ toCoviseString()

QString covise::WSStringParameter::toCoviseString ( ) const
protectedvirtual

Reimplemented from covise::WSParameter.

◆ toString

QString covise::WSStringParameter::toString ( ) const
virtualslot

Member Data Documentation

◆ parameter

covise::covise__StringParameter covise::WSStringParameter::parameter
private

◆ prototype

covise::WSStringParameter * covise::WSStringParameter::prototype = new covise::WSStringParameter()
staticprivate

Property Documentation

◆ value

QString covise::WSStringParameter::value
readwrite

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