IlsRpAttrModel Class Reference

This class defines an attribute of a dynamic representation object model (see IlsRpObjModel). More...

#include <ilserver/rpshared.h>

Public Member Functions
const IlsMvDataType &	getDataType () const
	Returns the runtime type of the attribute.
IlsRpAttributeId	getId () const
	Returns the attribute identifier. More...
int	getIndex () const
	Returns the index value of the attribute. More...
const IlsString &	getLabel () const
	Returns the attribute label.
IlsBoolean	isEditable (IlsEditRights::Value v=IlsEditRights::DEFAULT_EDIT) const
	Returns IlsTrue if the attribute has the editing rights specified by the parameter v.
IlsBoolean	isIndexed () const
	Returns IlsTrue if the attribute is indexed. Otherwise, it returns IlsFalse.

Friends
class	IlsRpObjModel

Detailed Description

This class defines an attribute of a dynamic representation object model (see IlsRpObjModel).

Library: mvserver
and mvcomp

In the following view specification, table and column[1] constitute two attributes of the dynamic representation object model, inputRow.

view NodePanel:
...
subscribe Line:
    represent IlsSwRow inputRow:
        Ref<IlsSwTable> table=...;
        string column[1]=...;
...

At runtime, both these attributes are defined by an instance of the class IlsRpAttrModel. An object of the type IlsRpAttrModel specifies the type of the attribute, its identifier, and its write permissions. A runtime attribute does not necessarily have to be a data member of the representation object type. The attribute of a representation object is associated with an editing function via the macros ILS_RP_ATTR_XXX() and ILS_RP_INDEXED_ATTR_XXX().

See also

IlsEditRights::Value, ILS_RP_ATTR_XXX(), ILS_RP_DEFAULT_XXX(), ILS_RP_INDEXED_DEFAULT_XXX(), ILS_RP_INDEXED_ATTR_XXX(), IlsRpObject, IlsRpObjModel.

Member Function Documentation

getId()

IlsRpAttributeId IlsRpAttrModel::getId

(

)

const

Returns the attribute identifier.

This identifier is used by the Rogue Wave Server internal protocol. It is also used to identify the attribute to be edited in the callback functions of the IlsRpObject class. For more details, see Callbacks to Member Functions.

getIndex()

int IlsRpAttrModel::getIndex

(

)

const

Returns the index value of the attribute.

It returns -1 if the attribute is not indexed.