IlsRpAttrModel

Category

Dynamic view-related class (component side)

Inheritance Path

IlsRpAttrModel

Description

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

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.

Libraries

Header File

#include <ilserver/rpshared.h>

Synopsis

class IlsRpAttrModel{

public:

IlsMvDataType& getDataType() const;

IlsString getLabel() const;

IlsRpAttributeId getId() const;

IlsBoolean isIndexed()const;

int getIndex()const;

IlsBoolean isEditable(IlsEditRights::Value

right=IlsEditRights::DEFAULT_EDIT) const;

};

Member Functions

IlsMvDataType& getDataType() const;

This member function returns the runtime type of the attribute.

IlsString getLabel() const;

This member function returns the attribute label.

IlsRpAttributeId getId() const;

This member function 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.

IlsBoolean isIndexed()const;

This member function returns IlsTrue if the attribute is indexed. Otherwise, it returns IlsFalse.

int getIndex()const;

This member function returns the index value of the attribute. It returns -1 if the attribute is not indexed.

IlsBoolean isEditable(IlsEditRights::Value

right=IlsEditRights::DEFAULT_EDIT) const;

This member function returns IlsTrue if the attribute has the editing rights specified by the variable right.