mvvalue.h File Reference

#include <ilserver/ilbcomp.h>
#include <ilserver/boolean.h>
#include <ilserver/sstring.h>
#include <ilserver/ilbtypes.h>
#include <ilserver/downcast.h>
#include <ilserver/thash.h>
#include <ilserver/iostream.h>
#include <ilserver/ilthread.h>

Classes
class	IlsMvDataType
	Defines the type of attributes that is attached to a representation object model. More...
class	IlsMvFile
	This class is used to transmit the name and contents of a file from the server to the component. More...
class	IlsMvRef
	This class is used to transmit references of representation objects between a component and a server. More...
class	IlsMvUserType
	This class is the base class for all user-defined types. More...
class	IlsMvValue
	This class encapsulates the value of the runtime attributes attached to representation objects. More...
class	IlsSvRef
	This class encapsulates a pointer to a server object along with its type, in a non-typed way. More...

Macros
#define	ILS_USERTYPE_DECL(typeNm, parentNm)
	This macro and ILS_USERTYPE_DEF() are used to implement a user-defined type deriving from IlsMvUserType. More...
#define	ILS_USERTYPE_DEF(typeNm, parentNm)
	This macro and ILS_USERTYPE_DECL() are used to implement a user-defined type deriving from IlsMvUserType. More...

Typedefs
typedef unsigned char	IlsOpenViewStatus
	The type IlsOpenViewStatus is used in the signature of the member functions IlsMvServer::OpenView() to define the status of a view-opening action. More...
typedef unsigned long	IlsRepresentationId
	This numeric type is used to identify a representation. More...
typedef short	IlsRpAttributeId
	This numeric type is used to identify a representation object attribute or a representation object model attribute. More...
typedef unsigned short	IlsRpModelId
	This numeric type is used to identify a representation model. More...
typedef unsigned long	IlsRpObjectId
	This numeric type is used to identify a representation object. More...
typedef unsigned short	IlsRpStatus
	This type is used to specify the representation status of a server object in a view. More...
typedef unsigned long	IlsTransactionId
	This numeric type is used to identify a component-to-server transaction. More...

Enumerations
enum	IlsOpenViewStatusE {   ILS_OPEN_OK, ILS_ALREADY_OPENED, ILS_OPEN_ILLEGAL_ORIGIN, ILS_OPEN_REFUSED,   ILS_OPEN_FAILED, ILS_OPEN_UNKNOWN_VIEWTYPE }
	This enumerated type is used by the IlsOpenViewStatus typedef to return the status of a view-opening action. More...

Typedef Documentation

IlsOpenViewStatus

typedef unsigned char IlsOpenViewStatus

The type IlsOpenViewStatus is used in the signature of the member functions IlsMvServer::OpenView() to define the status of a view-opening action.

It is also passed as a parameter:

• to the callback functions IlsMvComponent::ackOpenView() and IlsRpObject::ackOpenView(), which are associated with the member functions IlsMvComponent::openView() and IlsRpObject::openView(), and
• to the member function IlsRepresentation::onCreation().

The possible values of the typedef IlsOpenViewStatus are listed in the enumerated type IlsOpenViewStatusE.

Library: server
, mvcomp.

See also

IlsMvComponent, IlsMvServer, IlsRepresentation, IlsRpObject.

Enumeration Type Documentation

IlsOpenViewStatusE

enum IlsOpenViewStatusE

This enumerated type is used by the IlsOpenViewStatus typedef to return the status of a view-opening action.

Library: server
, mvcomp.

See also

IlsOpenViewStatus.

Enumerator
ILS_OPEN_OK	The view has been opened successfully.
ILS_ALREADY_OPENED	The view is already open and has not be re-opened.
ILS_OPEN_ILLEGAL_ORIGIN	The view has not be opened because the origin object was not valid.
ILS_OPEN_REFUSED	The opening of the view has been refused (see the function IlsViewed::acceptView() for more information).
ILS_OPEN_FAILED	The view has not been opened for other reasons (unknown view type, rollback of transaction).
ILS_OPEN_UNKNOWN_VIEWTYPE	The view type is not known by the server.