IlsMvRef

Category

Dynamic view-related class (component and server side)

Inheritance Path

IlsMvRef

Description

This class is used to transmit references of representation objects between a component and a server. It is usually transparent to the user. However, in some cases, these references can be manipulated directly. For instance, when defining callbacks, it may be useful to be able to pass such references as parameters to these callbacks (see Callbacks to Member Functions in the IlsRpObject class description). Beside the API of this class, Rogue Wave Server provides a set of functions enabling manipulation of these references, including:

Getting the reference associated with a representation object: IlsRpObject::getReference;

Encapsulating the reference into an IlsMvValue:
IlsMvValue::IlsMvValue(IlsMvRef);

Converting an IlsMvValue into a reference:
operator IlsMvValue::IlsMvRef;

Getting the Server object associated with a given reference:
IlsViewed* IlsMvComponentItf::getSvObject(const IlsMvRef&);

Libraries

Header File

#include <ilserver/mvvalue.h>

Synopsis

class IlsMvRef{

public:

IlsMvRef(IlsRepresentationId rpId = 0,

IlsRpObjectId objId = 0,

IlsRpObjModelId objModelId = 0);

IlsRepresentationId getRepresentationId()const;

IlsRpObjectId getObjectId()const;

IlsRpObjModelId getObjModelId()const;

IlsBoolean isNull()const;

friend IlsBoolean operator ==(IlsMvRef& r1,IlsMvRef& r2);

};

Constructor

IlsMvRef(IlsRepresentationId rpId = 0,

IlsRpObjectId objId = 0,

IlsRpObjModelId objModelId = 0);

To get the reference of a representation object, you would normally use the function IlsRpObject::getReference.

However, this constructor allows you to construct a reference by passing the following three arguments:

rpId is the identifier of the representation containing the object ;

objId is the identifier of the object in its representation ;

objModelId is the identifier of the representation object model.

Member Functions

IlsRepresentationId getRepresentationId()const;

This member function returns the identifier of the representation containing the object.

IlsRpObjectId getObjectId()const;

This member function returns the identifier of the object in its representation.

IlsRpObjModelId getObjModelId()const;

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

IlsBoolean isNull()const;

This member function returns IlsTrue if the values of the three identifies above are null. Otherwise, it returns IlsFalse.

Operators

friend IlsBoolean operator ==(IlsMvRef& r1,IlsMvRef& r2);

This comparison operator returns IlsTrue if the three identifier values for r1 are equal to those for r2.