OpenWalnut  1.4.0
Classes | Public Types | Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | List of all members
WPropertyGroupBase Class Reference

This is the base class and interface for property groups. More...

#include <WPropertyGroupBase.h>

+ Inheritance diagram for WPropertyGroupBase:

Classes

struct  PropertyCreatorAndGroupAdder
 Comfortable template to create a property instance and add it to the group. More...
struct  PropertyCreatorAndGroupAdder< WPropertyStructHelper::NOTYPE >
 Specialization which does nothing for the NOTYPE default template parameters of WPropertyStruct. More...

Public Types

typedef std::vector
< boost::shared_ptr
< WPropertyBase > > 
PropertyContainerType
 For shortening: a type defining a shared vector of WSubject pointers.
typedef
WSharedSequenceContainer
< PropertyContainerType
PropertySharedContainerType
 The alias for a shared container.
typedef
PropertyContainerType::const_iterator 
PropertyConstIterator
 The const iterator type of the container.
typedef
PropertyContainerType::iterator 
PropertyIterator
 The iterator type of the container.
typedef boost::shared_ptr
< WPropertyGroupBase
SPtr
 Convenience typedef for a boost::shared_ptr< WPropertyGroupBase >.
typedef boost::shared_ptr
< const WPropertyGroupBase
ConstSPtr
 Convenience typedef for a boost::shared_ptr< const WPropertyGroupBase >.
typedef boost::function< void(std::string,
std::string)> 
PropertyStringVisitor
 The visitor type used to visit properties as strings.
- Public Types inherited from WPropertyBase
typedef boost::shared_ptr
< WPropertyBase
SPtr
 Convenience typedef for a boost::shared_ptr< WPropertyBase >
typedef boost::shared_ptr
< const WPropertyBase
ConstSPtr
 Convenience typedef for a boost::shared_ptr< const WPropertyBase >
typedef boost::function< void(boost::shared_ptr
< WPropertyBase >)> 
PropertyChangeNotifierType
 Signal signature emitted during set operations.

Public Member Functions

 WPropertyGroupBase (std::string name, std::string description)
 Constructor.
 WPropertyGroupBase (const WPropertyGroupBase &from)
 Copy constructor.
virtual ~WPropertyGroupBase ()
 Destructor.
virtual bool existsProperty (std::string name)
 Helper function that finds a property by its name.
virtual boost::shared_ptr
< WPropertyBase
getProperty (std::string name)
 Function searches the property.
virtual
PropertySharedContainerType::ReadTicket 
getProperties () const
 Returns a read ticket for read-access to the list of properties.
virtual
PropertySharedContainerType::ReadTicket 
getReadTicket () const
 Returns an read ticket for the properties.
virtual boost::shared_ptr
< WPropertyBase
findProperty (std::string name) const
 Searches the property with a given name.
virtual void visitAsString (PropertyStringVisitor visitor, std::string pathPrefix="") const
 Visit all leafs in the property three that aren't empty groups.
- Public Member Functions inherited from WPropertyBase
 WPropertyBase (std::string name, std::string description)
 Create an empty named property.
 WPropertyBase (const WPropertyBase &from)
 Copy constructor.
virtual ~WPropertyBase ()
 Destructor.
virtual boost::shared_ptr
< WPropertyBase
clone ()=0
 This method clones a property and returns the clone.
std::string getName () const
 Gets the name of the class.
std::string getDescription () const
 Gets the description of the property.
bool isHidden () const
 Determines whether the property is hidden or not.
void setHidden (bool hidden=true)
 Sets the property hidden.
virtual PROPERTY_TYPE getType () const
 Gets the real WPropertyVariable type of this instance.
virtual PROPERTY_PURPOSE getPurpose () const
 Gets the purpose of a property.
virtual void setPurpose (PROPERTY_PURPOSE purpose)
 Sets the purpose of the property.
virtual bool setAsString (std::string value)=0
 This methods allows properties to be set by a string value.
virtual std::string getAsString ()=0
 Returns the current value as a string.
virtual boost::shared_ptr
< WCondition
getUpdateCondition () const
 This method returns a condition which gets fired whenever the property changes somehow.
virtual bool set (boost::shared_ptr< WPropertyBase > value, bool recommendedOnly=false)=0
 Sets the value from the specified property to this one.
WPropInt toPropInt ()
 Helper converts this instance to its native type.
WPropDouble toPropDouble ()
 Helper converts this instance to its native type.
WPropBool toPropBool ()
 Helper converts this instance to its native type.
WPropString toPropString ()
 Helper converts this instance to its native type.
WPropFilename toPropFilename ()
 Helper converts this instance to its native type.
WPropSelection toPropSelection ()
 Helper converts this instance to its native type.
WPropColor toPropColor ()
 Helper converts this instance to its native type.
WPropPosition toPropPosition ()
 Helper converts this instance to its native type.
WPropTrigger toPropTrigger ()
 Helper converts this instance to its native type.
WPropMatrix4X4 toPropMatrix4X4 ()
 Helper converts this instance to its native type.
WPropTransferFunction toPropTransferFunction ()
 Helper converts this instance to its native type.
WPropGroup toPropGroup ()
 Helper converts this instance to its native type.
WPropInterval toPropInterval ()
 Helper converts this instance to its native type.
boost::shared_ptr
< WPropertyGroupBase
toPropGroupBase ()
 Convert the property to a WPropertyGroupBase.
template<typename T >
boost::shared_ptr
< WPropertyVariable< T > > 
toPropertyVariable ()
 Helper converts this instance to an arbitrary type.

Static Public Attributes

static const std::string separator = "/"
 The separator used to separate groups and subgroups.

Protected Member Functions

virtual boost::shared_ptr
< WPropertyBase
findProperty (const WPropertyGroupBase *const props, std::string name) const
 Helping function to find a property inside a specific group.
bool propNamePredicate (boost::shared_ptr< WPropertyBase > prop1, boost::shared_ptr< WPropertyBase > prop2) const
 Compares the names of two properties and returns true if they are equal.
void addArbitraryProperty (WPropertyBase::SPtr prop)
 Insert the specified property into the list.
- Protected Member Functions inherited from WPropertyBase
virtual void updateType ()
 Calculates the type of the property.

Protected Attributes

PropertySharedContainerType m_properties
 The set of proerties.
- Protected Attributes inherited from WPropertyBase
std::string m_name
 Name of the property.
std::string m_description
 Description of the property.
bool m_hidden
 Flag denoting whether the property is hidden or not.
PROPERTY_TYPE m_type
 Type of the PropertyVariable instance.
PROPERTY_PURPOSE m_purpose
 The purpose of this property.
PropertyChangeSignalType signal_PropertyChange
 Signal getting fired whenever the property changes.
boost::shared_ptr< WConditionSetm_updateCondition
 Condition notified whenever something changes.

Additional Inherited Members

- Protected Types inherited from WPropertyBase
typedef
boost::signals2::signal< void(boost::shared_ptr
< WPropertyBase >)> 
PropertyChangeSignalType
 Signal used for firing change signals.

Detailed Description

This is the base class and interface for property groups.

This class itself is abstract and derived from WPropertyBase. So if you create a group of properties, this ensures that your group is a property itself. This interface defines no way to add, remove or edit the property list itself. This allows the deriving class to prohibit modifications and to provide a custom interface, or even model-controller like implementations.

Another advantage is, that the GUI implementations which support WPropertyGroupBase can display your custom properties directly.

Definition at line 51 of file WPropertyGroupBase.h.

Member Typedef Documentation

typedef boost::shared_ptr< const WPropertyGroupBase > WPropertyGroupBase::ConstSPtr

Convenience typedef for a boost::shared_ptr< const WPropertyGroupBase >.

Definition at line 82 of file WPropertyGroupBase.h.

typedef PropertyContainerType::const_iterator WPropertyGroupBase::PropertyConstIterator

The const iterator type of the container.

Definition at line 67 of file WPropertyGroupBase.h.

typedef std::vector< boost::shared_ptr< WPropertyBase > > WPropertyGroupBase::PropertyContainerType

For shortening: a type defining a shared vector of WSubject pointers.

Definition at line 57 of file WPropertyGroupBase.h.

typedef PropertyContainerType::iterator WPropertyGroupBase::PropertyIterator

The iterator type of the container.

Definition at line 72 of file WPropertyGroupBase.h.

The alias for a shared container.

Definition at line 62 of file WPropertyGroupBase.h.

typedef boost::function< void ( std::string, std::string )> WPropertyGroupBase::PropertyStringVisitor

The visitor type used to visit properties as strings.

The first parameter is the name, including the path of the property, relative to this group. The second parameter is the value as string.

Definition at line 172 of file WPropertyGroupBase.h.

typedef boost::shared_ptr< WPropertyGroupBase > WPropertyGroupBase::SPtr

Convenience typedef for a boost::shared_ptr< WPropertyGroupBase >.

Definition at line 77 of file WPropertyGroupBase.h.

Constructor & Destructor Documentation

WPropertyGroupBase::WPropertyGroupBase ( std::string  name,
std::string  description 
)

Constructor.

Creates an empty list of properties.

Parameters
namethe name of the property group. The GUI is using this name for naming the tabs/group boxes
descriptionthe description of the group.

Definition at line 45 of file WPropertyGroupBase.cpp.

References WSharedObject< T >::getChangeCondition(), m_properties, and WPropertyBase::m_updateCondition.

WPropertyGroupBase::WPropertyGroupBase ( const WPropertyGroupBase from)
explicit

Copy constructor.

Creates a deep copy of this property. As boost::signals2 and condition variables are non-copyable, new instances get created. The subscriptions to a signal are LOST as well as all listeners to a condition. The conditions you can grab using getValueChangeConditon and getCondition are not the same as in the original! This is because the class corresponds to the observer/observable pattern. You won't expect a clone to fire a condition if a original flag is changed (which after cloning is completely decoupled from the clone).

Notes:
the properties inside this list are also copied deep
Parameters
fromthe instance to copy.

Definition at line 57 of file WPropertyGroupBase.cpp.

References addArbitraryProperty(), WSharedObject< T >::getChangeCondition(), WSharedObject< T >::getReadTicket(), m_properties, and WPropertyBase::m_updateCondition.

WPropertyGroupBase::~WPropertyGroupBase ( )
virtual

Destructor.

Definition at line 53 of file WPropertyGroupBase.cpp.

Member Function Documentation

void WPropertyGroupBase::addArbitraryProperty ( WPropertyBase::SPtr  prop)
protected

Insert the specified property into the list.

This method is protected. It is a convenience method for deriving classes to add properties without the need to update several conditions and similar.

Parameters
propthe property to add

Definition at line 196 of file WPropertyGroupBase.cpp.

References WPropertyBase::getName(), WPropertyBase::getPurpose(), WSharedObject< T >::getWriteTicket(), m_properties, WPropertyBase::m_updateCondition, and propNamePredicate().

Referenced by WPropertyGroup::addProperty(), WPropertyGroupBase::PropertyCreatorAndGroupAdder< PropertyType >::createAndAdd(), and WPropertyGroupBase().

bool WPropertyGroupBase::existsProperty ( std::string  name)
virtual

Helper function that finds a property by its name.

Use this method to find out whether the property exists or not, since findProperty throws an exception.

Parameters
namename of searched property.
Returns
Answer to the question whether the property exists.

Definition at line 180 of file WPropertyGroupBase.cpp.

References findProperty().

boost::shared_ptr< WPropertyBase > WPropertyGroupBase::findProperty ( std::string  name) const
virtual

Searches the property with a given name.

It does not throw any exception. It simply returns NULL if it can't be found. It searches in nested groups too. The naming rules for finding a property in subgroups of this group is like specifying a path, using the separator char: "somegroup" + separator + "anothergroup" + separator + "propnametosearch".

Parameters
namethe name of the property to search
Returns
the property or NULL if not found.

Definition at line 106 of file WPropertyGroupBase.cpp.

References WPVBaseTypes::isPropertyGroup(), separator, WPropertyBase::toPropGroupBase(), and string_utils::toString().

Referenced by existsProperty(), getProperty(), and WPropertyGroup::setImpl().

boost::shared_ptr< WPropertyBase > WPropertyGroupBase::findProperty ( const WPropertyGroupBase *const  props,
std::string  name 
) const
protectedvirtual

Helping function to find a property inside a specific group.

It does not recursively find properties nested inside other property groups.

Parameters
propsthe group to search in. This is not a shared pointer since it is not needed. It simply can't happen that it is freed during findProperty as it is contained in this or a nested properties instance.
namethe name of the property inside THIS group.
Returns
the property if found, else NULL.

Definition at line 85 of file WPropertyGroupBase.cpp.

References WSharedObject< T >::getReadTicket(), and m_properties.

WPropertyGroupBase::PropertySharedContainerType::ReadTicket WPropertyGroupBase::getProperties ( ) const
virtual

Returns a read ticket for read-access to the list of properties.

Returns
the read ticket.

Definition at line 234 of file WPropertyGroupBase.cpp.

References WSharedObject< T >::getReadTicket(), and m_properties.

boost::shared_ptr< WPropertyBase > WPropertyGroupBase::getProperty ( std::string  name)
virtual

Function searches the property.

If it does not exists, it throws an exception.

Parameters
namethe name of the property
Returns
a WProperty object

Definition at line 185 of file WPropertyGroupBase.cpp.

References findProperty().

WPropertyGroupBase::PropertySharedContainerType::ReadTicket WPropertyGroupBase::getReadTicket ( ) const
virtual

Returns an read ticket for the properties.

This, and only this, has to be used for external iteration of properties.

See Also
WSharedObjectTicketRead
Returns
the read ticket.

Definition at line 239 of file WPropertyGroupBase.cpp.

References WSharedObject< T >::getReadTicket(), and m_properties.

Referenced by visitAsString().

bool WPropertyGroupBase::propNamePredicate ( boost::shared_ptr< WPropertyBase prop1,
boost::shared_ptr< WPropertyBase prop2 
) const
protected

Compares the names of two properties and returns true if they are equal.

Parameters
prop1the first prop.
prop2the second prop.
Returns
Are the names of the two properties equal?

Definition at line 80 of file WPropertyGroupBase.cpp.

Referenced by addArbitraryProperty().

void WPropertyGroupBase::visitAsString ( WPropertyGroupBase::PropertyStringVisitor  visitor,
std::string  pathPrefix = "" 
) const
virtual

Visit all leafs in the property three that aren't empty groups.

This is especially interesting when using it with lambda functionality. The visitor function gets two parameters: 1st: the name of the property, including the path beginning at this group; 2nd: the value as string.

Parameters
visitorthe function to use for each property.
pathPrefixadd this prefix to the property name in the visitor. It might be interesting if manually implementing group visitors that always require a complete path, so you can add an upper-level path here.

Definition at line 143 of file WPropertyGroupBase.cpp.

References getReadTicket(), and separator.

Member Data Documentation

PropertySharedContainerType WPropertyGroupBase::m_properties
protected
const std::string WPropertyGroupBase::separator = "/"
static

The separator used to separate groups and subgroups.

Definition at line 87 of file WPropertyGroupBase.h.

Referenced by findProperty(), WPropertyGroup::setImpl(), and visitAsString().


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