kanzi::DataObject Class Reference

DataObject is the base class for data. More...

#include <kanzi/core.ui/data/data_object.hpp>

Inheritance diagram for kanzi::DataObject:

Public Types
enum	Type {   Object, Integer, Real, Bool,   String, Enum, List }
	Type enumerations for different data object types. More...
typedef vector< DataObjectSharedPtr >	ChildContainer
	Iterators for children. More...
typedef ChildContainer::const_iterator	ChildConstIterator
typedef ChildContainer::const_reverse_iterator	ChildConstReverseIterator
Public Types inherited from kanzi::DataContext
typedef function< void()>	ModifiedFunction
	Callback function type for change subscriptions. More...
typedef shared_ptr< void >	ModifiedSubscriptionToken
	Token type that can be used to identify the change subscription. More...
Public Types inherited from kanzi::PropertyObject
typedef intrusive_ptr< AbstractPropertyTypeDescriptor::PropertyStorage >	PropertyStoragePtr
typedef vector< PropertyStoragePtr >	PropertyStorageContainer
typedef PropertyStorageContainer::iterator	PropertyStorageIterator
typedef PropertyStorageContainer::const_iterator	PropertyStorageConstIterator
typedef PropertyStorageContainer::reverse_iterator	PropertyStorageReverseIterator

Public Member Functions
	DataObject (Domain *domain, string_view name)
	Standard constructor. More...
string	getName () const
	Allows to retrieve the name of the object. More...
void	setName (string_view value)
	Sets the name of the object. More...
virtual Type	getType () const
	Allows to retrieve the type of the object. More...
size_t	getChildCount () const
	Retrieves the count of child objects in this data object. More...
DataObjectSharedPtr	getChild (size_t index) const
	Retrieves a child object in given index. More...
size_t	getChildIndex (const DataObject &child) const
	Retrieves the index of a child data object. More...
bool	hasChild (const DataObject &child) const
	Checks whether or not the child exists. More...
void	addChild (const DataObjectSharedPtr &child)
	Adds data object as child of this object. More...
void	insertChild (size_t index, const DataObjectSharedPtr &child)
	Inserts data object as child of this object, allows to specify index of the object. More...
void	removeChild (const DataObject &child)
	Removes a child object from list of childs. More...
void	removeChild (size_t index)
	Removes a child object in given index. More...
void	removeAllChildren ()
	Removes all children. More...
ChildConstIterator	beginChildren () const
	Returns iterator to start of the child container. More...
ChildConstIterator	endChildren () const
	Returns iterator in the end of the child container. More...
DataObjectSharedPtr	findChild (string_view name)
	Tries to find a child with given name. More...
virtual DataObjectSharedPtr	getData () KZ_OVERRIDE
	DataContext interface. More...
virtual DataContextSharedPtr	lookupDataContext (string_view relativePath) KZ_OVERRIDE
	Performs object look-up by path. More...
Public Member Functions inherited from kanzi::DataContext
ModifiedSubscriptionToken	addModifiedNotificationHandler (ModifiedFunction callback)
	Allows to subscribe to modifications in this data context. More...
void	removeModifiedNotificationHandler (ModifiedSubscriptionToken token)
	Allows to unsubscribe from modifications in this data context. More...
void	notifyModified ()
	Triggers modification procedure in this data context, which invokes the subscriptions. More...
template<typename Type >
shared_ptr< Type >	lookupDataContextOfType (string_view relativePath)
ResourceSharedPtr	getDataContext () const
	Gets the value of DataContextProperty. More...
void	setDataContext (ResourceSharedPtr value)
	Sets the value of DataContextProperty. More...
ResourceSharedPtr	getItemsSource () const
	Gets the value of ItemsSourceProperty. More...
void	setItemsSource (ResourceSharedPtr value)
	Sets the value of ItemsSourceProperty. More...
Public Member Functions inherited from kanzi::Resource
KzcMemoryManager *	getMemoryManager () const
	Resource (Domain *domain, string_view name)
virtual	~Resource ()
virtual void	loadFromKZB (const ResourceLoaderThreadContext *threadContext, KzcInputStream *inputStream, const KzuBinaryFileInfo *file)
	Function for loading the resource from .KZB. More...
virtual void	unloadOverride ()
	Unload function for resource. Releases all CPU memory taken by the resource except the resource loader. More...
virtual unsigned int	getCPUMemoryUsage () const
	Function for getting the memory usage of a resource. More...
void	setKZB (const KzuBinaryDirectory *binaryDirectory, string_view path)
	Set the binary directory and path of the resource. More...
const string &	getName () const
	Gets the resource name. More...
const string &	getUrl () const
	Gets the resource URL. More...
void	setUrl (string_view url)
	Sets the resource URL. More...
void	setNotLoaded ()
bool	isFromKZB () const
void	reload ()
void	reloadFromKzb (KzcInputStream *inputStream, const KzuBinaryFileInfo *file)
void	reloadFromKzb (KzbFile &kzbFile, ReadOnlyMemoryFile &file, KzbMemoryParser &parser)
void	reloadFromFile (string_view filePath)
void	load ()
void	unload ()
bool	isLoaded () const
void	kzuResourceLoad_private (const ResourceLoaderThreadContext *threadContext)
	Private function for kzuResourceLoad() with specified thread context. More...
void	kzuResourceFinishLoading_private (const ResourceLoaderThreadContext *threadContext)
	Private function for finishing the loading of the resource. More...
bool	isKeepAlive () const
	Tells if the resource has keep alive flag set. More...
void	setKeepAlive (bool keepAlive)
	Sets the keep alive flag. More...
Public Member Functions inherited from kanzi::Object
	Object (Domain *domain)
virtual	~Object ()
Domain *	getDomain () const
	Returns the domain the object belongs to. More...
KzuTaskScheduler *	getTaskScheduler () const
	Returns the task scheduler of the object. More...
KzuMessageDispatcher *	getMessageDispatcher () const
	Returns the message dispatcher of the object. More...
ResourceManager *	getResourceManager () const
	Returns the resource manager of the object. More...
virtual const Metaclass *	getDynamicMetaclass () const KZ_OVERRIDE
	Returns the metaclass of the dynamic type of the object. More...
AppliedStyleEntrySharedPtr	applyObjectStyle (kanzi::StyleSharedPtr style)
	Applies a style to an object. More...
void	unapplyObjectStyle (AppliedStyleEntrySharedPtr appliedStyleEntry)
void	applyObjectStyles ()
	Apply all styles for an object node. More...
void	unapplyObjectStyles ()
	Unapplies and removes all applied styles. More...
Public Member Functions inherited from kanzi::MetaObject
virtual	~MetaObject ()
bool	isTypeOf (const Metaclass *objectType) const
	Determines if the type of this object is the given type or derived from it. More...
Public Member Functions inherited from kanzi::PropertyObject
	PropertyObject ()
virtual	~PropertyObject ()
template<typename DataType >
void	setProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Traits::ParameterType value)
	Sets the local value of a property. More...
void	removeKzbProperties ()
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getProperty (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property. More...
template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType >	getOptionalProperty (const PropertyType< DataType > &propertyType) const
	Evaluates the property value in the same way as the overload above but does not default to the value in property metadata if there are no inputs to the property value. More...
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getPropertyBase (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property disregarding modifiers. More...
template<typename DataType >
void	setAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::Traits::ParameterType value)
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getAbstractProperty (AbstractPropertyType abstractPropertyType) const
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getAbstractPropertyBase (AbstractPropertyType abstractPropertyType) const
template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType >	getOptionalAbstractProperty (AbstractPropertyType abstractPropertyType) const
void	setPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)
bool	isPropertyFlagSet (AbstractPropertyType propertyType, uint32_t flag) const
void	clearPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)
bool	hasValue (AbstractPropertyType propertyType) const
	Evaluates whether there are any inputs into the property value. More...
bool	hasBaseValue (AbstractPropertyType propertyType) const
	Evaluates whether there are any inputs into the property value, disregarding modifiers. More...
bool	hasLocalValue (AbstractPropertyType propertyType) const
	Evaluates whether there is a local value set for the property. More...
bool	hasNonClassValue (AbstractPropertyType propertyType) const
	Evaluates whether there is a value of any precedence higher than class default value set for the property. More...
void	removeLocalValue (AbstractPropertyType propertyType)
	Removes the local value associated with the property. More...
void	copyLocalValue (const PropertyObject &other, AbstractPropertyType propertyType)
	Copies local value of single property from another object. More...
void	copyLocalValues (const PropertyObject &other)
	Copies all local values from another object. More...
virtual void	onPropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason)
	Virtual function to handle property change notifications. More...
template<typename DataType >
void	addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, PropertyValuePrecedence precedence, void *owner)
template<typename DataType >
void	removePropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, void *owner)
template<typename DataType >
void	addPropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
template<typename DataType >
void	removePropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
void	validatePropertyModifiers (AbstractPropertyType propertyType)
template<typename DataType >
void	addPropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)
template<typename DataType >
void	removePropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)
template<typename DataType >
size_t	getPropertyNotificationHandlerCount (const PropertyType< DataType > &propertyType)
	Gets number of current notification handlers for given property type. More...

Additional Inherited Members
Static Public Member Functions inherited from kanzi::DataContext
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
Static Public Member Functions inherited from kanzi::Object
static const Metaclass *	getStaticMetaclass ()
	Returns the metaclass of Object class. More...
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
	Default implementation that returns empty editor info. More...
Static Public Member Functions inherited from kanzi::MetaObject
static const Metaclass *	getStaticMetaclass ()
	Returns the metaclass of Object class. More...
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
	Default implementation that returns empty editor info. More...
Static Public Attributes inherited from kanzi::DataContext
static PropertyType< ResourceSharedPtr >	DataContextProperty
	DataContext property. More...
static PropertyType< ResourceSharedPtr >	ItemsSourceProperty
	ItemsSource property. More...
Protected Types inherited from kanzi::DataContext
typedef shared_ptr< ModifiedSubscription >	ModifiedSubscriptionSharedPtr
	Subscription shared pointer type. More...
typedef vector< ModifiedSubscriptionSharedPtr >	ModifiedSubscriptionContainer
	Container for subscriptions. More...
Protected Types inherited from kanzi::Object
typedef vector< AppliedStyleEntrySharedPtr >	AppliedStyleContainer
	Applied style container. More...
Protected Member Functions inherited from kanzi::DataContext
	DataContext (Domain *domain, string_view name)
	Protected standard constructor. More...
Protected Member Functions inherited from kanzi::Resource
virtual void	reloadOverride ()
virtual void	reloadFromKzbOverride (KzcInputStream *inputStream, const KzuBinaryFileInfo *file)
virtual void	reloadFromKzbOverride (KzbFile &kzbFile, ReadOnlyMemoryFile &file, KzbMemoryParser &parser)
virtual void	reloadFromFileOverride (string_view filePath)
virtual unsigned int	getCPUMemoryUsageOverride () const
Protected Member Functions inherited from kanzi::Object
void	initialize ()
void	onCopy (const Object &other)
Protected Member Functions inherited from kanzi::MetaObject
	MetaObject ()
void	initialize ()
Protected Member Functions inherited from kanzi::PropertyObject
void	addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, PropertyValuePrecedence precedence, void *owner)
void	removePropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, void *owner)
AbstractPropertyTypeDescriptor::ValueSourceEntry *	getTopValueSourceEntry (AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage) const
AbstractPropertyTypeDescriptor::ValueSourceEntry *	getTopValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor) const
AbstractPropertyTypeDescriptor::ValueSource *	getTopValueSource (AbstractPropertyTypeDescriptor &descriptor) const
AbstractPropertyTypeDescriptor::ValueSource *	getFinalValueSource (AbstractPropertyTypeDescriptor &descriptor) const
AbstractPropertyTypeDescriptor::ValueSource *	getNonClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const
AbstractPropertyTypeDescriptor::ValueSource *	getClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const
AbstractPropertyTypeDescriptor::ValueSourceEntry *	findLocalValueSourceEntry (AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
AbstractPropertyTypeDescriptor::ValueSourceEntry *	constructLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
AbstractPropertyTypeDescriptor::ValueSourceEntry *	acquireLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor)
AbstractPropertyTypeDescriptor::PropertyStorage *	findPropertyStorage (AbstractPropertyTypeDescriptor &descriptor) const
PropertyStoragePtr	findPropertyStoragePtr (AbstractPropertyTypeDescriptor &descriptor) const
	Gets property storage intrusive pointer that can be used to hold a reference until end of operation. More...
PropertyStoragePtr	constructPropertyStorage (AbstractPropertyTypeDescriptor &descriptor)
PropertyStoragePtr	acquirePropertyStorage (AbstractPropertyTypeDescriptor &descriptor)
AbstractPropertyTypeDescriptor::ModifierStorage *	acquireModifierStorage (AbstractPropertyTypeDescriptor &descriptor)
AbstractPropertyTypeDescriptor::ModifierStorage *	findModifierStorage (AbstractPropertyTypeDescriptor &descriptor)
AbstractPropertyTypeDescriptor::NotificationStorage *	acquireNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)
AbstractPropertyTypeDescriptor::NotificationStorage *	findNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)
AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByUnqualifiedNameAndDataType (string_view unqualifiedName, PropertyDataType dataType)
void	validatePropertyModifiersAndNotifyHandlers (PropertyStoragePtr &propertyStorage)
void	copyLocalValue (const AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
	Copy local value from property storage. More...
PropertyStorageContainer::iterator	beginPropertyStorage ()
PropertyStorageContainer::iterator	endPropertyStorage ()
virtual void	notifyPropertyHandlers (PropertyStoragePtr &propertyStorage, PropertyNotificationReason reason)
void	onCopy (const PropertyObject &other)
Protected Attributes inherited from kanzi::DataContext
ModifiedSubscriptionContainer	m_subscriptions
	Subscriptions to data context being modified. More...
unsigned int	m_notificationPassGuard
	Notification pass guard integer for triggering removal at end. More...
Protected Attributes inherited from kanzi::Object
AppliedStyleContainer	m_appliedStyles
	Listing of applied styles applied to this object. More...

Detailed Description

DataObject is the base class for data.

All data within the data source is described as a tree of data objects. The base class provides support for the hierarchy as the derived classes provide support for different value types.

Member Typedef Documentation

typedef vector<DataObjectSharedPtr> kanzi::DataObject::ChildContainer

Iterators for children.

typedef ChildContainer::const_iterator kanzi::DataObject::ChildConstIterator

typedef ChildContainer::const_reverse_iterator kanzi::DataObject::ChildConstReverseIterator

Member Enumeration Documentation

enum kanzi::DataObject::Type

Type enumerations for different data object types.

Enumerator
Object
Integer
Real
Bool
String
Enum
List

Constructor & Destructor Documentation

kanzi::DataObject::DataObject ( Domain *  domain, string_view  name  )

explicit

Standard constructor.

Parameters

name	Name of the data object.

Member Function Documentation

string kanzi::DataObject::getName

(

)

const

Allows to retrieve the name of the object.

Returns

Returns the name of the object.

void kanzi::DataObject::setName

(

string_view

value

)

Sets the name of the object.

Parameters

value

New name that is assigned to object.

virtual Type kanzi::DataObject::getType ( ) const

inlinevirtual

Allows to retrieve the type of the object.

Returns

Type enumeration of the object.

Reimplemented in kanzi::DataObjectTyped< DataType, DataTypeEnum >, kanzi::DataObjectEnumBase, and kanzi::DataObjectList.

size_t kanzi::DataObject::getChildCount

(

)

const

Retrieves the count of child objects in this data object.

Returns

Child object count.

DataObjectSharedPtr kanzi::DataObject::getChild

(

size_t

index

)

const

Retrieves a child object in given index.

Returns

Child data object in given index.

size_t kanzi::DataObject::getChildIndex

(

const DataObject &

child

)

const

Retrieves the index of a child data object.

Returns

Index of the item in question, throws exception if there is no such child.

bool kanzi::DataObject::hasChild

(

const DataObject &

child

)

const

Checks whether or not the child exists.

Returns

true if there is such child, otherwise false.

void kanzi::DataObject::addChild

(

const DataObjectSharedPtr &

child

)

Adds data object as child of this object.

Parameters

child

Child object to add.

void kanzi::DataObject::insertChild	(	size_t	index,
		const DataObjectSharedPtr &	child
	)

Inserts data object as child of this object, allows to specify index of the object.

Parameters

index	Index where to add given object.
child	Child object to add.

void kanzi::DataObject::removeChild

(

const DataObject &

child

)

Removes a child object from list of childs.

Parameters

child

Child object to remove.

void kanzi::DataObject::removeChild

(

size_t

index

)

Removes a child object in given index.

Parameters

Index

of the child object to remove.

void kanzi::DataObject::removeAllChildren

(

)

Removes all children.

ChildConstIterator kanzi::DataObject::beginChildren

(

)

const

Returns iterator to start of the child container.

Returns

Iterator at the beginning of the container.

ChildConstIterator kanzi::DataObject::endChildren

(

)

const

Returns iterator in the end of the child container.

Returns

Iterator in the end of the container.

DataObjectSharedPtr kanzi::DataObject::findChild

(

string_view

name

)

Tries to find a child with given name.

Returns

Child object that was found, or empty pointer if there is no such child.

virtual DataObjectSharedPtr kanzi::DataObject::getData ( )

virtual

DataContext interface.

Implements kanzi::DataContext.

virtual DataContextSharedPtr kanzi::DataObject::lookupDataContext ( string_view  relativePath )

virtual

Performs object look-up by path.

Parameters

relativePath

Path of the object where to look at, separated by '.'.

Returns

Data object that was found, or empty pointer if there was no such object.

Implements kanzi::DataContext.

---

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

• kanzi/core.ui/data/data_object.hpp