IlvGroupUserAccessor Class Reference

References all the subattributes of a group that have the same name. More...

#include <ilviews/protos/useracc.h>

Inheritance diagram for IlvGroupUserAccessor:

List of all members.

Public Member Functions
	IlvGroupUserAccessor (const char *name, IlvValueTypeClass *type)
	Creates a group accessor of name name and type type.
Protected Member Functions
virtual IlBoolean	changeValue (IlvAccessorHolder *object, const IlvValue &val)
	Called by the method IlvAccessible::changeValue for each IlvAccessor attached to the IlvAccessorHolder.
virtual IlUInt	compareValues (const IlvAccessorHolder *object, const IlvAccessible *ref, IlvValue *values, IlUShort count, IlvValueArray &diffs) const
	Compares the values in ref and object and returns the differing values.
virtual IlvValue &	queryValue (const IlvAccessorHolder *object, IlvValue &val) const
	Called by the method IlvAccessible::queryValue for each IlvAccessor attached to the IlvAccessorHolder.

---

Detailed Description

References all the subattributes of a group that have the same name.

Library: ilvproto

IlvGroupUserAccessor is used to change and/or query a value for all the nodes in a group. It defines a global value that is dispatched to all the nodes in the group. In a programming language, this accessor would be similar to a pointer to a collection of attributes of the same name.

See also:

IlvGroupAccessor.

---

Constructor & Destructor Documentation

IlvGroupUserAccessor::IlvGroupUserAccessor	(	const char *	name,
		IlvValueTypeClass *	type
	)

Creates a group accessor of name name and type type.

When the value specified by name is changed for a group, the same value change will be forwarded to all the nodes of the group. When the value is queried for a group, it will be queried from all the nodes of the group, and the last value will be returned.

---

Member Function Documentation

virtual IlUInt IlvGroupUserAccessor::compareValues	(	const IlvAccessorHolder *	object,
		const IlvAccessible *	ref,
		IlvValue *	values,
		IlUShort	count,
		IlvValueArray &	diffs
	)			const [protected, virtual]

Compares the values in ref and object and returns the differing values.

Compares the objects object and ref for the values specified by the values array of length count. The differences are stored in the diffs array, and the method returns the number of differences. The default implementation simply calls the IlvAccessible::compareValues method, which will query the values for the two objects and compare them one by one. Subclasses may compare values more cleverly by grouping differences: for example, the IlvGroupAccessor subclass detects when all nodes of a group differ homogeneously and reports only one difference for the whole group.

See also:

IlvAccessible::compareValues, IlvProtoInstance, IlvPrototype.

Reimplemented from IlvUserAccessor.