COVISE Core
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros
Public Slots | Signals | Public Member Functions | Protected Member Functions | Static Protected Member Functions | Properties | Private Member Functions | Static Private Attributes | List of all members
covise::WSParameter Class Referenceabstract

#include <WSParameter.h>

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

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 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)
 

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 WSParameteraddPrototype (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::WSParameter ( const QString &  name,
const QString &  description,
const QString &  type 
)
WSParameter::~WSParameter ( )
virtual
WSParameter::WSParameter ( const WSParameter other)
protected

Member Function Documentation

static WSParameter* covise::WSParameter::addPrototype ( QString  className,
WSParameter prototype 
)
inlinestaticprotected
virtual WSParameter* covise::WSParameter::clone ( ) const
pure virtualslot
covise::WSParameter * WSParameter::create ( covise::covise__Parameter *  parameter)
staticslot
bool WSParameter::equals ( const covise::covise__Parameter *  first,
const covise::covise__Parameter *  second 
)
protected
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
const QString& covise::WSParameter::getDescription ( ) const
inlineslot

Get the description of the paramter

Returns
QString: description
const QString& covise::WSParameter::getName ( ) const
inlineslot

Get the name of the parameter

Returns
QString: name
virtual const covise::covise__Parameter* covise::WSParameter::getSerialisable ( )
pure virtualslot
const covise::covise__Parameter * WSParameter::getSerialisable ( covise::covise__Parameter *  parameter) const
protected
const QString& covise::WSParameter::getType ( ) const
inlineslot

Get type of the parameter

Returns
QString: type
bool covise::WSParameter::isEnabled ( ) const
inlineslot

Get the parameter state (enabled or disabled)

Returns
bool: true, when enabled
bool covise::WSParameter::isMapped ( ) const
inlineslot

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

Returns
bool: true, when mapped
void covise::WSParameter::parameterChanged ( covise::WSParameter parameter)
signal
void covise::WSParameter::setDescription ( const QString &  inDescription)
inlineprivate

Set description of the parameter

Parameters
inDescriptionThe new value of description
void covise::WSParameter::setEnabled ( bool  state)
inlineslot

Enable or disable a parameter

Parameters
statetrue when the parameter should be enabled.
void covise::WSParameter::setMapped ( bool  mapped)
inlineslot

Map the parameter to the control panel;

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

Set the name of the parameter

Parameters
inNameThe new value of name
void covise::WSParameter::setType ( const QString &  inType)
inlineprivate

Set type of the parameter

Parameters
inTypeThe new value of type
virtual bool covise::WSParameter::setValueFromSerialisable ( const covise::covise__Parameter *  serialisable)
pure virtualslot
virtual QString covise::WSParameter::toCoviseString ( ) const
inlinevirtualslot
virtual QString covise::WSParameter::toString ( ) const
pure virtualslot

Get the value as string

Returns
QString: string representation of the value

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

Member Data Documentation

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

Property Documentation

QString WSParameter::description
read
bool WSParameter::enabled
readwrite
bool WSParameter::mapped
readwrite
QString WSParameter::name
read
QString WSParameter::type
read

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