#include <property.hpp>

Classes
class	ScopedLockReadOnly

class	ScopedLockReadWrite

Public Types
using	ImplType = PropertyImpl< T >

using	Getter = typename ImplType::Getter

using	Setter = typename ImplType::Setter

Public Types inherited from qi::PropertyImpl< T >
using	Setter = boost::function< bool(T &, const T &)>

using	Getter = boost::function< T(const T &)>

using	SignalType = SignalF< void(const T &)>

using	PropertyType = T

Public Types inherited from qi::SignalF< void(const T &)>
using	FunctionType = void(const T &)

Public Types inherited from qi::SignalBase
using	OnSubscribers = boost::function< void(bool)>

Public Member Functions
	Property (Getter getter=Getter(), Setter setter=Setter(), SignalBase::OnSubscribers onsubscribe=SignalBase::OnSubscribers())

	Property (AutoAnyReference defaultValue, Getter getter=Getter(), Setter setter=Setter(), SignalBase::OnSubscribers onsubscribe=SignalBase::OnSubscribers())

Property< T > &	operator= (const T &v)

FutureSync< T >	get () const override

FutureSync< void >	set (const T &v) override

SignalBase *	signal () override

FutureSync< void >	setValue (AutoAnyReference value) override

FutureSync< AnyValue >	value () const override

ScopedLockReadWrite	getLockedReadWrite ()

ScopedLockReadOnly	getLockedReadOnly () const

Public Member Functions inherited from qi::PropertyImpl< T >
	PropertyImpl (Getter getter=Getter(), Setter setter=Setter(), SignalBase::OnSubscribers onsubscribe=SignalBase::OnSubscribers())

	PropertyImpl (AutoAnyReference defaultValue, Getter getter=Getter(), Setter setter=Setter(), SignalBase::OnSubscribers onsubscribe=SignalBase::OnSubscribers())

PropertyImpl< T > &	operator= (const T &v)

Public Member Functions inherited from qi::SignalF< void(const T &)>
	SignalF (OnSubscribers onSubscribers=OnSubscribers())

virtual qi::Signature	signature () const

SignalSubscriber &	connect (...)

Public Member Functions inherited from qi::SignalBase
	SignalBase (const Signature &signature, OnSubscribers onSubscribers=OnSubscribers())

	SignalBase (OnSubscribers onSubscribers=OnSubscribers())

virtual	~SignalBase ()

template<typename F >
SignalSubscriber &	connect (boost::function< F > func)

SignalSubscriber &	connect (const SignalSubscriber &s)

SignalSubscriber &	connect (AnyObject object, const unsigned int slot)

SignalSubscriber &	connect (AnyObject object, const std::string &slot)

bool	disconnectAll ()

bool	asyncDisconnectAll ()

bool	disconnect (const SignalLink &link)

bool	asyncDisconnect (const SignalLink &link)

virtual void	trigger (const GenericFunctionParameters &params, MetaCallType callType=MetaCallType_Auto)

void	setCallType (MetaCallType callType)
	Set the MetaCallType used by operator()(). More...

void	operator() (qi::AutoAnyReference p1=qi::AutoAnyReference(), qi::AutoAnyReference p2=qi::AutoAnyReference(), qi::AutoAnyReference p3=qi::AutoAnyReference(), qi::AutoAnyReference p4=qi::AutoAnyReference(), qi::AutoAnyReference p5=qi::AutoAnyReference(), qi::AutoAnyReference p6=qi::AutoAnyReference(), qi::AutoAnyReference p7=qi::AutoAnyReference(), qi::AutoAnyReference p8=qi::AutoAnyReference())
	Trigger the signal with given arguments, and call type set by setCallType() More...

std::vector< SignalSubscriber >	subscribers ()

bool	hasSubscribers ()

void	_setSignature (const Signature &s)

Public Member Functions inherited from qi::PropertyBase
virtual	~PropertyBase ()=default

Additional Inherited Members
Public Attributes inherited from qi::SignalBase
boost::shared_ptr < SignalBasePrivate >	_p

Static Public Attributes inherited from qi::SignalBase
static const SignalLink	invalidSignalLink

Protected Types inherited from qi::SignalBase
using	Trigger = boost::function< void(const GenericFunctionParameters &params, MetaCallType callType)>

Protected Member Functions inherited from qi::PropertyImpl< T >
T	getImpl () const

void	setImpl (const T &v)

Protected Member Functions inherited from qi::SignalBase
void	callSubscribers (const GenericFunctionParameters &params, MetaCallType callType=MetaCallType_Auto)

void	setTriggerOverride (Trigger trigger)

void	setOnSubscribers (OnSubscribers onSubscribers)

void	callOnSubscribe (bool v)

void	createNewTrackLink (int &id, SignalLink *&trackLink)

void	disconnectTrackLink (int id)

Protected Attributes inherited from qi::PropertyImpl< T >
Getter	_getter

Setter	_setter

T	_value

Detailed Description

template<typename T>
class qi::Property< T >

Povide thread-safe access to a stored value and signal to connected callbacks when the value changed.

See Also: qi::Signal which implement a similar pattern but without storing the value.

Remarks: For more performance in a single-threaded context, consider using UnsafeProperty instead.

Definition at line 119 of file property.hpp.

Member Typedef Documentation

template<typename T>

using qi::Property< T >::Getter = typename ImplType::Getter

Definition at line 123 of file property.hpp.

template<typename T>

using qi::Property< T >::ImplType = PropertyImpl<T>

Definition at line 122 of file property.hpp.

template<typename T>

using qi::Property< T >::Setter = typename ImplType::Setter

Definition at line 124 of file property.hpp.

Constructor & Destructor Documentation

template<typename T>

qi::Property< T >::Property	(	Getter	getter = `Getter()`,
		Setter	setter = `Setter()`,
		SignalBase::OnSubscribers	onsubscribe = `SignalBase::OnSubscribers()`
	)

inline

Definition at line 128 of file property.hpp.

template<typename T>

qi::Property< T >::Property	(	AutoAnyReference	defaultValue,
		Getter	getter = `Getter()`,
		Setter	setter = `Setter()`,
		SignalBase::OnSubscribers	onsubscribe = `SignalBase::OnSubscribers()`
	)

inline

Definition at line 133 of file property.hpp.

Member Function Documentation

template<typename T >

FutureSync< T > qi::Property< T >::get ( ) const

overridevirtual

Implements qi::PropertyImpl< T >.

Definition at line 100 of file property.hxx.

template<class T >

Property< T >::ScopedLockReadOnly qi::Property< T >::getLockedReadOnly ( ) const

Returns: Acquire read-only scoped thread-safe access to the value stored in this object.

Definition at line 138 of file property.hxx.

template<class T >

Property< T >::ScopedLockReadWrite qi::Property< T >::getLockedReadWrite ( )

Returns: Acquire write-enabled scoped thread-safe access to the value stored in this object.

Definition at line 131 of file property.hxx.

template<typename T>

Property<T>& qi::Property< T >::operator= ( const T & v )

inline

Definition at line 138 of file property.hpp.

template<typename T>

FutureSync< void > qi::Property< T >::set ( const T & v )

overridevirtual

Implements qi::PropertyImpl< T >.

Definition at line 107 of file property.hxx.

template<typename T >

FutureSync< void > qi::Property< T >::setValue ( AutoAnyReference value )

overridevirtual

Implements qi::PropertyBase.

Definition at line 122 of file property.hxx.

template<typename T>

SignalBase* qi::Property< T >::signal ( )

inlineoverridevirtual

Reimplemented from qi::PropertyImpl< T >.

Definition at line 143 of file property.hpp.

template<typename T >

FutureSync< AnyValue > qi::Property< T >::value ( ) const

overridevirtual

Implements qi::PropertyBase.

Definition at line 115 of file property.hxx.

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

/home/opennao/work/master/sdk/libqi/qi/property.hpp
/home/opennao/work/master/sdk/libqi/qi/type/detail/property.hxx

Classes

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

template<typename T> class qi::Property< T >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

template<typename T>
class qi::Property< T >