An IlsAttributeDef object defines the runtime visibility and access to an attribute (usually an entry or a derived data member) of a server object type. More...

#include <ilserver/rtmodel.h>

Inherits IlsPropertyManager, and IlsRightsDef.

Public Member Functions
IlsBoolean	declAlias (const IlsString &newName)
	Declares an alias for the attribute. More...

IlsAttributeAccessor	getAccessor () const
	Returns the accessor to the value of a non-indexed attribute.

IlsIdxAttributeAccessor	getIdxAccessor () const
	Returns the accessor to the value of an indexed attribute.

IlsIdxAttributeModifier	getIdxModifier () const
	Returns the modifier of an indexed attribute, or the null pointer if the attribute is not editable or is not indexed.

IlsIdxAttributeModifTest	getIdxModifTest () const
	Returns the function that tests the modification of an indexed attribute.

IlsIdxAttributeSubscriber	getIdxSubscriber () const
	Returns the function allowing subscribing or unsubscribing to an indexed attribute or, by default, the null pointer. More...

IlsAttributeModifier	getModifier () const
	Returns the modifier of a non indexed attribute, or the null pointer if the attribute is not editable or is indexed.

IlsAttributeModifTest	getModifTest () const
	Returns the function testing the modification of a non-indexed attribute.

const IlsString &	getName () const
	Returns the name of the attribute.

IlsAttributeSubscriber	getSubscriber () const
	Returns the function allowing subscribing or unsubscribing to a non-indexed attribute or, by default, the null pointer. More...

IlsMvDataType	getType () const
	Returns the type of the attribute value.

IlsBoolean	isDerived () const
	Returns `IlsTrue` if the attribute is a derived attribute. Otherwise, it returns `IlsFalse`.

IlsBoolean	isEntry () const
	Returns `IlsTrue` if the attribute is an entry attribute. Otherwise, it returns `IlsFalse`.

IlsBoolean	isExported () const
	Returns `IlsTrue` if this element of the server model interpreter is exported. More...

IlsBoolean	isImplicit () const
	Returns `IlsTrue` if the attribute has been implicitly declared by Rogue Wave Server. More...

IlsBoolean	isIndexed () const
	Returns `IlsTrue` if the attribute is indexed. Otherwise, it returns `IlsFalse`.

IlsBoolean	isPureAttr () const
	Returns `IlsTrue` if the attribute is a simple attribute. Otherwise, it returns `IlsFalse`.

void	setExported (IlsBoolean b)
	Use this member function to export an element of the server model interpreter or to cancel exportation. More...

Detailed Description

An IlsAttributeDef object defines the runtime visibility and access to an attribute (usually an entry or a derived data member) of a server object type.

Library: mvserver

It is implicitly created in the server model interpreter via the static initialization data declared in macros such as ILS_DERIVED_XXX(), ILS_ENTRY_XXX(), ILS_R_ATTRIBUTE_XXX(), ILS_R_INDEXED_ATTR_XXX(), ILS_RW_ATTRIBUTE_XXX(), ILS_RW_INDEXED_ATTR_XXX(), ILS_W_ENTRY_XXX().

See also: ILS_DERIVED_XXX(), ILS_ENTRY_XXX(), IlsModelInterpreter, IlsObjectType, ILS_R_ATTRIBUTE_XXX(), ILS_R_INDEXED_ATTR_XXX(), IlsRTTypes::AttributeKind, ILS_RW_ATTRIBUTE_XXX(), ILS_RW_INDEXED_ATTR_XXX(), ILS_W_ENTRY_XXX().

Member Function Documentation

◆ declAlias()

IlsBoolean IlsAttributeDef::declAlias ( const IlsString & newName )

Declares an alias for the attribute.

A new attribute named newName is created for the class that holds the attribute. The new attribute shares the same accessors and modifiers as the original.

◆ getIdxSubscriber()

IlsIdxAttributeSubscriber IlsAttributeDef::getIdxSubscriber ( ) const

Returns the function allowing subscribing or unsubscribing to an indexed attribute or, by default, the null pointer.

This function is usually declared only for derived attributes and calls the IlsDerived::incrEagerness() and IlsDerived::decrEagerness() functions.

◆ getSubscriber()

IlsAttributeSubscriber IlsAttributeDef::getSubscriber ( ) const

Returns the function allowing subscribing or unsubscribing to a non-indexed attribute or, by default, the null pointer.

This function is usually declared only for derived attributes and calls the IlsDerived::incrEagerness() and IlsDerived::decrEagerness() functions.

◆ isExported()

IlsBoolean IlsAttributeDef::isExported ( ) const

Returns IlsTrue if this element of the server model interpreter is exported.

By default, all model interpreter elements are exported.

◆ isImplicit()

IlsBoolean IlsAttributeDef::isImplicit ( ) const

Returns IlsTrue if the attribute has been implicitly declared by Rogue Wave Server.

This is the case, for instance, of the representation status attribute (rpStatus) of any server object type.

◆ setExported()

void IlsAttributeDef::setExported ( IlsBoolean b )

Use this member function to export an element of the server model interpreter or to cancel exportation.

Non-exported elements are not seen in Rogue Wave Server Studio.

Public Member Functions