IlsRpObjModel Class Reference

This class defines the dynamic model of a representation object. More...

#include <ilserver/rpshared.h>

Inheritance diagram for IlsRpObjModel:

Public Member Functions
IlsRpAttributeId	getAttrId (const IlsString &) const
	Returns the identifier of an attribute from its name. More...
IlsRpAttributeId	getAttrId (const IlsString &, int index) const
	Returns the identifier of an indexed attribute from its name and index. More...
IlsRpAttrModel *	getAttrModel (IlsRpAttributeId n) const
	Returns a pointer to the nth attribute in the dynamic representation object model. More...
IlsRpObjModelId	getId () const
	Returns the identifier of the dynamic representation object model.
const IlsString &	getLabel () const
	This member function returns the label of the dynamic representation object model.
int	getNbAttrs () const
	Returns the number of attributes in the dynamic representation object model.
IlsRpModel *	getRpModel () const
	Returns a pointer to the dynamic representation model that contains the dynamic representation object model.
const IlsString &	getRpTypeName () const
	Returns a character string that specifies the type of any representation object associated with the dynamic representation object model.
const IlsString &	getSvTypeName () const
	Returns a character string that specifies the type of the Server object associated with the dynamic representation object model.

Friends
class	IlsRpModel

Detailed Description

This class defines the dynamic model of a representation object.

Library: mvserver
and mvcomp

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 representations 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.

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; 
... 

See also

IlsRpModel, IlsRpObject.

Member Function Documentation

getAttrId() [1/2]

IlsRpAttributeId IlsRpObjModel::getAttrId

(

const IlsString &

)

const

Returns the identifier of an attribute from its name.

It returns -1 if this attribute does not exist or is indexed.

getAttrId() [2/2]

IlsRpAttributeId IlsRpObjModel::getAttrId	(	const IlsString &	,
		int	index
	)		const

Returns the identifier of an indexed attribute from its name and index.

It returns -1 if this attribute does not exist or is not indexed.

getAttrModel()

IlsRpAttrModel* IlsRpObjModel::getAttrModel

(

IlsRpAttributeId

n

)

const

Returns a pointer to the nth attribute in the dynamic representation object model.

It returns 0 if this attribute does not exist.