IlsMvRef Class Reference

This class is used to transmit references of representation objects between a component and a server. More...

#include <ilserver/mvvalue.h>

Public Member Functions
	IlsMvRef (IlsRepresentationId rpId, IlsRpObjectId objId, IlsRpObjModelId objModelId)
	Constructs an representation object reference. More...
IlsRpObjectId	getObjectId () const
	Returns the identifier of the object in its representation.
IlsRpObjModelId	getObjModelId () const
	Returns the identifier of the representation object model.
IlsRepresentationId	getRepresentationId () const
	Returns the identifier of the representation containing the object.
IlsBoolean	isNull () const
	Returns IlsTrue if the values of the three identifiers values are null. Otherwise, it returns IlsFalse.

Friends
IlsBoolean	operator== (const IlsMvRef &r1, const IlsMvRef &r2)
	This comparison operator returns IlsTrue if the three identifier values for r1 are equal to those for r2.

Detailed Description

This class is used to transmit references of representation objects between a component and a server.

Library: mvserver
and mvcomp

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: IlsMvValue::operator IlsMvRef() ;
• Getting the Server object associated with a given reference: IlsViewed* IlsMvComponentItf::getSvObject(const IlsMvRef&);

See also

IlsMvValue, IlsRepresentation, IlsRpModel, IlsRpObject.

Constructor & Destructor Documentation

IlsMvRef()

IlsMvRef::IlsMvRef	(	IlsRepresentationId	rpId,
		IlsRpObjectId	objId,
		IlsRpObjModelId	objModelId
	)

Constructs an representation object reference.

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.

Parameters

rpId	identifier of the representation containing the object
objId	identifier of the object in its representation
objModelId	identifier of the representation object model