IlsRpModel

Category

Dynamic view-related class (component side)

Inheritance Path

IlsRpObjModel and IlsRefCounted
➥ IlsRpModel

Description

This class defines a dynamic representation model that is specific to a given dynamic view type specification. An instance of IlsRpModel contains all the representation object models that belong to the view specification (see IlsRpObjModel). It is created when a dynamic view type specification is loaded in the server and is transferred to each application component that requests an instance of this dynamic view type to be opened. When a dynamic view type specification is modified, the dynamic representation model is automatically updated on the component side. The updated representation model is the one that will be used for subsequent instances of the dynamic view type.

Libraries

Header File

#include <ilserver/rpshared.h>

Synopsis

class IlsRpModel:public IlsRpObjModel, public IlsRefCounted{

public:

const IlsString& getViewName();

int getNbObjModels()const;

IlsRpObjModel* getObjModel(IlsRpObjModelId id)const;

IlsRpObjModel* getObjModel(IlsString svType,

IlsString rpLabel)const;

IlsRpModelId getId() const;

};

Member Functions

const IlsString& getViewName();

This member function returns the name of the dynamic view type associated with the representation model.

int getNbObjModels()const;

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

IlsRpObjModel* getObjModel(IlsRpObjModelId id)const;

This member function takes the identifier of a dynamic representation object model as its argument and returns a pointer to that model. It returns 0 if the identifier is less than 1 or greater than the value returned by getNbObjModels.

IlsRpObjModel* getObjModel(IlsString svType,

IlsString rpLabel)const;

This member function takes the following parameters:

svType is the name of a Server object type;

rpLabel is the name of a representation object in the memory image of the .ils file.

The function = returns a pointer to the associated dynamic representation object model.

IlsRpModelId getId() const;

This member function returns the dynamic representation model identifier.