Public Slots | Public Member Functions | Private Attributes
rviz::FloatProperty Class Reference

Property specialized to enforce floating point max/min. More...

#include <float_property.h>

Inheritance diagram for rviz::FloatProperty:
Inheritance graph
[legend]

List of all members.

Public Slots

bool add (float delta)
 Add the given delta to the property value.
bool multiply (float factor)
 Multiply the property value by the given factor.
bool setFloat (float new_value)
 Float-typed "SLOT" version of setValue().

Public Member Functions

 FloatProperty (const QString &name=QString(), float default_value=0, const QString &description=QString(), Property *parent=0, const char *changed_slot=0, QObject *receiver=0)
virtual float getFloat () const
float getMax ()
float getMin ()
void setMax (float max)
void setMin (float min)
virtual bool setValue (const QVariant &new_value)
 Set the new value for this property. Returns true if the new value is different from the old value, false if same.

Private Attributes

float max_
float min_

Detailed Description

Property specialized to enforce floating point max/min.

Definition at line 38 of file float_property.h.


Constructor & Destructor Documentation

rviz::FloatProperty::FloatProperty ( const QString &  name = QString(),
float  default_value = 0,
const QString &  description = QString(),
Property parent = 0,
const char *  changed_slot = 0,
QObject *  receiver = 0 
)

Definition at line 39 of file float_property.cpp.


Member Function Documentation

bool rviz::FloatProperty::add ( float  delta) [inline, slot]

Add the given delta to the property value.

Definition at line 70 of file float_property.h.

virtual float rviz::FloatProperty::getFloat ( ) const [inline, virtual]

Definition at line 58 of file float_property.h.

float rviz::FloatProperty::getMax ( ) [inline]

Definition at line 63 of file float_property.h.

float rviz::FloatProperty::getMin ( ) [inline]

Definition at line 61 of file float_property.h.

bool rviz::FloatProperty::multiply ( float  factor) [inline, slot]

Multiply the property value by the given factor.

Definition at line 73 of file float_property.h.

bool rviz::FloatProperty::setFloat ( float  new_value) [inline, slot]

Float-typed "SLOT" version of setValue().

Definition at line 67 of file float_property.h.

void rviz::FloatProperty::setMax ( float  max)

Definition at line 62 of file float_property.cpp.

void rviz::FloatProperty::setMin ( float  min)

Definition at line 56 of file float_property.cpp.

bool rviz::FloatProperty::setValue ( const QVariant &  new_value) [virtual]

Set the new value for this property. Returns true if the new value is different from the old value, false if same.

If the new value is different from the old value, this emits aboutToChange() before changing the value and changed() after.

Overridden from Property::setValue() to enforce minimum and maximum.

Reimplemented from rviz::Property.

Definition at line 51 of file float_property.cpp.


Member Data Documentation

float rviz::FloatProperty::max_ [private]

Definition at line 77 of file float_property.h.

float rviz::FloatProperty::min_ [private]

Definition at line 76 of file float_property.h.


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


rviz
Author(s): Dave Hershberger, David Gossow, Josh Faust
autogenerated on Thu Aug 27 2015 15:02:28