IlsRpObjModel

Category

Dynamic view-related class (component side)

Inheritance Path

IlsRpObjModel

Description

This class defines the dynamic model of a representation object. Each instance of the class IlsRpObjModel defines in memory the specification of a mapping between a class in the server object model and a representation object type. It is included into the dynamic representation model (IlsRpModel) associated with the dynamic view type specification.

In the following view specification, for example, the class Line is mapped to the representation inputRow and ouputRow, which are both of type IlsSwRow.
At runtime, these mapping specifications will be defined by two instances of the class IlsRpObjModel, which will be grouped together in the representation model that is associated with the NodePanel view specification.

Example

view NodePanel:

...

subscribe Line:

represent IlsSwRow inputRow:

Ref<IlsSwTable> table=output->inputPanel;

string column[1]=name;

represent IlsSwRow outputRow:

Ref<IlsSwTable> table=input->outputPanel;

string column[1]=name;

...

Libraries

Header File

#include <ilserver/rpshared.h>

Synopsis

class IlsRpObjModel{

public:

IlsRpModel* getRpModel()const;

IlsString getLabel()const;

IlsString getRpTypeName()const;

IlsString getSvTypeName()const;

int getNbAttrs()const;

IlsRpAttrModel* getAttrModel(IlsRpAttributeId)const;

IlsRpAttributeId getAttrId(IlsString)const;

IlsRpAttributeId getAttrId(IlsString,int index)const;

IlsRpObjModelId getId()const;

};

Member Functions

IlsRpModel* getRpModel()const;

This member function returns a pointer to the dynamic representation model that contains the dynamic representation object model.

IlsString getLabel()const;

This member function returns the label of the dynamic representation object model.

IlsString getRpTypeName()const;

This member function returns a character string that specifies the type of any representation object associated with the dynamic representation object model.

IlsString getSvTypeName()const;

This member function returns a character string that specifies the type of the Server object associated with the dynamic representation object model.

int getNbAttrs()const;

This member function returns the number of attributes in the dynamic representation object model.

IlsRpAttrModel* getAttrModel(IlsRpAttributeId)const;

This member function returns a pointer to the nth attribute in the dynamic representation object model. It returns 0 if this attribute does not exist.

IlsRpAttributeId getAttrId(IlsString)const;

This member function takes the name of an attribute as its parameter and returns its identifier. It returns -1 if this attribute does not exist or is indexed.

IlsRpAttributeId getAttrId(IlsString,int index)const;

This member function takes the name and the index of an attribute and returns its identifier. It returns -1 if this attribute does not exist or is not indexed.

IlsRpObjModelId getId()const;

This member function returns the identifier of the dynamic representation object model.