IlsRpModel Class Reference

This class defines a dynamic representation model that is specific to a given dynamic view type specification. More...

#include <ilserver/rpshared.h>

Inheritance diagram for IlsRpModel:

Public Member Functions
IlsRpModelId	getId () const
	Returns the dynamic representation model identifier.
int	getNbObjModels () const
	Returns the number of dynamic representation object models contained in the representation model.
IlsRpObjModel *	getObjModel (const IlsString &svType, const IlsString &rpLabel) const
	Returns a pointer to the associated dynamic representation object model. More...
IlsRpObjModel *	getObjModel (IlsRpObjModelId) const
	Takes the identifier of a dynamic representation object model as its argument and returns a pointer to that model. More...
const IlsString &	getViewName () const
	Returns the name of the dynamic view type associated with the representation model.
Public Member Functions inherited from IlsRpObjModel
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.
Public Member Functions inherited from IlsRefCounted
	IlsRefCounted ()
	This is the default constructor of the class.
	IlsRefCounted (const IlsRefCounted &)
	This is the copy constructor of IlsRefCounted. More...
virtual	~IlsRefCounted ()
	This is the virtual destructor for IlsRefCounted.
IlsRefCount	getRefCount ()
	This member function returns the reference counter of an object.
IlsRefCounted &	operator= (const IlsRefCounted &)
	This is the assignment operator of IlsRefcounted.
IlsRefCount	refcountDecr ()
	This member function decrements the reference counter. More...
void	refcountIncr ()
	This member function increments the reference counter. More...

Additional Inherited Members
Static Public Member Functions inherited from IlsRefCounted
static void	SetMT ()
	This static member function activates the multithread-safe facility. More...

Detailed Description

This class defines a dynamic representation model that is specific to a given dynamic view type specification.

Library: mvserver
and mvcomp

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.

See also

IlsRepresentation, IlsRpObject, IlsRpObjModel.

Member Function Documentation

getObjModel() [1/2]

IlsRpObjModel* IlsRpModel::getObjModel	(	const IlsString &	svType,
		const IlsString &	rpLabel
	)		const

Returns a pointer to the associated dynamic representation object model.

Parameters

svType	name of a Server object type
rpLabel	name of a representation object in the memory image of the .ils file.

getObjModel() [2/2]

IlsRpObjModel* IlsRpModel::getObjModel

(

IlsRpObjModelId

)

const

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().