Developer Documentation
PropertyHandleT< T > Class Template Reference

The property handle, use it to access the properties. More...

#include <Type-Skeleton/ObjectTypes/Skeleton/Properties.hh>

Public Member Functions

 PropertyHandleT (int _idx=-1)
 Constructs a new property handle. More...
 
virtual ~PropertyHandleT ()
 Destructor.
 
bool isValid ()
 Returns true if the handle is valid, false otherwise. More...
 

Protected Types

typedef T value_type
 

Protected Attributes

int idx_
 The properties index.
 

Friends

class Properties
 

Detailed Description

template<typename T>
class PropertyHandleT< T >

The property handle, use it to access the properties.

The template parameter corresponds to the type stored by this property.

Definition at line 67 of file Properties.hh.

Constructor & Destructor Documentation

◆ PropertyHandleT()

template<typename T >
PropertyHandleT< T >::PropertyHandleT ( int  _idx = -1)
explicit

Constructs a new property handle.

Do not use the index parameter, unless you really know what you do. Rather pass 0 and then use Properties::get_property.

Parameters
_idxThe properties internal index, use with caution (or better, don't use at all)

Definition at line 194 of file PropertiesT_impl.hh.

Member Function Documentation

◆ isValid()

template<typename T >
bool PropertyHandleT< T >::isValid ( )
inline

Returns true if the handle is valid, false otherwise.

This method does not test if there is a property with that index, so make sure you don't use handles after their property was deleted or use invalid values in the constructor.

Definition at line 218 of file PropertiesT_impl.hh.


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