rviz::PropertyBase Class Reference

Abstract base class for properties. More...

#include <property.h>

Inheritance diagram for rviz::PropertyBase:

[legend]

List of all members.

Public Types
typedef boost::signal< void(const PropertyBasePtr &) >	ChangedSignal
Public Member Functions
void	addChangedListener (const ChangedSignal::slot_type &slot)
	Add a listener function/method to be called whenever the value in this property has changed.
virtual void	addLegacyName (const std::string &name)=0
void	changed ()
	Notify that the value in this property has changed. Should be called from within the setter function.
virtual std::string	getName ()=0
virtual CategoryPropertyWPtr	getParent ()=0
virtual wxPGProperty *	getPGProperty ()=0
virtual std::string	getPrefix ()=0
virtual bool	getSave ()=0
virtual void *	getUserData ()=0
virtual void	hide ()
virtual bool	isSelected ()
virtual void	loadFromConfig (wxConfigBase *config)=0
	PropertyBase ()
virtual void	readFromGrid ()=0
virtual void	reset ()
virtual void	saveToConfig (wxConfigBase *config)=0
virtual void	setPGClientData ()
virtual void	setPrefix (const std::string &prefix)=0
virtual void	setPropertyGrid (wxPropertyGrid *grid)
virtual void	setUserData (void *user_data)=0
virtual void	show ()
virtual void	writeToGrid ()=0
virtual	~PropertyBase ()
Protected Attributes
ChangedSignal	changed_
wxPropertyGrid *	grid_
wxPGProperty *	property_

---

Detailed Description

Abstract base class for properties.

Definition at line 77 of file property.h.

---

Member Typedef Documentation

typedef boost::signal< void (const PropertyBasePtr&) > rviz::PropertyBase::ChangedSignal

Definition at line 80 of file property.h.

---

Constructor & Destructor Documentation

rviz::PropertyBase::PropertyBase

(

)

Definition at line 121 of file property.cpp.

rviz::PropertyBase::~PropertyBase

(

)

[virtual]

Definition at line 128 of file property.cpp.

---

Member Function Documentation

void rviz::PropertyBase::addChangedListener

(

const ChangedSignal::slot_type &

slot

)

[inline]

Add a listener function/method to be called whenever the value in this property has changed.

Parameters:

slot

The function/method to call. See boost::signals

Definition at line 122 of file property.h.

virtual void rviz::PropertyBase::addLegacyName

(

const std::string &

name

)

[pure virtual]

Implemented in rviz::StatusProperty, rviz::Property< T >, rviz::Property< Ogre::Quaternion >, rviz::Property< Color >, rviz::Property< double >, rviz::Property< std::string >, rviz::Property< float >, rviz::Property< int >, rviz::Property< Ogre::Vector3 >, and rviz::Property< bool >.

void rviz::PropertyBase::changed

(

)

[inline]

Notify that the value in this property has changed. Should be called from within the setter function.

Definition at line 130 of file property.h.

virtual std::string rviz::PropertyBase::getName

(

)

[pure virtual]

Implemented in rviz::StatusProperty, rviz::Property< T >, rviz::Property< Ogre::Quaternion >, rviz::Property< Color >, rviz::Property< double >, rviz::Property< std::string >, rviz::Property< float >, rviz::Property< int >, rviz::Property< Ogre::Vector3 >, and rviz::Property< bool >.

virtual CategoryPropertyWPtr rviz::PropertyBase::getParent

(

)

[pure virtual]

Implemented in rviz::StatusProperty, rviz::Property< T >, rviz::Property< Ogre::Quaternion >, rviz::Property< Color >, rviz::Property< double >, rviz::Property< std::string >, rviz::Property< float >, rviz::Property< int >, rviz::Property< Ogre::Vector3 >, and rviz::Property< bool >.

virtual wxPGProperty* rviz::PropertyBase::getPGProperty

(

)

[pure virtual]

Implemented in rviz::StatusProperty, rviz::Property< T >, rviz::Property< Ogre::Quaternion >, rviz::Property< Color >, rviz::Property< double >, rviz::Property< std::string >, rviz::Property< float >, rviz::Property< int >, rviz::Property< Ogre::Vector3 >, and rviz::Property< bool >.

virtual std::string rviz::PropertyBase::getPrefix

(

)

[pure virtual]

Implemented in rviz::StatusProperty, rviz::Property< T >, rviz::Property< Ogre::Quaternion >, rviz::Property< Color >, rviz::Property< double >, rviz::Property< std::string >, rviz::Property< float >, rviz::Property< int >, rviz::Property< Ogre::Vector3 >, and rviz::Property< bool >.

virtual bool rviz::PropertyBase::getSave

(

)

[pure virtual]

Implemented in rviz::StatusProperty, rviz::Property< T >, rviz::Property< Ogre::Quaternion >, rviz::Property< Color >, rviz::Property< double >, rviz::Property< std::string >, rviz::Property< float >, rviz::Property< int >, rviz::Property< Ogre::Vector3 >, and rviz::Property< bool >.

virtual void* rviz::PropertyBase::getUserData

(

)

[pure virtual]

Implemented in rviz::StatusProperty, rviz::Property< T >, rviz::Property< Ogre::Quaternion >, rviz::Property< Color >, rviz::Property< double >, rviz::Property< std::string >, rviz::Property< float >, rviz::Property< int >, rviz::Property< Ogre::Vector3 >, and rviz::Property< bool >.

void rviz::PropertyBase::hide

(

)

[virtual]

Reimplemented in rviz::Vector3Property, and rviz::QuaternionProperty.

Definition at line 149 of file property.cpp.

bool rviz::PropertyBase::isSelected

(

)

[virtual]

Definition at line 165 of file property.cpp.

virtual void rviz::PropertyBase::loadFromConfig

(

wxConfigBase *

config

)

[pure virtual]

Implemented in rviz::StatusProperty, rviz::BoolProperty, rviz::IntProperty, rviz::FloatProperty, rviz::DoubleProperty, rviz::StringProperty, rviz::ColorProperty, rviz::EnumProperty, rviz::EditEnumProperty, rviz::CategoryProperty, rviz::Vector3Property, and rviz::QuaternionProperty.

virtual void rviz::PropertyBase::readFromGrid

(

)

[pure virtual]

Implemented in rviz::StatusProperty, rviz::BoolProperty, rviz::IntProperty, rviz::FloatProperty, rviz::DoubleProperty, rviz::StringProperty, rviz::ColorProperty, rviz::EnumProperty, rviz::EditEnumProperty, rviz::CategoryProperty, rviz::Vector3Property, and rviz::QuaternionProperty.

virtual void rviz::PropertyBase::reset

(

)

[inline, virtual]

Reimplemented in rviz::Vector3Property, and rviz::QuaternionProperty.

Definition at line 107 of file property.h.

virtual void rviz::PropertyBase::saveToConfig

(

wxConfigBase *

config

)

[pure virtual]

Implemented in rviz::StatusProperty, rviz::BoolProperty, rviz::IntProperty, rviz::FloatProperty, rviz::DoubleProperty, rviz::StringProperty, rviz::ColorProperty, rviz::EnumProperty, rviz::EditEnumProperty, rviz::CategoryProperty, rviz::Vector3Property, and rviz::QuaternionProperty.

void rviz::PropertyBase::setPGClientData

(

)

[virtual]

Reimplemented in rviz::StatusProperty, rviz::Vector3Property, and rviz::QuaternionProperty.

Definition at line 141 of file property.cpp.

virtual void rviz::PropertyBase::setPrefix

(

const std::string &

prefix

)

[pure virtual]

Implemented in rviz::StatusProperty, rviz::Property< T >, rviz::Vector3Property, rviz::QuaternionProperty, rviz::Property< Ogre::Quaternion >, rviz::Property< Color >, rviz::Property< double >, rviz::Property< std::string >, rviz::Property< float >, rviz::Property< int >, rviz::Property< Ogre::Vector3 >, and rviz::Property< bool >.

void rviz::PropertyBase::setPropertyGrid

(

wxPropertyGrid *

grid

)

[virtual]

Definition at line 136 of file property.cpp.

virtual void rviz::PropertyBase::setUserData

(

void *

user_data

)

[pure virtual]

Implemented in rviz::StatusProperty, rviz::Property< T >, rviz::Property< Ogre::Quaternion >, rviz::Property< Color >, rviz::Property< double >, rviz::Property< std::string >, rviz::Property< float >, rviz::Property< int >, rviz::Property< Ogre::Vector3 >, and rviz::Property< bool >.

void rviz::PropertyBase::show

(

)

[virtual]

Reimplemented in rviz::Vector3Property, and rviz::QuaternionProperty.

Definition at line 157 of file property.cpp.

virtual void rviz::PropertyBase::writeToGrid

(

)

[pure virtual]

Implemented in rviz::StatusProperty, rviz::BoolProperty, rviz::IntProperty, rviz::FloatProperty, rviz::DoubleProperty, rviz::StringProperty, rviz::ROSTopicStringProperty, rviz::ColorProperty, rviz::EnumProperty, rviz::EditEnumProperty, rviz::TFFrameProperty, rviz::CategoryProperty, rviz::Vector3Property, and rviz::QuaternionProperty.

---

Member Data Documentation

ChangedSignal rviz::PropertyBase::changed_ [protected]

Definition at line 139 of file property.h.

wxPropertyGrid* rviz::PropertyBase::grid_ [protected]

Definition at line 136 of file property.h.

wxPGProperty* rviz::PropertyBase::property_ [protected]

Definition at line 137 of file property.h.

---

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

• property.h
• property.cpp