kanzi::AbstractPropertyTypeDescriptor::ValueSourceOwner Class Reference

Value source owner abstracts the owner pointer of a value source. More...

#include <kanzi/core/property/abstract_property_type_descriptor.hpp>

Inheritance diagram for kanzi::AbstractPropertyTypeDescriptor::ValueSourceOwner:

Public Member Functions
bool	isReuseAllowed () const
	Indicates whether reuse of the value source for other property actions is allowed. More...
bool	isValid () const
	Indicates whether the value source is valid. More...
virtual bool	matches (void *owner) const =0
	Indicates whether the owner of a value source matches the given owner pointer. More...
void	setValid (bool valid)
	Sets the validity status of the value source. More...
	ValueSourceOwner (bool valid, bool reuseAllowed)
	Constructor. More...
virtual	~ValueSourceOwner ()
	Virtual destructor to be implemented by inheriting classes. More...

Protected Attributes
bool	m_reuseAllowed
	Is reuse of this value source allowed? Should be set to true to allow reuse of the value source. More...
bool	m_valid
	Validity flag for value source. More...

Detailed Description

Value source owner abstracts the owner pointer of a value source.

All value sources except local values must specify an owner pointer that can identify the value source. Inheriting classes can implement specific actions for value source creation or destruction.

Constructor & Destructor Documentation

ValueSourceOwner()

kanzi::AbstractPropertyTypeDescriptor::ValueSourceOwner::ValueSourceOwner ( bool  valid, bool  reuseAllowed  )

inlineexplicit

Constructor.

Parameters

valid	Validity flag.
reuseAllowed	Set to true to enable reuse by other value source operations such as setProperty.

~ValueSourceOwner()

virtual kanzi::AbstractPropertyTypeDescriptor::ValueSourceOwner::~ValueSourceOwner ( )

inlinevirtual

Virtual destructor to be implemented by inheriting classes.

Member Function Documentation

matches()

virtual bool kanzi::AbstractPropertyTypeDescriptor::ValueSourceOwner::matches ( void *  owner ) const

pure virtual

Indicates whether the owner of a value source matches the given owner pointer.

Parameters

owner

Owner pointer.

Returns

If the owner matches, true, otherwise false.

Implemented in kanzi::AbstractPropertyTypeDescriptor::RawValueSourceOwner, and kanzi::BindingValueSourceOwner.

isReuseAllowed()

bool kanzi::AbstractPropertyTypeDescriptor::ValueSourceOwner::isReuseAllowed ( ) const

inline

Indicates whether reuse of the value source for other property actions is allowed.

Default implementation always returns true.

Returns

True if other actions, such as setting a local property are allowed to reuse the value source.

isValid()

bool kanzi::AbstractPropertyTypeDescriptor::ValueSourceOwner::isValid ( ) const

inline

Indicates whether the value source is valid.

Returns

True if the value source is valid, false otherwise.

setValid()

void kanzi::AbstractPropertyTypeDescriptor::ValueSourceOwner::setValid ( bool  valid )

inline

Sets the validity status of the value source.

If value source is initialized as invalid, it should be set to true when first written.

Parameters

valid

New validity flag.

Member Data Documentation

m_valid

bool kanzi::AbstractPropertyTypeDescriptor::ValueSourceOwner::m_valid

protected

Validity flag for value source.

Should be set to true by anyone writing to the value source.

m_reuseAllowed

bool kanzi::AbstractPropertyTypeDescriptor::ValueSourceOwner::m_reuseAllowed

protected

Is reuse of this value source allowed? Should be set to true to allow reuse of the value source.

---

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

• kanzi/core/property/abstract_property_type_descriptor.hpp