Set of classes and macros to be used on server side when using dynamic views. More...

Category Description

Set of classes and macros to be used on server side when using dynamic views.

Classes
class	IlsMvEndPoint::ConnectionListener
	Class used to listen disconnections. More...

class	IlsAttributeDef
	An `IlsAttributeDef` object defines the runtime visibility and access to an attribute (usually an entry or a derived data member) of a server object type. More...

class	IlsDynModelInterpreter
	This class allows you to declare a dynamic model in a Rogue Wave Server application. More...

class	IlsDynMvServer
	This subclass of `IlsMvServer` runs a dynamic view server with dynamic modeling capabilities. More...

class	IlsFunctionDef
	An `IlsFunctionDef` object defines the runtime visibility and access to a member function of a server object type or a global function. More...

class	IlsModelInterpreter
	This class implements the runtime interpreter of server object models. More...

class	IlsMvComponentItf
	This class implements the interface of a component that interacts with a dynamic view server. More...

class	IlsMvDataType
	Defines the type of attributes that is attached to a representation object model. More...

class	IlsMvEndPoint
	This class is the base class for any component connected to a dynamic view server and for the interface of these components as handled by the server. More...

class	IlsMvFile
	This class is used to transmit the name and contents of a file from the server to the component. More...

class	IlsMvMessage
	This class is internally used by Rogue Wave Server to exchange interaction messages between an object server and application components. More...

class	IlsMvProcess
	The class `IlsMvProcess` implements a set of functions needed by any Rogue Wave Server component or server process. More...

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

class	IlsMvServer
	This class lets you define dynamic view servers. More...

class	IlsMvServerFactory
	This class is a factory class used to create instances of the class `IlsMvServer`. More...

class	IlsMvTimeManager
	This singleton manages the current timer used by the dynamic view that exploits the `currentTime` view attribute. More...

class	IlsMvUser
	Repressents the user of a component connection. More...

class	IlsMvUserFactory
	Factory class that applies to instances of the class `IlsMvUser`. 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	IlsMvView
	Dynamic view class. More...

class	IlsObjectType
	Defines the runtime visibility and access of a server object type (a subtype of the class `IlsObject` or `IlsEntity`). More...

class	IlsRelationDef
	An `IlsRelationDef` object defines the runtime visibility and access to a relation of a server object type. More...

class	IlsRTTypes
	Nesting types for `AttributeKind` and `RelationKind`. More...

class	IlsSvModelObserver
	Model observer. More...

class	IlsSvRef
	This class encapsulates a pointer to a server object along with its type, in a non-typed way. More...

class	IlsTranslationMng
	API FOR ADVANCED USERS – This class is used to managed the encoding and decoding functions used to translate strings between different locales. More...

class	MvArray
	User-defined array class that inherits from `IlsMvUserType`. More...

class	MvDateTime
	This class allows dates and times to be exchanged between processes. More...

struct	IlsMvMessage::SvMsg
	This structure enables you to specify a message identifier, a message level and a message description. More...

Macros
#define	ILS_DERIVED_BOOLEAN(holder, derivedLabel)
	This macro declares the derived data member specified by `derivedLabel` as a runtime attribute of the class `objType`. More...

#define	ILS_DERIVED_CHAR(holder, derivedLabel)
	This macro declares the derived data member specified by `derivedLabel` as a runtime attribute of the class `objType`. More...

#define	ILS_DERIVED_DOUBLE(holder, derivedLabel)
	This macro declares the derived data member specified by `derivedLabel` as a runtime attribute of the class `objType`. More...

#define	ILS_DERIVED_ENUM(holder, derivedType, attrLabel)
	This macro declares the derived data member specified by `derivedLabel` as a runtime attribute of the class `objType`. More...

#define	ILS_DERIVED_FLOAT(holder, derivedLabel)
	This macro declares the derived data member specified by `derivedLabel` as a runtime attribute of the class `objType`. More...

#define	ILS_DERIVED_INT(holder, derivedLabel)
	This macros declare the derived data member specified by `derivedLabel` as a runtime attribute of the class `objType`. More...

#define	ILS_DERIVED_LONG(holder, derivedLabel)
	This macros declare the derived data member specified by `derivedLabel` as a runtime attribute of the class `objType`. More...

#define	ILS_DERIVED_MVVALUE(holder, derivedLabel)
	This macro declares the derived data member specified by `derivedLabel` as a runtime attribute of the class `objType`. More...

#define	ILS_DERIVED_SHORT(holder, derivedLabel)
	This macro declares the derived data member specified by `derivedLabel` as a runtime attribute of the class `objType`. More...

#define	ILS_DERIVED_STRING(holder, derivedLabel)
	This macro declares the derived data member specified by `derivedLabel` as a runtime attribute of the class `objType`. More...

#define	ILS_DERIVED_USERTYPE(holder, derivedType, derivedLabel)
	This macro declares the derived data member specified by `derivedLabel` as a runtime attribute of the class `objType`. More...

#define	ILS_DERIVED_XXX()
	The macros `ILS_DERIVED_XXX()` declare server derived data members as being accessible at runtime so that they can be used in view specifications. More...

#define	ILS_ENTITY1_BEGIN(typeNm, parent1)
	Macro for declaring an entity that derives from another object type. More...

#define	ILS_ENTITY2_BEGIN(typeNm, parent1, parent2)
	Macro for declaring an entity that derives from two other object types. More...

#define	ILS_ENTITY_BEGIN(typeNm)
	This macro and `IL_ENTITY_END()` declare a server object type deriving from `IlsEntity` to the server model interpreter. More...

#define	ILS_ENTITY_DECL(typeNm)
	This macro declares a server object type that derives from `IlsEntity` to the server model interpreter. More...

#define	ILS_ENTITY_END(typeNm)
	This macro and `IL_ENTITY_BEGIN()` declare a server object type deriving from `IlsEntity` to the server model interpreter. More...

#define	ILS_ENTITY_INIT(typeNm)

#define	ILS_ENTRY_BOOLEAN(holder, entryLabel)
	This macro declares the entry data member specified by `entryLabel` as a runtime attribute of the class `holder`. More...

#define	ILS_ENTRY_CHAR(holder, entryLabel)
	This macro declares the entry data member specified by `entryLabel` as a runtime attribute of the class `holder`. More...

#define	ILS_ENTRY_DOUBLE(holder, entryLabel)
	This macro declares the entry data member specified by `entryLabel` as a runtime attribute of the class `holder`. More...

#define	ILS_ENTRY_ENUM(holder, entryType, entryLabel)
	This macro declares the entry data member specified by `entryLabel` as a runtime attribute of the class `holder`. More...

#define	ILS_ENTRY_FLOAT(holder, entryLabel)
	This macro declares the entry data member specified by `entryLabel` as a runtime attribute of the class `holder`. More...

#define	ILS_ENTRY_INT(holder, entryLabel)
	This macros declares the entry data member specified by `entryLabel` as a runtime attribute of the class `holder`. More...

#define	ILS_ENTRY_LONG(holder, entryLabel)
	This macros declares the entry data member specified by `entryLabel` as a runtime attribute of the class `holder`. More...

#define	ILS_ENTRY_MVVALUE(holder, entryLabel)
	This macro declares the entry data member specified by `entryLabel` as a runtime attribute of the class `holder`. More...

#define	ILS_ENTRY_SHORT(holder, entryLabel)
	This macro declares the entry data member specified by `entryLabel` as a runtime attribute of the class `holder`. More...

#define	ILS_ENTRY_STRING(holder, entryLabel)
	This macro declares the entry data member specified by `entryLabel` as a runtime attribute of the class `holder`. More...

#define	ILS_ENTRY_USERTYPE(holder, entryType, entryLabel)
	This macro declares the entry data member specified by entryLabel as a runtime attribute of the class `holder`. More...

#define	ILS_ENTRY_XXX()
	The macros `ILS_ENTRY_XXX()` declare Server entry data members as being accessible at runtime so that they can be used in view specifications. More...

#define	ILS_GLOBAL_FUNCTION()
	These macros declare global functions as being accessible at runtime, so that they can be used in dynamic view type specifications. More...

#define	ILS_GLOBAL_FUNCTION0(resType, funNm)
	declare global function with no parameter to runtime interpreter. More...

#define	ILS_GLOBAL_FUNCTION1(resType, funNm, p1Type)
	declare global function with one parameter to runtime interpreter. More...

#define	ILS_GLOBAL_FUNCTION2(resType, funNm, p1Type, p2Type)
	declare global function with two parameters to runtime interpreter. More...

#define	ILS_GLOBAL_FUNCTION3(resType, funNm, p1Type, p2Type, p3Type)
	declare global function with three parameters to runtime interpreter. More...

#define	ILS_GLOBAL_FUNCTION4(resType, funNm, p1Type, p2Type, p3Type, p4Type)
	declare global function with four parameters to runtime interpreter. More...

#define	ILS_GLOBAL_FUNCTION5(resType, funNm, p1Type, p2Type, p3Type, p4Type, p5Type)
	declare global function with five parameters to runtime interpreter. More...

#define	ILS_GLOBAL_FUNCTION6(resType, funNm, p1Type, p2Type, p3Type, p4Type, p5Type, p6Type)
	declare global function with six parameters to runtime interpreter. More...

#define	ILS_GLOBAL_FUNCTION7(resType, funNm, p1Type, p2Type, p3Type, p4Type, p5Type, p6Type, p7Type)
	declare global function with seven parameters to runtime interpreter. More...

#define	ILS_INVERTED_1(target, origin, invRelNm, relNm)
	This macro declares a server relation of type `IlsInvertedRelation` as being accessible at runtime so that it can be used in view specifications. More...

#define	ILS_INVERTED_N(target, origin, invRelNm, relNm)
	This macro declares a server relation of type `IlsInvertedRelationList` as being accessible at runtime so that it can be used in view specifications. More...

#define	ILS_MEMBER_FUNCTION()
	These macros declare member functions of Server classes as being accessible at runtime, so that they can be used in dynamic view type specifications. They also enable a component to invoke the declared functions on server objects. More...

#define	ILS_MEMBER_FUNCTION0(resType, objType, funNm)
	declare member function with no parameter to runtime interpreter. More...

#define	ILS_MEMBER_FUNCTION1(resType, objType, funNm, p1Type)
	declare member function with one parameter to runtime interpreter. More...

#define	ILS_MEMBER_FUNCTION2(resType, objType, funNm, p1Type, p2Type)
	declare member function with two parameters to runtime interpreter. More...

#define	ILS_MEMBER_FUNCTION3(resType, objType, funNm, p1Type, p2Type, p3Type)
	declare member function with three parameters to runtime interpreter. More...

#define	ILS_MEMBER_FUNCTION4(resType, objType, funNm, p1Type, p2Type, p3Type, p4Type)
	declare member function with four parameters to runtime interpreter. More...

#define	ILS_MEMBER_FUNCTION5(resType, objType, funNm, p1Type, p2Type, p3Type, p4Type, p5Type)
	declare member function with five parameters to runtime interpreter. More...

#define	ILS_MEMBER_FUNCTION6(resType, objType, funNm, p1Type, p2Type, p3Type, p4Type, p5Type, p6Type)
	declare member function with six parameters to runtime interpreter. More...

#define	ILS_MEMBER_FUNCTION7(resType, objType, funNm, p1Type, p2Type, p3Type, p4Type, p5Type, p6Type, p7Type)
	declare member function with seven parameters to runtime interpreter. More...

#define	ILS_MVVIEW_BEGIN(typeNm, parent)
	This macro and `ILS_MVVIEW_END()` declare a subtype of `IlsMvView` to the view interpreter on the server side. More...

#define	ILS_MVVIEW_DECL(typeNm)
	This macro declares a subtype of `IlsMvView` to the view interpreter on the server side. More...

#define	ILS_MVVIEW_END(typeNm)
	This macro and `ILS_MVVIEW_BEGIN()` declare a subtype of `IlsMvView` to the view interpreter on the server side. More...

#define	ILS_MVVIEW_INIT(typeNm)

#define	ILS_OBJECT1_BEGIN(typeNm, parent1)
	declare an object type that derives from another server object type to runtime interpreter. More...

#define	ILS_OBJECT1_WITH_ID_BEGIN(typeNm, ident, parent1)

#define	ILS_OBJECT2_BEGIN(typeNm, parent1, parent2)
	declare an object type that derives from two other server object types to runtime interpreter. More...

#define	ILS_OBJECT2_WITH_ID_BEGIN(typeNm, ident, parent1, parent2)

#define	ILS_OBJECT_BEGIN(typeNm)
	This macro with `ILS_OBJECT_END()` declares a server object class deriving from `IlsObject` to the server model interpreter. More...

#define	ILS_OBJECT_DECL(typeNm)
	This macro declares a server object type deriving from `IlsObject` to the server model interpreter. More...

#define	ILS_OBJECT_END(typeNm)
	This macro with `ILS_OBJECT_BEGIN()` declares a server object class deriving from `IlsObject` to the server model interpreter. More...

#define	ILS_OBJECT_INIT(typeNm)

#define	ILS_OBJECT_WITH_ID_BEGIN(typeNm, ident)

#define	ILS_OWNS_1(origin, target, relNm)
	This macro declares a server relation of type `IlsOwns` as being accessible at runtime so that it can be used in view specifications. More...

#define	ILS_OWNS_N(origin, target, relNm)
	This macro declares a multiple server relation of type `IlsOwnsList`, `IlsOwnsSet`, `IlsOwnsDynamicArray`, or `IlsOwnsFixedArray` as being accessible at runtime so that it can be used in view specifications. More...

#define	ILS_R_ATTRIBUTE_BOOLEAN(holder, attrLabel, getValue, isModified, updEagerness)
	This macro declares `attrLabel` as a runtime attribute of the class `holder`. This attribute is of type `IlsBoolean` and cannot be modified. More...

#define	ILS_R_ATTRIBUTE_CHAR(holder, attrLabel, getValue, isModified, updEagerness)
	This macro declares `attrLabel` as a runtime attribute of the class `holder`. This attribute is of type `char` and cannot be modified. More...

#define	ILS_R_ATTRIBUTE_DOUBLE(holder, attrLabel, getValue, isModified, updEagerness)
	This macro declares `attrLabel` as a runtime attribute of the class `holder`. This attribute is of type `double` and cannot be modified. More...

#define	ILS_R_ATTRIBUTE_ENUM(holder, attrType, attrLabel, getValue, isModified, updEagerness)
	This macro declares `attrLabel` as a runtime attribute of the class `holder`. This attribute is of `enum` type `attrType` and cannot be modified. More...

#define	ILS_R_ATTRIBUTE_FLOAT(holder, attrLabel, getValue, isModified, updEagerness)
	This macro declares `attrLabel` as a runtime attribute of the class `holder`. This attribute is of type `float` and cannot be modified. More...

#define	ILS_R_ATTRIBUTE_INT(holder, attrLabel, getValue, isModified, updEagerness)
	This macro declares `attrLabel` as a runtime attribute of the class `holder`. This attribute is of type `long` and cannot be modified. More...

#define	ILS_R_ATTRIBUTE_LONG(holder, attrLabel, getValue, isModified, updEagerness)
	This macro declares `attrLabel` as a runtime attribute of the class `holder`. This attribute is of type `long` and cannot be modified. More...

#define	ILS_R_ATTRIBUTE_MVVALUE(holder, attrLabel, getValue, isModified, updEagerness)
	This macro declares `attrLabel` as a runtime attribute of the class `holder`. This attribute is of type `IlsMvValue` and cannot be modified. More...

#define	ILS_R_ATTRIBUTE_SHORT(holder, attrLabel, getValue, isModified, updEagerness)
	This macro declares `attrLabel` as a runtime attribute of the class `holder`. This attribute is of type `short` and cannot be modified. More...

#define	ILS_R_ATTRIBUTE_STRING(holder, attrLabel, getValue, isModified, updEagerness)
	This macro declares `attrLabel` as a runtime attribute of the class `holder`. This attribute is of type `IlsString` and cannot be modified. More...

#define	ILS_R_ATTRIBUTE_USERTYPE(holder, attrType, attrLabel, getValue, isModified, updEagerness)
	This macro declares `attrLabel` as a runtime attribute of the class `holder`. This attribute is of type `attrType` which derives from `IlsMvUserType` and cannot be modified. More...

#define	ILS_R_ATTRIBUTE_XXX()
	The macros `ILS_R_ATTRIBUTE_XXX()` declare a read-only runtime attribute for a server object type so that it can be used in dynamic view type specifications. More...

#define	ILS_R_INDEXED_ATTR_BOOLEAN(holder, attrLabel, getValue, isModified, updEagerness)
	This macro declares `attrLabel` as a runtime indexed attribute of the class `holder`. This attribute is of type `IlsBoolean` and cannot be modified. More...

#define	ILS_R_INDEXED_ATTR_CHAR(holder, attrLabel, getValue, isModified, updEagerness)
	This macro declares `attrLabel` as a runtime indexed attribute of the class `holder`. This attribute is of type `char` and cannot be modified. More...

#define	ILS_R_INDEXED_ATTR_DOUBLE(holder, attrLabel, getValue, isModified, updEagerness)
	This macro declares `attrLabel` as a runtime indexed attribute of the class `holder`. This attribute is of type `double` and cannot be modified. More...

#define	ILS_R_INDEXED_ATTR_ENUM(holder, attrType, attrLabel, getValue, isModified, updEagerness)
	This macro declares `attrLabel` as a runtime indexed attribute of the class `holder`. This attribute is of `enum` type `attrType` and cannot be modified. More...

#define	ILS_R_INDEXED_ATTR_FLOAT(holder, attrLabel, getValue, isModified, updEagerness)
	This macro declares `attrLabel` as a runtime indexed attribute of the class `holder`. This attribute is of type `float` and cannot be modified. More...

#define	ILS_R_INDEXED_ATTR_INT(holder, attrLabel, getValue, isModified, updEagerness)
	This macro declares `attrLabel` as a runtime indexed attribute of the class `holder`. This attribute is of type `long` and cannot be modified. More...

#define	ILS_R_INDEXED_ATTR_LONG(holder, attrLabel, getValue, isModified, updEagerness)
	This macro declares `attrLabel` as a runtime indexed attribute of the class `holder`. This attribute is of type `long` and cannot be modified. More...

#define	ILS_R_INDEXED_ATTR_MVVALUE(holder, attrLabel, getValue, isModified, updEagerness)
	his macro declares `attrLabel` as a runtime indexed attribute of the class `holder`. This attribute is of type `IlsMvValue` and cannot be modified. More...

#define	ILS_R_INDEXED_ATTR_SHORT(holder, attrLabel, getValue, isModified, updEagerness)
	This macro declares `attrLabel` as a runtime indexed attribute of the class `holder`. This attribute is of type `short` and cannot be modified. More...

#define	ILS_R_INDEXED_ATTR_STRING(holder, attrLabel, getValue, isModified, updEagerness)
	This macro declares `attrLabel` as a runtime indexed attribute of the class `holder`. This attribute is of type `IlsString` and cannot be modified. More...

#define	ILS_R_INDEXED_ATTR_USERTYPE(holder, attrType, attrLabel, getValue, isModified, updEagerness)
	This macro declares `attrLabel` as a runtime indexed attribute of the class `holder`. This attribute is of type `attrType` which derives from `IlsMvUserType` and cannot be modified. More...

#define	ILS_R_INDEXED_ATTR_XXX()
	The macros `ILS_R_INDEXED_ATTR_xxx` declare a read-only runtime indexed attribute for a server object type so that it can be used in view specifications. More...

#define	ILS_R_RELATION_1(origin, target, relNm, relAccessor, targAccessor)
	This macro declares a server unary relation as being accessible at runtime. More...

#define	ILS_R_RELATION_N(origin, target, relNm, relAccessor)
	This macro declares a Server n-ary relation as being accessible at runtime. More...

#define	ILS_REVERSE(owner, relNm, revRelNm)
	This macro declares that a relation is the inverse relation of another relation. More...

#define	ILS_RW_ATTRIBUTE_BOOLEAN(holder, attrLabel, getValue, setValue, isModified)
	This macro declares `attrLabel` as a runtime attribute of the class `holder`. This attribute is of type `IlsBoolean` and can be modified. More...

#define	ILS_RW_ATTRIBUTE_CHAR(holder, attrLabel, getValue, setValue, isModified)
	This macro declares `attrLabel` as a runtime attribute of the class `holder`. This attribute is of type `char` and can be modified. More...

#define	ILS_RW_ATTRIBUTE_DOUBLE(holder, attrLabel, getValue, setValue, isModified)
	This macro declares `attrLabel` as a runtime attribute of the class `holder`. This attribute is of type `double` and can be modified. More...

#define	ILS_RW_ATTRIBUTE_ENUM(holder, attrType, attrLabel, getValue, setValue, isModified)
	This macro declares `attrLabel` as a runtime attribute of the class `holder`. This attribute is an `enum` type `attrType` and can be modified. More...

#define	ILS_RW_ATTRIBUTE_FLOAT(holder, attrLabel, getValue, setValue, isModified)
	This macro declares `attrLabel` as a runtime attribute of the class `holder`. This attribute is of type `float` and can be modified. More...

#define	ILS_RW_ATTRIBUTE_INT(holder, attrLabel, getValue, setValue, isModified)
	This macro declares `attrLabel` as a runtime attribute of the class `holder`. This attribute is of type `long` (`int` and `long` are both considered as `long` in Server) and can be modified. More...

#define	ILS_RW_ATTRIBUTE_LONG(holder, attrLabel, getValue, setValue, isModified)
	This macro declares `attrLabel` as a runtime attribute of the class `holder`. This attribute is of type `long` and can be modified. More...

#define	ILS_RW_ATTRIBUTE_MVVALUE(holder, attrLabel, getValue, setValue, isModified)
	This macro declares `attrLabel` as a runtime attribute of the class `holder`. This attribute is of type `IlsMvValue` and can be modified. More...

#define	ILS_RW_ATTRIBUTE_SHORT(holder, attrLabel, getValue, setValue, isModified)
	This macro declares `attrLabel` as a runtime attribute of the class `holder`. This attribute is of type `short` and can be modified. More...

#define	ILS_RW_ATTRIBUTE_STRING(holder, attrLabel, getValue, setValue, isModified)
	This macro declares `attrLabel` as a runtime attribute of the class `holder`. This attribute is of type `IlsString` and can be modified. More...

#define	ILS_RW_ATTRIBUTE_USERTYPE(holder, attrType, attrLabel, getValue, setValue, isModified)
	This macro declares `attrLabel` as a runtime attribute of the class `holder`. This attribute is of type `attrType` which derives from `IlsMvUserType` and can be modified. More...

#define	ILS_RW_ATTRIBUTE_XXX()
	The macros `ILS_RW_ATTRIBUTE_XXX()` declare a read/write runtime attribute for a server object type so that it can be used in view specifications. More...

#define	ILS_RW_INDEXED_ATTR_BOOLEAN(holder, attrLabel, getValue, setValue, isModified)
	This macro declares `attrLabel` as a runtime attribute of the class `holder`. More...

#define	ILS_RW_INDEXED_ATTR_CHAR(holder, attrLabel, getValue, setValue, isModified)
	This macro declares `attrLabel` as a runtime attribute of the class `holder`. More...

#define	ILS_RW_INDEXED_ATTR_DOUBLE(holder, attrLabel, getValue, setValue, isModified)
	This macro declares `attrLabel` as a runtime attribute of the class `holder`. More...

#define	ILS_RW_INDEXED_ATTR_ENUM(holder, attrType, attrLabel, getValue, setValue, isModified)
	This macro declares `attrLabel` as a runtime attribute of the class `holder`. More...

#define	ILS_RW_INDEXED_ATTR_FLOAT(holder, attrLabel, getValue, setValue, isModified)
	This macro declares `attrLabel` as a runtime attribute of the class `holder`. More...

#define	ILS_RW_INDEXED_ATTR_INT(holder, attrLabel, getValue, setValue, isModified)
	This macro declares `attrLabel` as a runtime attribute of the class `holder`. More...

#define	ILS_RW_INDEXED_ATTR_LONG(holder, attrLabel, getValue, setValue, isModified)
	This macro declares `attrLabel` as a runtime attribute of the class `holder`. More...

#define	ILS_RW_INDEXED_ATTR_MVVALUE(holder, attrLabel, getValue, setValue, isModified)
	This macro declares `attrLabel` as a runtime attribute of the class `holder`. More...

#define	ILS_RW_INDEXED_ATTR_SHORT(holder, attrLabel, getValue, setValue, isModified)
	This macro declares `attrLabel` as a runtime attribute of the class `holder`. More...

#define	ILS_RW_INDEXED_ATTR_STRING(holder, attrLabel, getValue, setValue, isModified)
	This macro declares `attrLabel` as a runtime attribute of the class `holder`. More...

#define	ILS_RW_INDEXED_ATTR_USERTYPE(holder, attrType, attrLabel, getValue, setValue, isModified)
	This macro declares `attrLabel` as a runtime attribute of the class `holder`. More...

#define	ILS_RW_INDEXED_ATTR_XXX()
	The macros `ILS_RW_INDEXED_ATTR_xxx` declare a read/write runtime indexed attribute for a server object type so that it can be used in view specifications. More...

#define	ILS_RW_RELATION_1(origin, target, relNm, relAccessor, targAccessor, modifier)
	This macro declares a server object relation as being accessible at runtime. More...

#define	ILS_RW_RELATION_N(origin, target, relNm, relAccessor, modifier)
	This macro declares multiple server object relation as being accessible at runtime. More...

#define	ILS_SV_MEMBER_FUNCTION()
	These macros are similar to the macros `ILS_MEMBER_FUNCTION()` macros except that they can accept Server types as their arguments. More...

#define	ILS_SV_MEMBER_FUNCTION0(resType, objType, funNm)
	declare script member function with zero parameter to runtime interpreter. More...

#define	ILS_SV_MEMBER_FUNCTION1(resType, objType, funNm, p1Type)
	declare script member function with one parameter to runtime interpreter. More...

#define	ILS_SV_MEMBER_FUNCTION2(resType, objType, funNm, p1Type, p2Type)
	declare script member function with two parameters to runtime interpreter. More...

#define	ILS_SV_MEMBER_FUNCTION3(resType, objType, funNm, p1Type, p2Type, p3Type)
	declare script member function with three parameters to runtime interpreter. More...

#define	ILS_SV_MEMBER_FUNCTION4(resType, objType, funNm, p1Type, p2Type, p3Type, p4Type)
	declare script member function with four parameters to runtime interpreter. More...

#define	ILS_SV_MEMBER_FUNCTION5(resType, objType, funNm, p1Type, p2Type, p3Type, p4Type, p5Type)
	declare script member function with five parameters to runtime interpreter. More...

#define	ILS_SV_MEMBER_FUNCTION6(resType, objType, funNm, p1Type, p2Type, p3Type, p4Type, p5Type, p6Type)
	declare script member function with six parameters to runtime interpreter. More...

#define	ILS_SV_MEMBER_FUNCTION7(resType, objType, funNm, p1Type, p2Type, p3Type, p4Type, p5Type, p6Type, p7Type)
	declare script member function with seven parameters to runtime interpreter. More...

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

#define	ILS_USES_1(origin, target, relNm)
	This macro declares a server relation of type `IlsUses` as being accessible at runtime, so that it can be used in view specifications. More...

#define	ILS_USES_N(origin, target, relNm)
	This macro declares a server relation of type `IlsUsesList`, `IlsUsesSet`, `IlsUsesDynamicArray`, or `IlsUsesFixedArray` as being accessible at runtime, so that it can be used in view specifications. More...

#define	ILS_W_ENTRY_CHAR(holder, attrLabel, setValue)
	This macro declares the entry data member specified by `entryLabel` as a runtime attribute of the class `holder`. More...

#define	ILS_W_ENTRY_DOUBLE(holder, attrLabel, setValue)
	This macro declares the entry data member specified by `entryLabel` as a runtime attribute of the class `holder`. More...

#define	ILS_W_ENTRY_FLOAT(holder, attrLabel, setValue)
	This macro declares the entry data member specified by `entryLabel` as a runtime attribute of the class `holder`. More...

#define	ILS_W_ENTRY_INT(holder, attrLabel, setValue)
	This macro declares the entry data member specified by `entryLabel` as a runtime attribute of the class `holder`. More...

#define	ILS_W_ENTRY_LONG(holder, attrLabel, setValue)
	This macro declares the entry data member specified by `entryLabel` as a runtime attribute of the class `holder`. More...

#define	ILS_W_ENTRY_MVVALUE(holder, attrLabel, setValue)
	This macro declares the entry data member specified by `entryLabel` as a runtime attribute of the class `holder`. More...

#define	ILS_W_ENTRY_SHORT(holder, attrLabel, setValue)
	This macro declares the entry data member specified by `entryLabel` as a runtime attribute of the class `holder`. More...

#define	ILS_W_ENTRY_STRING(holder, attrLabel, setValue)
	This macro declares the entry data member specified by `entryLabel` as a runtime attribute of the class `holder`. More...

#define	ILS_W_ENTRY_USERTYPE(holder, attrType, attrLabel, setValue)
	This macro declares the entry data member specified by `entryLabel` as a runtime attribute of the class `holder`. More...

#define	ILS_W_ENTRY_XXX()
	The macros `ILS_W_ENTRY_XXX()` declare server entry data members as being accessible at runtime so that they can be used in view specifications. More...

#define	ILS_W_RELATION_1(origin, target, relNm, modifier)
	This macro declares a simple server relation as being accessible at runtime. More...

#define	ILS_W_RELATION_N(origin, target, relNm, modifier)
	This macro declares a multiple server relation as being accessible at runtime. More...

Typedefs
typedef IlsAttributeAccessorFunctor *	IlsAttributeAccessor
	This type is an accessor functor to the value of a non-indexed attribute. More...

typedef IlsAttributeModifTestFunctor *	IlsAttributeModifTest
	This type is a functor used by the server model interpreter to test the modification of a non-indexed attribute. More...

typedef IlsMvValue(*	IlsDerivedEvaluatorFunction) (IlsViewed &)
	This function pointer type is used to assign an evaluation function to a derived dynamic attribute. More...

typedef IlsIdxAttributeAccessorFunctor *	IlsIdxAttributeAccessor
	This type is an accessor functor to the value of an indexed attribute. More...

typedef IlsIdxAttributeModifTestFunctor *	IlsIdxAttributeModifTest
	This type is a functor used by the server model interpreter to test the modification of an indexed attribute. More...

typedef char (	IlsMsgDecoder) (const char *buf, unsigned long &len)
	This function type is used when a message is expected from the communication layer. More...

typedef char (	IlsMsgEncoder) (const char *buf, unsigned long &len)
	This function type is used when a message is to be sent over the communication layer. More...

typedef MvArray	IlsMvArray

typedef MvKeyValueTable	IlsMvKeyValueTable

typedef IlsObjectConstructorFunctor *	IlsObjectConstructor
	This functor is used by the server model interpreter to create a new instance of a server object. More...

typedef IlsRelationAccessorFunctor *	IlsRelationAccessor
	This relation accessor is a functor used by the server model interpreter. More...

typedef IlsRelationModifierFunctor *	IlsRelationModifier
	This type is a functor used by the server model interpreter to modify a relation. 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 int	IlsRpUpdateType
	This type definition is used to indicate what types of editing operations are performed on a server object by a component through a dynamic view. More...

typedef IlsRTFunctionFunctor *	IlsRTFunction
	This type is a functor to access member functions or global functions. More...

typedef IlsMvValue(*	IlsRTFunctionPtr) (void , const IlsMvValue , int dim)
	This type is a pointer to a function that takes a non-typed object as its first parameter and an array of arguments. More...

typedef IlsSimpleTargetAccessorFunctor *	IlsSimpleTargetAccessor
	This type is an accessor functor to the target of unary relations. More...

typedef unsigned long	IlsTransactionId
	This numeric type is used to identify a component-to-server transaction. More...

typedef signed char	IlsMvView::Priority
	View notification priority. More...

Enumerations
enum	IlsRTTypes::AttributeKind { IlsRTTypes::EntryValue , IlsRTTypes::DerivedValue , IlsRTTypes::AttrValue }
	This enumerated type lists the various types of server attributes. More...

enum	IlsRpUpdateEnum { , ILS_RP_CREATION, ILS_RP_DELETION, ILS_RP_MODIFICATION }
	This enumerated type is used to indicate the type of editing operation to be performed on a server object by a component through a dynamic view. More...

enum	IlsMvDataType::Kind { IlsMvDataType::MV_VOID, IlsMvDataType::MV_BOOL, IlsMvDataType::MV_CHAR, IlsMvDataType::MV_LONG, IlsMvDataType::MV_FLOAT, IlsMvDataType::MV_DOUBLE, IlsMvDataType::MV_STRING, IlsMvDataType::MV_USER, IlsMvDataType::MV_REF, IlsMvDataType::MV_HREF , IlsMvDataType::MV_COLLECTOR, IlsMvDataType::MV_ANY, IlsMvDataType::MV_VALUE, IlsMvDataType::MV_FILE, IlsMvDataType::MV_SVREF }
	Specifies the type of an attribute attached to a representation object model. More...

enum	IlsRTTypes::RelationKind { IlsRTTypes::REL_1, IlsRTTypes::USES_1, IlsRTTypes::OWNS_1, IlsRTTypes::INVERTED_1, IlsRTTypes::REL_N, IlsRTTypes::USES_N, IlsRTTypes::OWNS_N, IlsRTTypes::INVERTED_N }
	This enumerated type lists the various types of server relations. More...

enum	IlsMvEndPoint::TraceType { IlsMvEndPoint::NO_TRACE, IlsMvEndPoint::TRACE_TRANS, IlsMvEndPoint::TRACE_MSG , IlsMvEndPoint::TRACE_TAG_ERR, IlsMvEndPoint::TRACE_TAG_PRINT }
	Specifies the type of trace attached to interactions between an object server and its components. See the trace functions of the class `IlsMvEndPoint` for more information. More...

Macro Definition Documentation

◆ ILS_DERIVED_BOOLEAN

#define ILS_DERIVED_BOOLEAN	(	holder,
		derivedLabel
	)

This macro declares the derived data member specified by derivedLabel as a runtime attribute of the class objType.

This attribute is of type Boolean. It cannot be modified.

See also: ILS_DERIVED_XXX().

◆ ILS_DERIVED_CHAR

#define ILS_DERIVED_CHAR	(	holder,
		derivedLabel
	)

This macro declares the derived data member specified by derivedLabel as a runtime attribute of the class objType.

This attribute is of type char. It cannot be modified.

See also: ILS_DERIVED_XXX().

◆ ILS_DERIVED_DOUBLE

#define ILS_DERIVED_DOUBLE	(	holder,
		derivedLabel
	)

This macro declares the derived data member specified by derivedLabel as a runtime attribute of the class objType.

This attribute is of type double. it cannot be modified.

See also: ILS_DERIVED_XXX().

◆ ILS_DERIVED_ENUM

#define ILS_DERIVED_ENUM	(	holder,
		derivedType,
		attrLabel
	)

This macro declares the derived data member specified by derivedLabel as a runtime attribute of the class objType.

The enumType attribute is of the user-defined enum type. It cannot be modified.

See also: ILS_DERIVED_XXX().

◆ ILS_DERIVED_FLOAT

#define ILS_DERIVED_FLOAT	(	holder,
		derivedLabel
	)

This macro declares the derived data member specified by derivedLabel as a runtime attribute of the class objType.

This attribute is of type float. It cannot be modified.

See also: ILS_DERIVED_XXX().

◆ ILS_DERIVED_INT

#define ILS_DERIVED_INT	(	holder,
		derivedLabel
	)

This macros declare the derived data member specified by derivedLabel as a runtime attribute of the class objType.

Since Rogue Wave Server does not differentiate between the int and long types, this macro is equivalent to ILS_DERIVED_LONG() and the attribute is of type long. It cannot be modified.

See also: ILS_DERIVED_XXX(), ILS_DERIVED_LONG().

◆ ILS_DERIVED_LONG

#define ILS_DERIVED_LONG	(	holder,
		derivedLabel
	)

This macros declare the derived data member specified by derivedLabel as a runtime attribute of the class objType.

Since Rogue Wave Server does not differentiate between the int and long types, this macro is equivalent to ILS_DERIVED_INT() and the attribute is of type long. It cannot be modified.

See also: ILS_DERIVED_XXX(), ILS_DERIVED_INT().

◆ ILS_DERIVED_MVVALUE

#define ILS_DERIVED_MVVALUE	(	holder,
		derivedLabel
	)

This macro declares the derived data member specified by derivedLabel as a runtime attribute of the class objType.

This attribute is of type IlsMvValue. It cannot be modified.

See also: ILS_DERIVED_XXX().

◆ ILS_DERIVED_SHORT

#define ILS_DERIVED_SHORT	(	holder,
		derivedLabel
	)

This macro declares the derived data member specified by derivedLabel as a runtime attribute of the class objType.

This attribute is of type short. It cannot be modified.

See also: ILS_DERIVED_XXX().

◆ ILS_DERIVED_STRING

#define ILS_DERIVED_STRING	(	holder,
		derivedLabel
	)

This macro declares the derived data member specified by derivedLabel as a runtime attribute of the class objType.

This attribute is of type IlsString or char*. It cannot be modified.

See also: ILS_DERIVED_XXX().

◆ ILS_DERIVED_USERTYPE

#define ILS_DERIVED_USERTYPE	(	holder,
		derivedType,
		derivedLabel
	)

This macro declares the derived data member specified by derivedLabel as a runtime attribute of the class objType.

This attribute is of the user-defined type derivedType. For details, see the macros ILS_USERTYPE_DECL()/ILS_USERTYPE_DEF(). It cannot be modified.

See also: ILS_DERIVED_XXX().

◆ ILS_DERIVED_XXX

#define ILS_DERIVED_XXX ( )

The macros ILS_DERIVED_XXX() declare server derived data members as being accessible at runtime so that they can be used in view specifications.

These runtime attributes use the IlsDerived member functions IlsDerived::getValue(), IlsDerived::isModified(), IlsDerived::incrEagerness(), IlsDerived::decrEagerness().

These macros can be enclosed only between the following pairs of macros:

ILS_OBJECT_BEGIN() / ILS_OBJECT_END()
ILS_ENTITY_BEGIN() / ILS_ENTITY_END()
ILS_MVVIEW_BEGIN() / ILS_MVVIEW_END()

or their derivatives.

Synopsys

See also: IlsMoveDirective, ILS_R_ATTRIBUTE_XXX().

◆ ILS_ENTITY1_BEGIN

#define ILS_ENTITY1_BEGIN	(	typeNm,
		parent1
	)

Macro for declaring an entity that derives from another object type.

See also: ILS_ENTITY_BEGIN()

◆ ILS_ENTITY2_BEGIN

#define ILS_ENTITY2_BEGIN	(	typeNm,
		parent1,
		parent2
	)

Macro for declaring an entity that derives from two other object types.

See also: ILS_ENTITY_BEGIN()

◆ ILS_ENTITY_BEGIN

#define ILS_ENTITY_BEGIN ( typeNm )

This macro and IL_ENTITY_END() declare a server object type deriving from IlsEntity to the server model interpreter.

They must be used with the macro ILS_ENTITY_DECL(). The Server object types you declare using these macros can then be associated with representations in view specifications.

These macros also let you declare runtime entry data members, derived data members, and relations for the Server object type. These macros are equivalent to the macros ILS_OBJECT_BEGIN ()/ILS_OBJECT_END(), except that they implicitly declare a runtime attribute identifier as an entry of type IlsString. This attribute is associated with the accessors and modifiers of the identifier of the class IlsEntity.

These macros require that a constructor taking an argument of type IlsString as a parameter be declared on the class objType (see ILS_ENTITY_DECL() for details).

The macros ILS_ENTITY_BEGIN() and ILS_ENTITY_END() must be added to the source file that defines the member functions of the class objType. Only macros that let you declare runtime entries, derived data members, and relations can be enclosed between these macros.

If objType derives from another Server object type, you have to use the macro ILS_ENTITY1_BEGIN(). In this case, objType dynamically inherits from the runtime entries, derived data members and relations of the parent type.

If objType derives from two other Server object types, you have to use the macro ILS_ENTITY2_BEGIN(). In this case, objType dynamically inherits from the runtime entries, derived data members and relations of the parent type.

Synopsis

See also: ILS_DERIVED_XXX(), IlsEntity, ILS_ENTITY_END(), ILS_ENTITY_INIT(), IlsEntry, ILS_OBJECT_BEGIN() / ILS_OBJECT_END(), ILS_OBJECT_DECL(), IlsRepresentation, IlsRpObject, ILS_R_RELATION_1(), ILS_R_RELATION_N(), ILS_W_RELATION_1(), ILS_RW_RELATION_1(), ILS_W_RELATION_N().

◆ ILS_ENTITY_DECL

#define ILS_ENTITY_DECL ( typeNm )

This macro declares a server object type that derives from IlsEntity to the server model interpreter.

It must be used with the macros ILS_ENTITY_BEGIN() / ILS_ENTITY_END(). The Server object types you declare using this macro can then be associated with representations in view specifications. This macro also lets you declare runtime entry data members, derived data members, and relations for the Server object type.

This macro declares the Server Type typeNm as being accessible at runtime.

The class typeNm must derive from IlsEntity directly or transitively, and contain a constructor that takes an IlsString argument, as follows:
typeNm::typeNm(IlsString identifier)

This argument is the entity identifier.

This constructor is called when the component notifies the server that a new representation object associated with the Server object has been created.
See the second constructor of the class IlsRpObject.

The argument identifier is set to the value of the first representation attribute that is set by the component on the new representation objects, provided this attribute complies with the following conditions:
- The attribute is directly mapped to the entity identifier in the dynamic view specification (see "Semantics of Dynamic View Type Specifications").
- The attribute identifier has been set just after the object has been created (see IlsRpObject::onUpdate()).
- The creation of the new rp object and the updating of the attribute occur within the same representation transaction. See the member functions IlsRepresentation::beginC2STransaction() and IlsRepresentation::commitC2STransaction() for more information.
This macro also defines the following function:
[static] typeNm* typeNm::Narrow(IlsViewed& object);

This static function performs a safe downcast on the object argument. It returns 0 if this argument is not of type objType or of a derived type.

See also: ILS_DERIVED_XXX(), IlsEntity, ILS_ENTITY_BEGIN() / ILS_ENTITY_END(), ILS_ENTITY_INIT(), ILS_ENTRY_XXX(), ILS_OBJECT_DECL(), IlsRepresentation, IlsRpObject, ILS_R_RELATION_1(), ILS_R_RELATION_N(), ILS_RW_RELATION_1(), ILS_RW_RELATION_N(), ILS_W_RELATION_1(), ILS_W_RELATION_N().

◆ ILS_ENTITY_END

#define ILS_ENTITY_END ( typeNm )

This macro and IL_ENTITY_BEGIN() declare a server object type deriving from IlsEntity to the server model interpreter.

They must be used with the macro ILS_ENTITY_DECL(). The Server object types you declare using these macros can then be associated with representations in view specifications.

These macros also let you declare runtime entry data members, derived data members, and relations for the Server object type. These macros are equivalent to the macros ILS_OBJECT_BEGIN ()/ILS_OBJECT_END(), except that they implicitly declare a runtime attribute identifier as an entry of type IlsString. This attribute is associated with the accessors and modifiers of the identifier of the class IlsEntity.

These macros require that a constructor taking an argument of type IlsString as a parameter be declared on the class objType (see ILS_ENTITY_DECL() for details).

The macros ILS_ENTITY_BEGIN() and ILS_ENTITY_END() must be added to the source file that defines the member functions of the class objType. Only macros that let you declare runtime entries, derived data members, and relations can be enclosed between these macros.

If objType derives from another Server object type, you have to use the macro ILS_ENTITY1_BEGIN(). In this case, objType dynamically inherits from the runtime entries, derived data members and relations of the parent type.

If objType derives from two other Server object types, you have to use the macro ILS_ENTITY2_BEGIN(). In this case, objType dynamically inherits from the runtime entries, derived data members and relations of the parent type.

Synopsis

See also: ILS_DERIVED_XXX(), IlsEntity, ILS_ENTITY_BEGIN(), ILS_ENTITY_INIT(), IlsEntry, ILS_OBJECT_BEGIN(), ILS_OBJECT_END(), ILS_OBJECT_DECL(), IlsRepresentation, IlsRpObject, ILS_R_RELATION_1(), ILS_R_RELATION_N(), ILS_W_RELATION_1(), ILS_RW_RELATION_1(), ILS_W_RELATION_N().

◆ ILS_ENTITY_INIT

#define ILS_ENTITY_INIT ( typeNm )

The declaration of a server entity class to the server model interpreter is automatically performed by a static initialization included in the macro ILS_ENTITY_BEGIN(). If this initialization is embedded into a library, the initialization process may be postponed depending on the platform. To work around this potential problem, the ILS_ENTITY_INIT() macro is supplied to force the runtime declaration of a server entity class at the beginning of the process. It should be used either isolated in a header or in a source file of the application at the beginning of the main function.

See also: ILS_ENTITY_BEGIN() / ILS_ENTITY_END(), ILS_MVVIEW_INIT(), ILS_OBJECT_INIT()

◆ ILS_ENTRY_BOOLEAN

#define ILS_ENTRY_BOOLEAN	(	holder,
		entryLabel
	)

This macro declares the entry data member specified by entryLabel as a runtime attribute of the class holder.

This attribute is of type Boolean. It can be modified.

See also: ILS_ENTRY_XXX().

◆ ILS_ENTRY_CHAR

#define ILS_ENTRY_CHAR	(	holder,
		entryLabel
	)

This macro declares the entry data member specified by entryLabel as a runtime attribute of the class holder.

This attribute is of type char. It can be modified.

See also: ILS_ENTRY_XXX().

◆ ILS_ENTRY_DOUBLE

#define ILS_ENTRY_DOUBLE	(	holder,
		entryLabel
	)

This macro declares the entry data member specified by entryLabel as a runtime attribute of the class holder.

This attribute is of type double. It can be modified.

See also: ILS_ENTRY_XXX().

◆ ILS_ENTRY_ENUM

#define ILS_ENTRY_ENUM	(	holder,
		entryType,
		entryLabel
	)

This macro declares the entry data member specified by entryLabel as a runtime attribute of the class holder.

This attribute is of user-defined enum type. It can be modified.

See also: ILS_ENTRY_XXX().

◆ ILS_ENTRY_FLOAT

#define ILS_ENTRY_FLOAT	(	holder,
		entryLabel
	)

This macro declares the entry data member specified by entryLabel as a runtime attribute of the class holder.

This attribute is of type float. It can be modified.

See also: ILS_ENTRY_XXX().

◆ ILS_ENTRY_INT

#define ILS_ENTRY_INT	(	holder,
		entryLabel
	)

This macros declares the entry data member specified by entryLabel as a runtime attribute of the class holder.

Since Rogue Wave Server does not differentiate between the int and long types, this macro is equivalent to ILS_ENTRY_LONG() and the attribute is of type long. It cannot be modified.

See also: ILS_ENTRY_XXX(), ILS_ENTRY_LONG().

◆ ILS_ENTRY_LONG

#define ILS_ENTRY_LONG	(	holder,
		entryLabel
	)

This macros declares the entry data member specified by entryLabel as a runtime attribute of the class holder.

Since Rogue Wave Server does not differentiate between the int and long types, this macro is equivalent to ILS_ENTRY_INT() and the attribute is of type long. It cannot be modified.

See also: ILS_ENTRY_XXX(), ILS_ENTRY_INT().

◆ ILS_ENTRY_MVVALUE

#define ILS_ENTRY_MVVALUE	(	holder,
		entryLabel
	)

This macro declares the entry data member specified by entryLabel as a runtime attribute of the class holder.

This attribute is of type IlsMvValue. It can be modified.

See also: ILS_ENTRY_XXX().

◆ ILS_ENTRY_SHORT

#define ILS_ENTRY_SHORT	(	holder,
		entryLabel
	)

This macro declares the entry data member specified by entryLabel as a runtime attribute of the class holder.

This attribute is of type short. It can be modified.

See also: ILS_ENTRY_XXX().

◆ ILS_ENTRY_STRING

#define ILS_ENTRY_STRING	(	holder,
		entryLabel
	)

This macro declares the entry data member specified by entryLabel as a runtime attribute of the class holder.

This attribute is of type IlsString or char*. It can be modified.

See also: ILS_ENTRY_XXX().

◆ ILS_ENTRY_USERTYPE

#define ILS_ENTRY_USERTYPE	(	holder,
		entryType,
		entryLabel
	)

This macro declares the entry data member specified by entryLabel as a runtime attribute of the class holder.

This attribute is of the user-defined type entryType. For details, see the macros ILS_USERTYPE_DECL()/ILS_USERTYPE_DEF(). It can be modified.

See also: ILS_ENTRY_XXX().

◆ ILS_ENTRY_XXX

#define ILS_ENTRY_XXX ( )

The macros ILS_ENTRY_XXX() declare Server entry data members as being accessible at runtime so that they can be used in view specifications.

These runtime attributes use the IlsEntry member functions IlsEntry::getValue(), IlsEntry::set() and IlsEntry::isModified().

These macros can only be enclosed only between the following pairs of macros:

ILS_OBJECT_BEGIN() / ILS_OBJECT_END()
ILS_ENTITY_BEGIN() / ILS_ENTITY_END()
ILS_MVVIEW_BEGIN() / ILS_MVVIEW_END()

or their derivatives.

Synopsis

See also: IlsDerived, IlsEntry, ILS_W_ENTRY_XXX(), ILS_RW_ATTRIBUTE_XXX(), ILS_DERIVED_XXX()

◆ ILS_GLOBAL_FUNCTION

#define ILS_GLOBAL_FUNCTION ( )

These macros declare global functions as being accessible at runtime, so that they can be used in dynamic view type specifications.

They MUST NOT be enclosed between the following pairs of macros:

ILS_OBJECT_BEGIN() / ILS_OBJECT_END()
ILS_ENTITY_BEGIN() / ILS_ENTITY_END()
ILS_MVVIEW_BEGIN() / ILS_MVVIEW_END()

Synopsis

These macros take the following arguments, in this order:

the type of the value returned by the function,
the function name
the types of the function parameters.

All the global runtime functions must have a unique name. The result and the parameters of a global function can be of the following types:

char
char*
IlsString
IlsBoolean
short
int
long
float
double
any type that derives from IlsMvUserType.

When a runtime-accessible global function is called from a component, the result is not sent back to this component, because the callback mechanism is completely asynchronous. However, to allow for the requirements of type macro expansion, such a function cannot have a result of type void.

◆ ILS_GLOBAL_FUNCTION0

#define ILS_GLOBAL_FUNCTION0	(	resType,
		funNm
	)

declare global function with no parameter to runtime interpreter.

Parameters

resType	type of the returned value
funNm	function name

See also: ILS_GLOBAL_FUNCTION().

◆ ILS_GLOBAL_FUNCTION1

#define ILS_GLOBAL_FUNCTION1	(	resType,
		funNm,
		p1Type
	)

declare global function with one parameter to runtime interpreter.

Parameters

resType	type of the returned value
funNm	function name
p1Type	type of first parameter

See also: ILS_GLOBAL_FUNCTION().

◆ ILS_GLOBAL_FUNCTION2

#define ILS_GLOBAL_FUNCTION2	(	resType,
		funNm,
		p1Type,
		p2Type
	)

declare global function with two parameters to runtime interpreter.

Parameters

resType	type of the returned value
funNm	function name
p1Type	type of first parameter
p2Type	type of second parameter

See also: ILS_GLOBAL_FUNCTION().

◆ ILS_GLOBAL_FUNCTION3

#define ILS_GLOBAL_FUNCTION3	(	resType,
		funNm,
		p1Type,
		p2Type,
		p3Type
	)

declare global function with three parameters to runtime interpreter.

Parameters

resType	type of the returned value
funNm	function name
p1Type	type of first parameter
p2Type	type of second parameter
p3Type	type of third parameter

See also: ILS_GLOBAL_FUNCTION().

◆ ILS_GLOBAL_FUNCTION4

#define ILS_GLOBAL_FUNCTION4	(	resType,
		funNm,
		p1Type,
		p2Type,
		p3Type,
		p4Type
	)

declare global function with four parameters to runtime interpreter.

Parameters

resType	type of the returned value
funNm	function name
p1Type	type of first parameter
p2Type	type of second parameter
p3Type	type of third parameter
p4Type	type of fourth parameter

See also: ILS_GLOBAL_FUNCTION().

◆ ILS_GLOBAL_FUNCTION5

#define ILS_GLOBAL_FUNCTION5	(	resType,
		funNm,
		p1Type,
		p2Type,
		p3Type,
		p4Type,
		p5Type
	)

declare global function with five parameters to runtime interpreter.

Parameters

resType	type of the returned value
funNm	function name
p1Type	type of first parameter
p2Type	type of second parameter
p3Type	type of third parameter
p4Type	type of fourth parameter
p5Type	type of fifth parameter

See also: ILS_GLOBAL_FUNCTION().

◆ ILS_GLOBAL_FUNCTION6

#define ILS_GLOBAL_FUNCTION6	(	resType,
		funNm,
		p1Type,
		p2Type,
		p3Type,
		p4Type,
		p5Type,
		p6Type
	)

declare global function with six parameters to runtime interpreter.

Parameters

resType	type of the returned value
funNm	function name
p1Type	type of first parameter
p2Type	type of second parameter
p3Type	type of third parameter
p4Type	type of fourth parameter
p5Type	type of fifth parameter
p6Type	type of sixth parameter

See also: ILS_GLOBAL_FUNCTION().

◆ ILS_GLOBAL_FUNCTION7

#define ILS_GLOBAL_FUNCTION7	(	resType,
		funNm,
		p1Type,
		p2Type,
		p3Type,
		p4Type,
		p5Type,
		p6Type,
		p7Type
	)

declare global function with seven parameters to runtime interpreter.

Parameters

resType	type of the returned value
funNm	function name
p1Type	type of first parameter
p2Type	type of second parameter
p3Type	type of third parameter
p4Type	type of fourth parameter
p5Type	type of fifth parameter
p6Type	type of sixth parameter
p7Type	type of seventh parameter

See also: ILS_GLOBAL_FUNCTION().

◆ ILS_INVERTED_1

#define ILS_INVERTED_1	(	target,
		origin,
		invRelNm,
		relNm
	)

This macro declares a server relation of type IlsInvertedRelation as being accessible at runtime so that it can be used in view specifications.

The runtime relation is defined by the accessors and modification test of the Rogue Wave Server inverted-relation template. This means that Rogue Wave Server uses the functions of the class template IlsInvertedRelation to get the target of the relation and to test if this target has been modified.

A runtime inverse relation declared using the macro ILS_INVERTED_1() is editable if the direct relation is itself editable – that is, if it is associated with a modifier.

This macro can only be enclosed between the following pairs of macros:

ILS_OBJECT_BEGIN() / ILS_OBJECT_END()
ILS_ENTITY_BEGIN() / ILS_ENTITY_END()
ILS_MVVIEW_BEGIN() / ILS_MVVIEW_END()

or their derivatives.

Parameters

target	is the type bearing the inverse relation.
origin	is the target type for the inverse relation.
invRelNm	is the name of the inverse relation.
relNm	is the name of the relation that is inverted.

See also: ILS_INVERTED_N(), IlsInvertedRelation, ILS_R_RELATION_1().

◆ ILS_INVERTED_N

#define ILS_INVERTED_N	(	target,
		origin,
		invRelNm,
		relNm
	)

This macro declares a server relation of type IlsInvertedRelationList as being accessible at runtime so that it can be used in view specifications.

This runtime relation uses the accessors defined in the IlsInvertedRelationList class template.

A runtime inverse relation declared using the macro ILS_INVERTED_N() is editable if the direct relation is itself editable – that is, if it is associated with a modifier.

This macro can only be enclosed between the following pairs of macros:

ILS_OBJECT_BEGIN() / ILS_OBJECT_END()
ILS_ENTITY_BEGIN() / ILS_ENTITY_END()
ILS_MVVIEW_BEGIN() / ILS_MVVIEW_END()

or their derivatives.

Parameters

target	is the type bearing the inverse relation.
origin	is the target type for the inverse relation.
invRelNm	is the name of the inverse relation.
relNm	is the name of the relation which is inverted.

See also: ILS_INVERTED_1(), IlsInvertedRelationList, ILS_R_RELATION_N()

◆ ILS_MEMBER_FUNCTION

#define ILS_MEMBER_FUNCTION ( )

These macros declare member functions of Server classes as being accessible at runtime, so that they can be used in dynamic view type specifications. They also enable a component to invoke the declared functions on server objects.

This macro can only be enclosed between the following pairs of macros:

ILS_OBJECT_BEGIN() / ILS_OBJECT_END()
ILS_ENTITY_BEGIN() / ILS_ENTITY_END()
ILS_MVVIEW_BEGIN() / ILS_MVVIEW_END()

or their derivatives.

Synopsis

These macros take the following arguments in this order:

the type of the function return value,
the Server type to which the member function belongs,
the function name,
the types of the function parameters.

All the runtime member functions of a same class must have a unique name. The result and the parameters of a member function can be of the following types:

char
IlsString
IlsBoolean
short
int
long
float
double
Any type that derives from IlsMvUserType.

When a runtime-accessible member function is called from the component, the result is not sent back to this component, since the callback mechanism is completely asynchronous. However, to allow for macro expansion requirements, such a function cannot have a result of type void.

See also: ILS_ENTITY_BEGIN() / ILS_ENTITY_END(), ILS_MVVIEW_BEGIN() / ILS_MVVIEW_END(), ILS_OBJECT_BEGIN() / ILS_OBJECT_END().

◆ ILS_MEMBER_FUNCTION0

#define ILS_MEMBER_FUNCTION0	(	resType,
		objType,
		funNm
	)

declare member function with no parameter to runtime interpreter.

Parameters

resType	type of the returned value
objType	Server type to which the member function belongs
funNm	function name

See also: ILS_MEMBER_FUNCTION().

◆ ILS_MEMBER_FUNCTION1

#define ILS_MEMBER_FUNCTION1	(	resType,
		objType,
		funNm,
		p1Type
	)

declare member function with one parameter to runtime interpreter.

Parameters

resType	type of the returned value
objType	Server type to which the member function belongs
funNm	function name
p1Type	type of first parameter

See also: ILS_MEMBER_FUNCTION().

◆ ILS_MEMBER_FUNCTION2

#define ILS_MEMBER_FUNCTION2	(	resType,
		objType,
		funNm,
		p1Type,
		p2Type
	)

declare member function with two parameters to runtime interpreter.

Parameters

resType	type of the returned value
objType	Server type to which the member function belongs
funNm	function name
p1Type	type of first parameter
p2Type	type of second parameter

See also: ILS_MEMBER_FUNCTION().

◆ ILS_MEMBER_FUNCTION3

#define ILS_MEMBER_FUNCTION3	(	resType,
		objType,
		funNm,
		p1Type,
		p2Type,
		p3Type
	)

declare member function with three parameters to runtime interpreter.

Parameters

resType	type of the returned value
objType	Server type to which the member function belongs
funNm	function name
p1Type	type of first parameter
p2Type	type of second parameter
p3Type	type of third parameter

See also: ILS_MEMBER_FUNCTION().

◆ ILS_MEMBER_FUNCTION4

#define ILS_MEMBER_FUNCTION4	(	resType,
		objType,
		funNm,
		p1Type,
		p2Type,
		p3Type,
		p4Type
	)

declare member function with four parameters to runtime interpreter.

Parameters

resType	type of the returned value
objType	Server type to which the member function belongs
funNm	function name
p1Type	type of first parameter
p2Type	type of second parameter
p3Type	type of third parameter
p4Type	type of fourth parameter

See also: ILS_MEMBER_FUNCTION().

◆ ILS_MEMBER_FUNCTION5

#define ILS_MEMBER_FUNCTION5	(	resType,
		objType,
		funNm,
		p1Type,
		p2Type,
		p3Type,
		p4Type,
		p5Type
	)

declare member function with five parameters to runtime interpreter.

Parameters

resType	type of the returned value
objType	Server type to which the member function belongs
funNm	function name
p1Type	type of first parameter
p2Type	type of second parameter
p3Type	type of third parameter
p4Type	type of fourth parameter
p5Type	type of fifth parameter

See also: ILS_MEMBER_FUNCTION().

◆ ILS_MEMBER_FUNCTION6

#define ILS_MEMBER_FUNCTION6	(	resType,
		objType,
		funNm,
		p1Type,
		p2Type,
		p3Type,
		p4Type,
		p5Type,
		p6Type
	)

declare member function with six parameters to runtime interpreter.

Parameters

resType	type of the returned value
objType	Server type to which the member function belongs
funNm	function name
p1Type	type of first parameter
p2Type	type of second parameter
p3Type	type of third parameter
p4Type	type of fourth parameter
p5Type	type of fifth parameter
p6Type	type of sixth parameter

See also: ILS_MEMBER_FUNCTION().

◆ ILS_MEMBER_FUNCTION7

#define ILS_MEMBER_FUNCTION7	(	resType,
		objType,
		funNm,
		p1Type,
		p2Type,
		p3Type,
		p4Type,
		p5Type,
		p6Type,
		p7Type
	)

declare member function with seven parameters to runtime interpreter.

Parameters

resType	type of the returned value
objType	Server type to which the member function belongs
funNm	function name
p1Type	type of first parameter
p2Type	type of second parameter
p3Type	type of third parameter
p4Type	type of fourth parameter
p5Type	type of fifth parameter
p6Type	type of sixth parameter
p7Type	type of seventh parameter

See also: ILS_MEMBER_FUNCTION().

◆ ILS_MVVIEW_BEGIN

#define ILS_MVVIEW_BEGIN	(	typeNm,
		parent
	)

This macro and ILS_MVVIEW_END() declare a subtype of IlsMvView to the view interpreter on the server side.

This declaration lets you specify dynamic view types that will be instantiated by a subtype of IlsMvView. These macros must be used with the macro ILS_MVVIEW_DECL().

Synopsis

ILS_MVVIEW_BEGIN(viewType,parentType)

ILS_MVVIEW_END(viewType)

Arguments

Both these macros must be added to the source file that defines the member functions for the class viewType. The argument parentType is the view type that is the base class of viewType. This is usually the type IlsMvView but it can be another subtype of IlsMvView, provided this subtype has been declared using the macros ILS_MVVIEW_DECL() and ILS_MVVIEW_BEGIN() / ILS_MVVIEW_END(). Only macros that declare runtime access to data members and member functions can be enclosed between these macros.

See also: ILS_DERIVED_XXX(), ILS_ENTRY_XXX(), IlsMvView, ILS_MVVIEW_DECL(), ILS_MVVIEW_INIT(), ILS_R_RELATION_1(), ILS_R_RELATION_N(), ILS_RP_ATTR_XXX(), ILS_RW_RELATION_1(), ILS_RW_RELATION_N(), ILS_W_RELATION_1(), ILS_W_RELATION_N().

◆ ILS_MVVIEW_DECL

#define ILS_MVVIEW_DECL ( typeNm )

This macro declares a subtype of IlsMvView to the view interpreter on the server side.

This declaration lets you specify dynamic view types that will be instantiated by a subtype of IlsMvView. It must be used together with the macros ILS_MVVIEW_BEGIN() / ILS_MVVIEW_END().

For example, the following view specification:

view NetworkPanel:...

causes an instance of IlsMvView to be created each time a view NetworkPanel is opened.

However, the following view specification:

view NetworkPanel is MyMvView:...

causes an instance of MyMvView to be created each time a view NetworkPanel is opened.

This macro declares the constructor of viewType to the view interpreter, which runs on the server side. Just as the macro ILS_OBJECT_DECL() does for the Server type objType, the macro ILS_MVVIEW_DECL() also declares viewType as a Server type accessible at runtime. The class typeNm must inherit from IlsMvView directly or transitively. It must also declare and define a constructor with the following signature:

typeNm::typeNm(IlsMvComponentItf& compItf,
               IlsViewed* mainOriginP,
               const IlsMvViewType& viewType,
               IlsMvValue* params,
               int nbParams)

This constructor should trigger the corresponding constructor of its parent class. For instance:

MyViewType::MyViewType(IlsMvComponentItf& compItf,
                       IlsViewed* mainOriginP,
                       const IlsMvViewType& viewType,
                       IlsMvValue* params,
                      int nbParams)
: IlsMvView(compItf,mainOriginP,viewType,params,nbParams)
{       
  // ...
}

The class viewType must also declare a default constructor, which exists only to declare viewType as a Server object type, but is never used.

This macro defines the following function:

[static]

viewType* viewType::Narrow(IlsMvView& view);

This static function performs a safe downcast on view. It returns 0 if view is not of the type viewType or of a derived type.

See also: ILS_OBJECT_DECL(), IlsMvView, ILS_MVVIEW_BEGIN() / ILS_MVVIEW_END(), ILS_MVVIEW_INIT().

◆ ILS_MVVIEW_END

#define ILS_MVVIEW_END ( typeNm )

This macro and ILS_MVVIEW_BEGIN() declare a subtype of IlsMvView to the view interpreter on the server side.

This declaration lets you specify dynamic view types that will be instantiated by a subtype of IlsMvView. These macros must be used with the macro ILS_MVVIEW_DECL().

Synopsis

ILS_MVVIEW_BEGIN(viewType,parentType)

ILS_MVVIEW_END(viewType)

Arguments

Both these macros must be added to the source file that defines the member functions for the class viewType. The argument parentType is the view type that is the base class of viewType. This is usually the type IlsMvView but it can be another subtype of IlsMvView, provided this subtype has been declared using the macros ILS_MVVIEW_DECL() and ILS_MVVIEW_BEGIN() / ILS_MVVIEW_END(). Only macros that declare runtime access to data members and member functions can be enclosed between these macros.

See also: ILS_DERIVED_XXX(), ILS_ENTRY_XXX(), IlsMvView, ILS_MVVIEW_DECL(), ILS_MVVIEW_INIT(), ILS_R_RELATION_1(), ILS_R_RELATION_N(), ILS_RP_ATTR_XXX(), ILS_RW_RELATION_1(), ILS_RW_RELATION_N(), ILS_W_RELATION_1(), ILS_W_RELATION_N().

◆ ILS_MVVIEW_INIT

#define ILS_MVVIEW_INIT ( typeNm )

A subtype of the class IlsMvView is automatically declared to the server dynamic view interpreter by a static initialization of a variable included in the macro ILS_MVVIEW_BEGIN() / ILS_MVVIEW_END(). If this variable is embedded in a library, the initialization may be postponed depending on the platform. To work around this potential problem, the ILS_MVVIEW_INIT() macro is supplied to force the runtime declaration of an IlsMvView-derived class at the beginning of the process. It should be used either isolated in a header or in a source file of the application at the beginning of the main function.

See also: ILS_ENTITY_INIT(), ILS_OBJECT_INIT(), IlsMvView, ILS_MVVIEW_BEGIN() / ILS_MVVIEW_END().

◆ ILS_OBJECT1_BEGIN

#define ILS_OBJECT1_BEGIN	(	typeNm,
		parent1
	)

declare an object type that derives from another server object type to runtime interpreter.

Parameters

typeNm	object class name
parent1	parent class

See also: ILS_OBJECT_BEGIN().

◆ ILS_OBJECT1_WITH_ID_BEGIN

#define ILS_OBJECT1_WITH_ID_BEGIN	(	typeNm,
		ident,
		parent1
	)

This macro is similar to ILS_OBJECT1_BEGIN() subject to the same conditions as ILS_OBJECT_WITH_ID_BEGIN().

◆ ILS_OBJECT2_BEGIN

#define ILS_OBJECT2_BEGIN	(	typeNm,
		parent1,
		parent2
	)

declare an object type that derives from two other server object types to runtime interpreter.

Parameters

typeNm	object class name
parent1	parent 1 class
parent2	parent 2 class

See also: ILS_OBJECT_BEGIN().

◆ ILS_OBJECT2_WITH_ID_BEGIN

#define ILS_OBJECT2_WITH_ID_BEGIN	(	typeNm,
		ident,
		parent1,
		parent2
	)

This macro is similar to ILS_OBJECT2_BEGIN() subject to the same conditions as ILS_OBJECT_WITH_ID_BEGIN().

◆ ILS_OBJECT_BEGIN

#define ILS_OBJECT_BEGIN ( typeNm )

This macro with ILS_OBJECT_END() declares a server object class deriving from IlsObject to the server model interpreter.

It associates a runtime type to the C++ class. They must be used with the macro ILS_OBJECT_DECL(). The server object types you declare using those macros can then be referred to in dynamic view type specifications. This macro also lets you declare runtime access to data members and member functions for the server object type.

You can use this macro to declare server object types that derive from IlsEntity if you do not want an implicit declaration of the runtime identifier to be performed, as it is the case with the macro ILS_ENTITY_DECL().

Synopsis

The macros ILS_OBJECT_BEGIN() / ILS_OBJECT_END() must be added to the source file that defines the member functions of the class objType. Only macros that let you declare runtime entries, derived data members and relations can be enclosed between these macros.

If objType derives from another server object type, you have to use the macro ILS_OBJECT1_BEGIN(). In this case, the runtime type associated to objType dynamically inherits from the runtime access to data members and member functions of the parent type.

Note: An attribute, relation or function of a runtime type hides any corresponding attribute, relation or function in parent types.

If objType derives from two other server object types, you have to use the macro ILS_OBJECT2_BEGIN(). In this case, the runtime type associated to objType dynamically inherits from the runtime entries, derived data members and relations of the parent types. The pair of macros ILS_OBJECT2_BEGIN() / ILS_OBJECT_END() replaces the static view-related macro ILS_VIEWED2_DEF().

See also: ILS_DERIVED_XXX(), ILS_ENTITY_BEGIN() / ILS_ENTITY_END(), ILS_ENTITY_DECL(), ILS_ENTRY_XXX(), IlsObject, ILS_OBJECT_DECL(), ILS_OBJECT_INIT(), IlsRepresentation, IlsRpObject, ILS_R_RELATION_1(), ILS_R_RELATION_N(), ILS_RW_RELATION_1(), ILS_RW_RELATION_N(), ILS_W_RELATION_1(), ILS_RW_RELATION_N().

◆ ILS_OBJECT_DECL

#define ILS_OBJECT_DECL ( typeNm )

This macro declares a server object type deriving from IlsObject to the server model interpreter.

It must be used together with the macros ILS_OBJECT_BEGIN() / ILS_OBJECT_END(). The server object types you declare using that macro can then be associated with representations in view specifications. This macro also lets you declare runtime entry data member, derived data members, and relations for the server object type.

This macro declares the server type objType as being accessible at runtime. The class objType must derive from IlsObject directly or transitively and must contain a default constructor. This constructor is called when the component notifies the server that a new representation object associated with the server object has been created.

This macro also defines the following function:

[static]

objType* objType::Narrow(IlsViewed& object)

This static function performs a safe downcast on object. It returns 0 if object is not of type objType or of a derived type.

See also: IlsEntity, ILS_ENTITY_DECL(), IlsObject, ILS_OBJECT_BEGIN() / ILS_OBJECT_END(), ILS_OBJECT_INIT().

◆ ILS_OBJECT_END

#define ILS_OBJECT_END ( typeNm )

This macro with ILS_OBJECT_BEGIN() declares a server object class deriving from IlsObject to the server model interpreter.

It associates a runtime type to the C++ class. They must be used with the macro ILS_OBJECT_DECL(). The server object types you declare using those macros can then be referred to in dynamic view type specifications. This macro also lets you declare runtime access to data members and member functions for the server object type.

You can use this macro to declare server object types that derive from IlsEntity if you do not want an implicit declaration of the runtime identifier to be performed, as it is the case with the macro ILS_ENTITY_DECL().

Synopsis

The macros ILS_OBJECT_BEGIN() / ILS_OBJECT_END() must be added to the source file that defines the member functions of the class objType. Only macros that let you declare runtime entries, derived data members and relations can be enclosed between these macros.

If objType derives from another server object type, you have to use the macro ILS_OBJECT1_BEGIN(). In this case, the runtime type associated to objType dynamically inherits from the runtime access to data members and member functions of the parent type.

Note: An attribute, relation or function of a runtime type hides any corresponding attribute, relation or function in parent types.

If objType derives from two other server object types, you have to use the macro ILS_OBJECT2_BEGIN(). In this case, the runtime type associated to objType dynamically inherits from the runtime entries, derived data members and relations of the parent types. The pair of macros ILS_OBJECT2_BEGIN() / ILS_OBJECT_END() replaces the static view-related macro ILS_VIEWED2_DEF().

See also: ILS_DERIVED_XXX(), ILS_ENTITY_BEGIN() / ILS_ENTITY_END(), ILS_ENTITY_DECL(), ILS_ENTRY_XXX(), IlsObject, ILS_OBJECT_DECL(), ILS_OBJECT_INIT(), IlsRepresentation, IlsRpObject, ILS_R_RELATION_1(), ILS_R_RELATION_N(), ILS_RW_RELATION_1(), ILS_RW_RELATION_N(), ILS_W_RELATION_1(), ILS_RW_RELATION_N().

◆ ILS_OBJECT_INIT

#define ILS_OBJECT_INIT ( typeNm )

A server object class is automatically declared to the server model interpreter by a static initialization of a variable included in the macro ILS_OBJECT_BEGIN() / ILS_OBJECT_END(). If this variable is embedded into a library, this initialization may be postponed, depending on the platform. To work around this potential problem, the ILS_OBJECT_INIT() macro is supplied to force the runtime declaration of a server object class at the beginning of the process. It should be used either isolated in a header or in a source file of the application at the beginning of the main function.

See also: ILS_ENTITY_INIT(), ILS_MVVIEW_INIT(), ILS_OBJECT_BEGIN() / ILS_OBJECT_END().

◆ ILS_OBJECT_WITH_ID_BEGIN

#define ILS_OBJECT_WITH_ID_BEGIN	(	typeNm,
		ident
	)

This macro is similar to ILS_OBJECT_BEGIN() except that it declares the attribute ident as being the typeNm type identifier. idAttr must be declared as a runtime attribute of typeNm or of a parent type.

Moreover, this macro requires that typeNm have a constructor taking an IlsString argument:

typeNm::typeNm(IlsString identifier)

This argument is the identifier of the object. This constructor is called when a component creates a representation object using the second constructor of the class IlsRpObject and only if the model of this representation object is associated to typeNm.

As in entity construction, the argument passed to the typeNm constructor will be set to the value of the first representation object attribute that complies with the following conditions:

The attribute is directly mapped to the entity identifier in the dynamic view specification (see "Semantics of Dynamic View Type Specifications").
The attribute value has been set just after the object has been created (see IlsRpObject::onUpdate()).
The creation of the new rp object and the attribute update occurs in the same representation transaction (see IlsRepresentation::beginC2STransaction() and IlsRepresentation::commitC2STransaction()).

If no representation object attribute complies with the above conditions, the argument is set to the null string.

Note: This macro can be used instead of one of the ILS_ENTITY_xxx() macros to declare an entity – for example, if you need to redefine the accessor and modifier of the entity identifier.

See also: ILS_OBJECT_BEGIN().

◆ ILS_OWNS_1

#define ILS_OWNS_1	(	origin,
		target,
		relNm
	)

This macro declares a server relation of type IlsOwns as being accessible at runtime so that it can be used in view specifications.

The runtime relation uses the relation accessor, the relation target accessor, and the modifier defined in the IlsOwns class template.

This macro can only be enclosed between the following pairs of macros:

ILS_OBJECT_BEGIN() / ILS_OBJECT_END()
ILS_ENTITY_BEGIN() / ILS_ENTITY_END()
ILS_MVVIEW_BEGIN() / ILS_MVVIEW_END()

or their derivatives.

Parameters

origin	is the class where the relation is declared.
target	is the class of the relation target.
relNm	is the name of the relation.

See also: IlsOwns, ILS_OWNS_N, ILS_R_RELATION_1, ILS_RW_RELATION_1, ILS_RW_RELATION_1, IlsViewedRel

◆ ILS_OWNS_N

#define ILS_OWNS_N	(	origin,
		target,
		relNm
	)

This macro declares a multiple server relation of type IlsOwnsList, IlsOwnsSet, IlsOwnsDynamicArray, or IlsOwnsFixedArray as being accessible at runtime so that it can be used in view specifications.

This runtime relation uses the accessors and modifiers defined in the IlsOwnsxxx class template that corresponds to its C++ type.

This macro can only be enclosed between the following pairs of macros:

ILS_OBJECT_BEGIN() / ILS_OBJECT_END()
ILS_ENTITY_BEGIN() / ILS_ENTITY_END()
ILS_MVVIEW_BEGIN() / ILS_MVVIEW_END()

or their derivatives.

Parameters

origin	is the class where the relation is declared.
target	is the class of the relation target.
relNm	is the name of the relation.

See also: ILS_OWNS_1(), IlsOwnsDynamicArray, IlsOwnsFixedArray, IlsOwnsList, IlsOwnsSet, ILS_R_RELATION_N(), ILS_RW_RELATION_N(), ILS_W_RELATION_N().

◆ ILS_R_ATTRIBUTE_BOOLEAN

#define ILS_R_ATTRIBUTE_BOOLEAN	(	holder,
		attrLabel,
		getValue,
		isModified,
		updEagerness
	)

This macro declares attrLabel as a runtime attribute of the class holder. This attribute is of type IlsBoolean and cannot be modified.

Its accessor, getValue(), has the following signature:
IlsBoolean holder::getValue();

This signature can vary under the following conditions:
- The function is a member of the class or of a parent class.
- Its result converts to IlsBoolean.
- It can be invoked without arguments.
Its modifier test function, isModified(), has the following signature:
IlsBoolean holder::isModified();

This signature can vary under the following conditions:
- The function is a member of the class or of a parent class.
- Its result converts to IlsBoolean.
- It can be invoked without arguments.
The update eagerness function has the following signature:
void holder::updEagerness(IlsBoolean increment);

When the increment argument is set to IlsTrue, this means that a new view is interested by the atttribute value. Conversely, IlsFalse means that a view is no longer interested in the attribute value. The signature can be different under the following conditions:
- It is a member of the class or of a derived class.
- It can be invoked with a boolean as argument.

See also: ILS_R_ATTRIBUTE_XXX().

◆ ILS_R_ATTRIBUTE_CHAR

#define ILS_R_ATTRIBUTE_CHAR	(	holder,
		attrLabel,
		getValue,
		isModified,
		updEagerness
	)

This macro declares attrLabel as a runtime attribute of the class holder. This attribute is of type char and cannot be modified.

Its accessor, getValue(), has the following signature:
char holder::getValue();

This signature can vary under the following conditions:
- The function is a member of the class or of a parent class.
- Its result converts to char.
- It can be invoked without arguments.
Its modifier test function, isModified(), has the following signature:
IlsBoolean holder::isModified();

This signature can vary under the following conditions:
- The function is a member of the class or of a parent class.
- Its result converts to IlsBoolean.
- It can be invoked without arguments.
The update eagerness function has the following signature:
void holder::updEagerness(IlsBoolean increment);

When the increment argument is set to IlsTrue, this means that a new view is interested by the atttribute value. Conversely, IlsFalse means that a view is no longer interested in the attribute value. The signature can be different under the following conditions:
- It is a member of the class or of a derived class.
- It can be invoked with a boolean as argument.

See also: ILS_R_ATTRIBUTE_XXX().

◆ ILS_R_ATTRIBUTE_DOUBLE

#define ILS_R_ATTRIBUTE_DOUBLE	(	holder,
		attrLabel,
		getValue,
		isModified,
		updEagerness
	)

This macro declares attrLabel as a runtime attribute of the class holder. This attribute is of type double and cannot be modified.

Its accessor, getValue(), has the following signature:
double holder::getValue();

This signature can vary under the following conditions:
- The function is a member of the class or of a parent class.
- Its result converts to double.
- It can be invoked without arguments.
Its modifier test function, isModified(), has the following signature:
IlsBoolean holder::isModified();

This signature can vary under the following conditions:
- The function is a member of the class or of a parent class.
- Its result converts to IlsBoolean.
- It can be invoked without arguments.
The update eagerness function has the following signature:
void holder::updEagerness(IlsBoolean increment);

When the increment argument is set to IlsTrue, this means that a new view is interested by the atttribute value. Conversely, IlsFalse means that a view is no longer interested in the attribute value. The signature can be different under the following conditions:
- It is a member of the class or of a derived class.
- It can be invoked with a boolean as argument.

See also: ILS_R_ATTRIBUTE_XXX().

◆ ILS_R_ATTRIBUTE_ENUM

#define ILS_R_ATTRIBUTE_ENUM	(	holder,
		attrType,
		attrLabel,
		getValue,
		isModified,
		updEagerness
	)

This macro declares attrLabel as a runtime attribute of the class holder. This attribute is of enum type attrType and cannot be modified.

Its accessor, getValue(), has the following signature:
attrType holder::getValue();

This signature can vary under the following conditions:
- The function is a member of the class or of a parent class.
- Its result converts to attrType.
- It can be invoked without arguments.
Its modifier test function, isModified(), has the following signature:
IlsBoolean holder::isModified();

This signature can vary under the following conditions:
- The function is a member of the class or of a parent class.
- Its result converts to IlsBoolean.
- It can be invoked without arguments.
The update eagerness function has the following signature:
void holder::updEagerness(IlsBoolean increment);

When the increment argument is set to IlsTrue, this means that a new view is interested by the atttribute value. Conversely, IlsFalse means that a view is no longer interested in the attribute value. The signature can be different under the following conditions:
- It is a member of the class or of a derived class.
- It can be invoked with a boolean as argument.

See also: ILS_R_ATTRIBUTE_XXX().

◆ ILS_R_ATTRIBUTE_FLOAT

#define ILS_R_ATTRIBUTE_FLOAT	(	holder,
		attrLabel,
		getValue,
		isModified,
		updEagerness
	)

This macro declares attrLabel as a runtime attribute of the class holder. This attribute is of type float and cannot be modified.

Its accessor, getValue(), has the following signature:
float holder::getValue();

This signature can vary under the following conditions:
- The function is a member of the class or of a parent class.
- Its result converts to float.
- It can be invoked without arguments.
Its modifier test function, isModified(), has the following signature:
IlsBoolean holder::isModified();

This signature can vary under the following conditions:
- The function is a member of the class or of a parent class.
- Its result converts to IlsBoolean.
- It can be invoked without arguments.
The update eagerness function has the following signature:
void holder::updEagerness(IlsBoolean increment);

When the increment argument is set to IlsTrue, this means that a new view is interested by the atttribute value. Conversely, IlsFalse means that a view is no longer interested in the attribute value. The signature can be different under the following conditions:
- It is a member of the class or of a derived class.
- It can be invoked with a boolean as argument.

See also: ILS_R_ATTRIBUTE_XXX().

◆ ILS_R_ATTRIBUTE_INT

#define ILS_R_ATTRIBUTE_INT	(	holder,
		attrLabel,
		getValue,
		isModified,
		updEagerness
	)

This macro declares attrLabel as a runtime attribute of the class holder. This attribute is of type long and cannot be modified.

Its accessor, getValue(), has the following signature:
long holder::getValue();

This signature can vary under the following conditions:
- The function is a member of the class or of a parent class.
- Its result converts to long.
- It can be invoked without arguments.
Its modifier test function, isModified(), has the following signature:
IlsBoolean holder::isModified();

This signature can vary under the following conditions:
- The function is a member of the class or of a parent class.
- Its result converts to IlsBoolean.
- It can be invoked without arguments.
The update eagerness function has the following signature:
void holder::updEagerness(IlsBoolean increment);

When the increment argument is set to IlsTrue, this means that a new view is interested by the atttribute value. Conversely, IlsFalse means that a view is no longer interested in the attribute value. The signature can be different under the following conditions:
- It is a member of the class or of a derived class.
- It can be invoked with a boolean as argument.

See also: ILS_R_ATTRIBUTE_XXX().

◆ ILS_R_ATTRIBUTE_LONG

#define ILS_R_ATTRIBUTE_LONG	(	holder,
		attrLabel,
		getValue,
		isModified,
		updEagerness
	)

This macro declares attrLabel as a runtime attribute of the class holder. This attribute is of type long and cannot be modified.

Its accessor, getValue(), has the following signature:
long holder::getValue();

This signature can vary under the following conditions:
- The function is a member of the class or of a parent class.
- Its result converts to long.
- It can be invoked without arguments.
Its modifier test function, isModified(), has the following signature:
IlsBoolean holder::isModified();

This signature can vary under the following conditions:
- The function is a member of the class or of a parent class.
- Its result converts to IlsBoolean.
- It can be invoked without arguments.
The update eagerness function has the following signature:
void holder::updEagerness(IlsBoolean increment);

When the increment argument is set to IlsTrue, this means that a new view is interested by the atttribute value. Conversely, IlsFalse means that a view is no longer interested in the attribute value. The signature can be different under the following conditions:
- It is a member of the class or of a derived class.
- It can be invoked with a boolean as argument.

See also: ILS_R_ATTRIBUTE_XXX().

◆ ILS_R_ATTRIBUTE_MVVALUE

#define ILS_R_ATTRIBUTE_MVVALUE	(	holder,
		attrLabel,
		getValue,
		isModified,
		updEagerness
	)

This macro declares attrLabel as a runtime attribute of the class holder. This attribute is of type IlsMvValue and cannot be modified.

Its accessor, getValue(), has the following signature:
IlsMvValue holder::getValue();

This signature can vary under the following conditions:
- The function is a member of the class or of a parent class.
- Its result converts to IlsMvValue.
- It can be invoked without arguments.
Its modifier test function, isModified(), has the following signature:
IlsBoolean holder::isModified();

This signature can vary under the following conditions:
- The function is a member of the class or of a parent class.
- Its result converts to IlsBoolean.
- It can be invoked without arguments.
The update eagerness function has the following signature:
void holder::updEagerness(IlsBoolean increment);

When the increment argument is set to IlsTrue, this means that a new view is interested by the atttribute value. Conversely, IlsFalse means that a view is no longer interested in the attribute value. The signature can be different under the following conditions:
- It is a member of the class or of a derived class.
- It can be invoked with a boolean as argument.

See also: ILS_R_ATTRIBUTE_XXX().

◆ ILS_R_ATTRIBUTE_SHORT

#define ILS_R_ATTRIBUTE_SHORT	(	holder,
		attrLabel,
		getValue,
		isModified,
		updEagerness
	)

This macro declares attrLabel as a runtime attribute of the class holder. This attribute is of type short and cannot be modified.

Its accessor, getValue(), has the following signature:
short holder::getValue();

This signature can vary under the following conditions:
- The function is a member of the class or of a parent class.
- Its result converts to short.
- It can be invoked without arguments.
Its modifier test function, isModified(), has the following signature:
IlsBoolean holder::isModified();

This signature can vary under the following conditions:
- The function is a member of the class or of a parent class.
- Its result converts to IlsBoolean.
- It can be invoked without arguments.
The update eagerness function has the following signature:
void holder::updEagerness(IlsBoolean increment);

When the increment argument is set to IlsTrue, this means that a new view is interested by the atttribute value. Conversely, IlsFalse means that a view is no longer interested in the attribute value. The signature can be different under the following conditions:
- It is a member of the class or of a derived class.
- It can be invoked with a boolean as argument.

See also: ILS_R_ATTRIBUTE_XXX().

◆ ILS_R_ATTRIBUTE_STRING

#define ILS_R_ATTRIBUTE_STRING	(	holder,
		attrLabel,
		getValue,
		isModified,
		updEagerness
	)

This macro declares attrLabel as a runtime attribute of the class holder. This attribute is of type IlsString and cannot be modified.

Its accessor, getValue(), has the following signature:
IlsString holder::getValue();

This signature can vary under the following conditions:
- The function is a member of the class or of a parent class.
- Its result converts to IlsString.
- It can be invoked without arguments.
Its modifier test function, isModified(), has the following signature:
IlsBoolean holder::isModified();

This signature can vary under the following conditions:
- The function is a member of the class or of a parent class.
- Its result converts to IlsBoolean.
- It can be invoked without arguments.
The update eagerness function has the following signature:
void holder::updEagerness(IlsBoolean increment);

When the increment argument is set to IlsTrue, this means that a new view is interested by the atttribute value. Conversely, IlsFalse means that a view is no longer interested in the attribute value. The signature can be different under the following conditions:
- It is a member of the class or of a derived class.
- It can be invoked with a boolean as argument.

See also: ILS_R_ATTRIBUTE_XXX().

◆ ILS_R_ATTRIBUTE_USERTYPE

#define ILS_R_ATTRIBUTE_USERTYPE	(	holder,
		attrType,
		attrLabel,
		getValue,
		isModified,
		updEagerness
	)

This macro declares attrLabel as a runtime attribute of the class holder. This attribute is of type attrType which derives from IlsMvUserType and cannot be modified.

Its accessor, getValue(), has the following signature:
attrType holder::getValue();

This signature can vary under the following conditions:
- The function is a member of the class or of a parent class.
- Its result converts to attrType.
- It can be invoked without arguments.
Its modifier test function, isModified(), has the following signature:
IlsBoolean holder::isModified();

This signature can vary under the following conditions:
- The function is a member of the class or of a parent class.
- Its result converts to IlsBoolean.
- It can be invoked without arguments.
The update eagerness function has the following signature:
void holder::updEagerness(IlsBoolean increment);

When the increment argument is set to IlsTrue, this means that a new view is interested by the atttribute value. Conversely, IlsFalse means that a view is no longer interested in the attribute value. The signature can be different under the following conditions:
- It is a member of the class or of a derived class.
- It can be invoked with a boolean as argument.

See also: ILS_R_ATTRIBUTE_XXX().

◆ ILS_R_ATTRIBUTE_XXX

#define ILS_R_ATTRIBUTE_XXX ( )

The macros ILS_R_ATTRIBUTE_XXX() declare a read-only runtime attribute for a server object type so that it can be used in dynamic view type specifications.

Unlike the ILS_DERIVED_XXX() macros, these macros let you associate an accessor, a modification test and an update eagerness function with the runtime attribute.

The accessor is used by Server during the notification of a dynamic view to notify the value of a representation attribute to a component, or to evaluate a condition set on representation and/or propagation.
The modification test is used by Server to detect whether the attribute has changed since the latest notification cycle. For instance, if the runtime attribute is associated with an entry or a derived data member, the test function should call the function isModified() declared on the class template IlsEntry or IlsDerived respectively.
The update eagerness function is used by Server to declare that a new view is interested in knowing the attribute value or, conversely, that a view is no longer interested in this attribute. This update eagerness function is especially useful for a runtime attribute associated with a derived data member. In this case, it should call the IlsDerived::incrEagerness() or IlsDerived::decrEagerness() functions declared on the IlsDerived class template.

These macros allow you to declare runtime attributes whose names do not correspond to any data member of the server object type. They can be enclosed only between the following pairs of macros:

ILS_OBJECT_BEGIN() / ILS_OBJECT_END()
ILS_ENTITY_BEGIN() / ILS_ENTITY_END()
ILS_MVVIEW_BEGIN() / ILS_MVVIEW_END()

or their derivatives.

Warning: ILOG Server does not differentiate between the "integer" and "long" types, int being considered an equivalent of long, both on the server side and on the component side.

Synopsis

See also: IlsDerived, IlsEntity, IlsObject, ILS_RW_ATTRIBUTE_XXX(), ILS_RW_INDEXED_ATTR_XXX(), ILS_W_ENTRY_XXX().

◆ ILS_R_INDEXED_ATTR_BOOLEAN

#define ILS_R_INDEXED_ATTR_BOOLEAN	(	holder,
		attrLabel,
		getValue,
		isModified,
		updEagerness
	)

This macro declares attrLabel as a runtime indexed attribute of the class holder. This attribute is of type IlsBoolean and cannot be modified.

Its accessor, getValue(), has the following signature:
IlsBoolean objType::getValue(int index);

The signature can be different under the following conditions:
- It is a member of the class or of a derived class.
- Its result converts implicitly to IlsBoolean.
- It can be invoked with one integer value as argument.
The modification test has the following signature:
IlsBoolean objType::isModified(int index);

The signature can be different under the following conditions:
- It is a member of the class or of a derived class.
- Its result converts implicitly to IlsBoolean.
- It can be invoked with one integer value as argument.
The update eagerness function has the following signature:
void objType::updEagerness(int index, IlsBoolean increment);

When the increment argument is set to IlsTrue, this means that a new view is interested by the atttribute value. Conversely, IlsFalse means that a view is no longer interested in the attribute value. The signature can be different under the following conditions:
- It is a member of the class or of a derived class, and
- It can be invoked with an integer and a boolean as arguments.

See also: ILS_R_INDEXED_ATTR_XXX().

◆ ILS_R_INDEXED_ATTR_CHAR

#define ILS_R_INDEXED_ATTR_CHAR	(	holder,
		attrLabel,
		getValue,
		isModified,
		updEagerness
	)

This macro declares attrLabel as a runtime indexed attribute of the class holder. This attribute is of type char and cannot be modified.

Its accessor, getValue(), has the following signature:
char objType::getValue(int index);

The signature can be different under the following conditions:
- It is a member of the class or of a derived class.
- Its result converts implicitly to char.
- It can be invoked with one integer value as argument.
The modification test has the following signature:
IlsBoolean objType::isModified(int index);

The signature can be different under the following conditions:
- It is a member of the class or of a derived class.
- Its result converts implicitly to IlsBoolean.
- It can be invoked with one integer value as argument.
The update eagerness function has the following signature:
void objType::updEagerness(int index, IlsBoolean increment);

When the increment argument is set to IlsTrue, this means that a new view is interested by the atttribute value. Conversely, IlsFalse means that a view is no longer interested in the attribute value. The signature can be different under the following conditions:
- It is a member of the class or of a derived class, and
- It can be invoked with an integer and a boolean as arguments.

See also: ILS_R_INDEXED_ATTR_XXX().

◆ ILS_R_INDEXED_ATTR_DOUBLE

#define ILS_R_INDEXED_ATTR_DOUBLE	(	holder,
		attrLabel,
		getValue,
		isModified,
		updEagerness
	)

This macro declares attrLabel as a runtime indexed attribute of the class holder. This attribute is of type double and cannot be modified.

Its accessor, getValue(), has the following signature:
double holder::getValue(int index);

The signature can be different under the following conditions:
- It is a member of the class or of a derived class.
- Its result converts implicitly to double.
- It can be invoked with one integer value as argument.
The modification test has the following signature:
IlsBoolean holder::isModified(int index);

The signature can be different under the following conditions:
- It is a member of the class or of a derived class.
- Its result converts implicitly to IlsBoolean.
- It can be invoked with one integer value as argument.
The update eagerness function has the following signature:
void holder::updEagerness(int index, IlsBoolean increment);

When the increment argument is set to IlsTrue, this means that a new view is interested by the atttribute value. Conversely, IlsFalse means that a view is no longer interested in the attribute value. The signature can be different under the following conditions:
- It is a member of the class or of a derived class, and
- It can be invoked with an integer and a boolean as arguments.

See also: ILS_R_INDEXED_ATTR_XXX().

◆ ILS_R_INDEXED_ATTR_ENUM

#define ILS_R_INDEXED_ATTR_ENUM	(	holder,
		attrType,
		attrLabel,
		getValue,
		isModified,
		updEagerness
	)

This macro declares attrLabel as a runtime indexed attribute of the class holder. This attribute is of enum type attrType and cannot be modified.

Its accessor, getValue(), has the following signature:
attrType holder::getValue(int index);

The signature can be different under the following conditions:
- It is a member of the class or of a derived class.
- Its result converts implicitly to attrType.
- It can be invoked with one integer value as argument.
The modification test has the following signature:
IlsBoolean holder::isModified(int index);

The signature can be different under the following conditions:
- It is a member of the class or of a derived class.
- Its result converts implicitly to IlsBoolean.
- It can be invoked with one integer value as argument.
The update eagerness function has the following signature:
void holder::updEagerness(int index, IlsBoolean increment);

When the increment argument is set to IlsTrue, this means that a new view is interested by the atttribute value. Conversely, IlsFalse means that a view is no longer interested in the attribute value. The signature can be different under the following conditions:
- It is a member of the class or of a derived class, and
- It can be invoked with an integer and a boolean as arguments.

See also: ILS_R_INDEXED_ATTR_XXX().

◆ ILS_R_INDEXED_ATTR_FLOAT

#define ILS_R_INDEXED_ATTR_FLOAT	(	holder,
		attrLabel,
		getValue,
		isModified,
		updEagerness
	)

This macro declares attrLabel as a runtime indexed attribute of the class holder. This attribute is of type float and cannot be modified.

Its accessor, getValue(), has the following signature:
float holder::getValue(int index);

The signature can be different under the following conditions:
- It is a member of the class or of a derived class.
- Its result converts implicitly to float.
- It can be invoked with one integer value as argument.
The modification test has the following signature:
IlsBoolean holder::isModified(int index);

The signature can be different under the following conditions:
- It is a member of the class or of a derived class.
- Its result converts implicitly to IlsBoolean.
- It can be invoked with one integer value as argument.
The update eagerness function has the following signature:
void holder::updEagerness(int index, IlsBoolean increment);

When the increment argument is set to IlsTrue, this means that a new view is interested by the atttribute value. Conversely, IlsFalse means that a view is no longer interested in the attribute value. The signature can be different under the following conditions:
- It is a member of the class or of a derived class, and
- It can be invoked with an integer and a boolean as arguments.

See also: ILS_R_INDEXED_ATTR_XXX().

◆ ILS_R_INDEXED_ATTR_INT

#define ILS_R_INDEXED_ATTR_INT	(	holder,
		attrLabel,
		getValue,
		isModified,
		updEagerness
	)

This macro declares attrLabel as a runtime indexed attribute of the class holder. This attribute is of type long and cannot be modified.

Its accessor, getValue(), has the following signature:
long holder::getValue(int index);

The signature can be different under the following conditions:
- It is a member of the class or of a derived class.
- Its result converts implicitly to long.
- It can be invoked with one integer value as argument.
The modification test has the following signature:
IlsBoolean holder::isModified(int index);

The signature can be different under the following conditions:
- It is a member of the class or of a derived class.
- Its result converts implicitly to IlsBoolean.
- It can be invoked with one integer value as argument.
The update eagerness function has the following signature:
void holder::updEagerness(int index, IlsBoolean increment);

When the increment argument is set to IlsTrue, this means that a new view is interested by the atttribute value. Conversely, IlsFalse means that a view is no longer interested in the attribute value. The signature can be different under the following conditions:
- It is a member of the class or of a derived class, and
- It can be invoked with an integer and a boolean as arguments.

See also: ILS_R_INDEXED_ATTR_XXX().

◆ ILS_R_INDEXED_ATTR_LONG

#define ILS_R_INDEXED_ATTR_LONG	(	holder,
		attrLabel,
		getValue,
		isModified,
		updEagerness
	)

This macro declares attrLabel as a runtime indexed attribute of the class holder. This attribute is of type long and cannot be modified.

Its accessor, getValue(), has the following signature:
long holder::getValue(int index);

The signature can be different under the following conditions:
- It is a member of the class or of a derived class.
- Its result converts implicitly to long.
- It can be invoked with one integer value as argument.
The modification test has the following signature:
IlsBoolean holder::isModified(int index);

The signature can be different under the following conditions:
- It is a member of the class or of a derived class.
- Its result converts implicitly to IlsBoolean.
- It can be invoked with one integer value as argument.
The update eagerness function has the following signature:
void holder::updEagerness(int index, IlsBoolean increment);

When the increment argument is set to IlsTrue, this means that a new view is interested by the atttribute value. Conversely, IlsFalse means that a view is no longer interested in the attribute value. The signature can be different under the following conditions:
- It is a member of the class or of a derived class, and
- It can be invoked with an integer and a boolean as arguments.

See also: ILS_R_INDEXED_ATTR_XXX().

◆ ILS_R_INDEXED_ATTR_MVVALUE

#define ILS_R_INDEXED_ATTR_MVVALUE	(	holder,
		attrLabel,
		getValue,
		isModified,
		updEagerness
	)

his macro declares attrLabel as a runtime indexed attribute of the class holder. This attribute is of type IlsMvValue and cannot be modified.

Its accessor, getValue(), has the following signature:
IlsMvValue holder::getValue(int index);

The signature can be different under the following conditions:
- It is a member of the class or of a derived class.
- Its result converts implicitly to IlsMvValue.
- It can be invoked with one integer value as argument.
The modification test has the following signature:
IlsBoolean holder::isModified(int index);

The signature can be different under the following conditions:
- It is a member of the class or of a derived class.
- Its result converts implicitly to IlsBoolean.
- It can be invoked with one integer value as argument.
The update eagerness function has the following signature:
void holder::updEagerness(int index, IlsBoolean increment);

When the increment argument is set to IlsTrue, this means that a new view is interested by the atttribute value. Conversely, IlsFalse means that a view is no longer interested in the attribute value. The signature can be different under the following conditions:
- It is a member of the class or of a derived class, and
- It can be invoked with an integer and a boolean as arguments.

See also: ILS_R_INDEXED_ATTR_XXX().

◆ ILS_R_INDEXED_ATTR_SHORT

#define ILS_R_INDEXED_ATTR_SHORT	(	holder,
		attrLabel,
		getValue,
		isModified,
		updEagerness
	)

This macro declares attrLabel as a runtime indexed attribute of the class holder. This attribute is of type short and cannot be modified.

Its accessor, getValue(), has the following signature:
short objType::getValue(int index);

The signature can be different under the following conditions:
- It is a member of the class or of a derived class.
- Its result converts implicitly to short.
- It can be invoked with one integer value as argument.
The modification test has the following signature:
IlsBoolean holder::isModified(int index);

The signature can be different under the following conditions:
- It is a member of the class or of a derived class.
- Its result converts implicitly to IlsBoolean.
- It can be invoked with one integer value as argument.
The update eagerness function has the following signature:
void holder::updEagerness(int index, IlsBoolean increment);

When the increment argument is set to IlsTrue, this means that a new view is interested by the atttribute value. Conversely, IlsFalse means that a view is no longer interested in the attribute value. The signature can be different under the following conditions:
- It is a member of the class or of a derived class, and
- It can be invoked with an integer and a boolean as arguments.

See also: ILS_R_INDEXED_ATTR_XXX().

◆ ILS_R_INDEXED_ATTR_STRING

#define ILS_R_INDEXED_ATTR_STRING	(	holder,
		attrLabel,
		getValue,
		isModified,
		updEagerness
	)

This macro declares attrLabel as a runtime indexed attribute of the class holder. This attribute is of type IlsString and cannot be modified.

Its accessor, getValue(), has the following signature:
IlsString holder::getValue(int index);

The signature can be different under the following conditions:
- It is a member of the class or of a derived class.
- Its result converts implicitly to IlsString.
- It can be invoked with one integer value as argument.
The modification test has the following signature:
IlsBoolean holder::isModified(int index);

The signature can be different under the following conditions:
- It is a member of the class or of a derived class.
- Its result converts implicitly to IlsBoolean.
- It can be invoked with one integer value as argument.
The update eagerness function has the following signature:
void holder::updEagerness(int index, IlsBoolean increment);

When the increment argument is set to IlsTrue, this means that a new view is interested by the atttribute value. Conversely, IlsFalse means that a view is no longer interested in the attribute value. The signature can be different under the following conditions:
- It is a member of the class or of a derived class, and
- It can be invoked with an integer and a boolean as arguments.

See also: ILS_R_INDEXED_ATTR_XXX().

◆ ILS_R_INDEXED_ATTR_USERTYPE

#define ILS_R_INDEXED_ATTR_USERTYPE	(	holder,
		attrType,
		attrLabel,
		getValue,
		isModified,
		updEagerness
	)

This macro declares attrLabel as a runtime indexed attribute of the class holder. This attribute is of type attrType which derives from IlsMvUserType and cannot be modified.

Its accessor, getValue(), has the following signature:
attrType holder::getValue(int index);

The signature can be different under the following conditions:
- It is a member of the class or of a derived class.
- Its result converts implicitly to attrType.
- It can be invoked with one integer value as argument.
The modification test has the following signature:
IlsBoolean holder::isModified(int index);

The signature can be different under the following conditions:
- It is a member of the class or of a derived class.
- Its result converts implicitly to IlsBoolean.
- It can be invoked with one integer value as argument.
The update eagerness function has the following signature:
void holder::updEagerness(int index, IlsBoolean increment);

When the increment argument is set to IlsTrue, this means that a new view is interested by the atttribute value. Conversely, IlsFalse means that a view is no longer interested in the attribute value. The signature can be different under the following conditions:
- It is a member of the class or of a derived class, and
- It can be invoked with an integer and a boolean as arguments.

See also: ILS_R_INDEXED_ATTR_XXX().

◆ ILS_R_INDEXED_ATTR_XXX

#define ILS_R_INDEXED_ATTR_XXX ( )

The macros ILS_R_INDEXED_ATTR_xxx declare a read-only runtime indexed attribute for a server object type so that it can be used in view specifications.

This attribute is defined by an accessor, a modification test and an update eagerness function.

The accessor is used by Server during the notification of a dynamic view to notify a component the value of a representation attribute or to evaluate a condition of representation and/or of propagation (see Dynamic View Types and C++ View Types).
The modification test is used by Server to detect whether the attribute has changed since the latest notification cycle. For instance, if the runtime attribute is associated with an entry or a derived data member, the test function should call the function isModified() declared on the class template IlsEntry or IlsDerived respectively.
The updEagerness() function is used by Server to declare that a new view is interested in knowing the attribute value or, conversely, that a view is no longer interested in this attribute. This update eagerness function is especially useful for a runtime attribute associated with a derived data member. In this case, it should call the IlsDerived::incrEagerness() or IlsDerived::decrEagerness() functions declared on the IlsDerived class template.

These macros allows you to declare pure runtime attributes, that is attributes whose names do not correspond to any data member of the server object type. They can be enclosed only between the following pairs of macros:

ILS_OBJECT_BEGIN() / ILS_OBJECT_END()
ILS_ENTITY_BEGIN() / ILS_ENTITY_END()
ILS_MVVIEW_BEGIN() / ILS_MVVIEW_END()

or their derivatives.

Synopsis

See also: IlsDerived, IlsEntry, ILS_RW_INDEXED_ATTR_XXX()

◆ ILS_R_RELATION_1

#define ILS_R_RELATION_1	(	origin,
		target,
		relNm,
		relAccessor,
		targAccessor
	)

This macro declares a server unary relation as being accessible at runtime.

This relation can be of type IlsOwns, IlsUses, or IlsInvertedRelation. It differs from the macros ILS_OWNS_1(), ILS_USES_1(), and ILS_INVERTED_1(), in that the accessors to the relation and the relation target are user-defined. Moreover, no modifier is supplied. A runtime relation declared with this macro cannot be modified.

This macro can only be enclosed between the following pairs of macros:

ILS_OBJECT_BEGIN() / ILS_OBJECT_END()
ILS_ENTITY_BEGIN() / ILS_ENTITY_END()
ILS_MVVIEW_BEGIN() / ILS_MVVIEW_END()

or their derivatives.

Parameters

origin	is the class where the relation is declared.
target	is the target class.
relNm	is the name of the relation.
relAccessor	is an accessor to the relation with the following signature: IlsViewedRel* origin::getRelation();
targAccessor	is an accessor to the relation target with the following signature: IlsViewed* ownerType::getTarget();

The signature of these functions may vary under the following conditions:

The function is a member of the class origin or of a parent class.
Its result implicitly converts to the result specified in the model.
It can be invoked with the arguments specified in the model.

See also: IlsInvertedRelation, ILS_INVERTED_1(), IlsOwns, ILS_OWNS_1(), ILS_RW_RELATION_1(), IlsUses, ILS_USES_1(), ILS_W_RELATION_1().

◆ ILS_R_RELATION_N

#define ILS_R_RELATION_N	(	origin,
		target,
		relNm,
		relAccessor
	)

This macro declares a Server n-ary relation as being accessible at runtime.

This relation can be of type IlsOwns, IlsUses, or IlsInvertedRelation. It differs from the macros ILS_OWNS_N(), ILS_USES_N(), and ILS_INVERTED_N(), in that the accessors to the relation and the relation target are user-defined. Moreover, no modifier is supplied. A runtime relation declared with this macro cannot be modified.

This macro can only be enclosed between the following pairs of macros:

ILS_OBJECT_BEGIN() / ILS_OBJECT_END()
ILS_ENTITY_BEGIN() / ILS_ENTITY_END()
ILS_MVVIEW_BEGIN() / ILS_MVVIEW_END()

or their derivatives.

Parameters

origin	is the class where the relation is declared.
target	is the target class.
relNm	is the name of the relation.
relAccessor	is an accessor to the relation with the following signature: IlsViewedRel* origin::getRelation();

The signature of this function may vary under the following conditions:

The function is a member of the class origin or of a parent class.
Its result implicitly converts to IlsViewedRel*.
It can be invoked without argument.

See also: IlsInvertedRelation, ILS_INVERTED_N(), IlsOwns, ILS_OWNS_N(), ILS_RW_RELATION_N(), IlsUses, ILS_USES_N(), ILS_W_RELATION_N().

◆ ILS_REVERSE

#define ILS_REVERSE	(	owner,
		relNm,
		revRelNm
	)

This macro declares that a relation is the inverse relation of another relation.

In most cases, the use of the macros ILS_INVERTED_1() or ILS_INVERTED_N() makes this macro unnecessary.

This macro can only be enclosed between the following pairs of macros:

ILS_OBJECT_BEGIN() / ILS_OBJECT_END()
ILS_ENTITY_BEGIN() / ILS_ENTITY_END()
ILS_MVVIEW_BEGIN() / ILS_MVVIEW_END()

or their derivatives.

See also: ILS_INVERTED_1(), ILS_INVERTED_N().

◆ ILS_RW_ATTRIBUTE_BOOLEAN

#define ILS_RW_ATTRIBUTE_BOOLEAN	(	holder,
		attrLabel,
		getValue,
		setValue,
		isModified
	)

This macro declares attrLabel as a runtime attribute of the class holder. This attribute is of type IlsBoolean and can be modified.

Its accessor, getValue(), has the following signature:
IlsBoolean holder::getValue();

This signature can be different under the following conditions:
- the function is a member of the class or of a parent class, and
- its result converts to IlsBoolean, and
- it can be invoked without arguments.
Its modifier, setValue(), has the following signature:
IlsBoolean holder::setValue(IlsBoolean value);

When the function returns IlsFalse, the attribute cannot be set to this value. In that case, the current transaction is rolled back by the server and a rollback transaction is sent to the component having requested the modification. See section Transaction Control in the IlsMvComponent class description.

The signature of the function can be different under the following conditions:
- it is a member of the class or of a derived class, and
- its results converts implicitly to IlsBoolean, and
- it can be invoked with a IlsBoolean as argument.
Its modifier test function, isModified(), has the following signature:
IlsBoolean holder::isModified();

This signature can be different under the following conditions:
- the function is a member of the class or of a parent class, and
- its result converts to IlsBoolean, and
- it can be invoked without arguments.

See also: ILS_RW_ATTRIBUTE_XXX().

◆ ILS_RW_ATTRIBUTE_CHAR

#define ILS_RW_ATTRIBUTE_CHAR	(	holder,
		attrLabel,
		getValue,
		setValue,
		isModified
	)

This macro declares attrLabel as a runtime attribute of the class holder. This attribute is of type char and can be modified.

Its accessor, getValue(), has the following signature:
char holder::getValue();

This signature can be different under the following conditions:
- the function is a member of the class or of a parent class, and
- its result converts to char, and
- it can be invoked without arguments.
Its modifier, setValue(), has the following signature:
IlsBoolean holder::setValue(char value);

When the function returns IlsFalse, the attribute cannot be set to this value. In that case, the current transaction is rolled back by the server and a rollback transaction is sent to the component having requested the modification. See section Transaction Control in the IlsMvComponent class description.

The signature of the function can be different under the following conditions:
- it is a member of the class or of a derived class, and
- its results converts implicitly to IlsBoolean, and
- it can be invoked with a char as argument.
Its modifier test function, isModified(), has the following signature:
IlsBoolean holder::isModified();

This signature can be different under the following conditions:
- the function is a member of the class or of a parent class, and
- its result converts to IlsBoolean, and
- it can be invoked without arguments.

See also: ILS_RW_ATTRIBUTE_XXX().

◆ ILS_RW_ATTRIBUTE_DOUBLE

#define ILS_RW_ATTRIBUTE_DOUBLE	(	holder,
		attrLabel,
		getValue,
		setValue,
		isModified
	)

This macro declares attrLabel as a runtime attribute of the class holder. This attribute is of type double and can be modified.

Its accessor, getValue(), has the following signature:
double holder::getValue();

This signature can be different under the following conditions:
- the function is a member of the class or of a parent class, and
- its result converts to double, and
- it can be invoked without arguments.
Its modifier, setValue(), has the following signature:
IlsBoolean holder::setValue(double value);

When the function returns IlsFalse, the attribute cannot be set to this value. In that case, the current transaction is rolled back by the server and a rollback transaction is sent to the component having requested the modification. See section Transaction Control in the IlsMvComponent class description.

The signature of the function can be different under the following conditions:
- it is a member of the class or of a derived class, and
- its results converts implicitly to IlsBoolean, and
- it can be invoked with a double as argument.
Its modifier test function, isModified(), has the following signature:
IlsBoolean holder::isModified();

This signature can be different under the following conditions:
- the function is a member of the class or of a parent class, and
- its result converts to IlsBoolean, and
- it can be invoked without arguments.

See also: ILS_RW_ATTRIBUTE_XXX().

◆ ILS_RW_ATTRIBUTE_ENUM

#define ILS_RW_ATTRIBUTE_ENUM	(	holder,
		attrType,
		attrLabel,
		getValue,
		setValue,
		isModified
	)

This macro declares attrLabel as a runtime attribute of the class holder. This attribute is an enum type attrType and can be modified.

Its accessor, getValue(), has the following signature:
attrType holder::getValue();

This signature can be different under the following conditions:
- the function is a member of the class or of a parent class, and
- its result converts to attrType, and
- it can be invoked without arguments.
Its modifier, setValue(), has the following signature:
IlsBoolean holder::setValue(attrType value);

When the function returns IlsFalse, the attribute cannot be set to this value. In that case, the current transaction is rolled back by the server and a rollback transaction is sent to the component having requested the modification. See section Transaction Control in the IlsMvComponent class description.

The signature of the function can be different under the following conditions:
- it is a member of the class or of a derived class, and
- its results converts implicitly to IlsBoolean, and
- it can be invoked with a attrType as argument.
Its modifier test function, isModified(), has the following signature:
IlsBoolean holder::isModified();

This signature can be different under the following conditions:
- the function is a member of the class or of a parent class, and
- its result converts to IlsBoolean, and
- it can be invoked without arguments.

See also: ILS_RW_ATTRIBUTE_XXX().

◆ ILS_RW_ATTRIBUTE_FLOAT

#define ILS_RW_ATTRIBUTE_FLOAT	(	holder,
		attrLabel,
		getValue,
		setValue,
		isModified
	)

This macro declares attrLabel as a runtime attribute of the class holder. This attribute is of type float and can be modified.

Its accessor, getValue(), has the following signature:
float holder::getValue();

This signature can be different under the following conditions:
- the function is a member of the class or of a parent class, and
- its result converts to float, and
- it can be invoked without arguments.
Its modifier, setValue(), has the following signature:
IlsBoolean holder::setValue(float value);

When the function returns IlsFalse, the attribute cannot be set to this value. In that case, the current transaction is rolled back by the server and a rollback transaction is sent to the component having requested the modification. See section Transaction Control in the IlsMvComponent class description.

The signature of the function can be different under the following conditions:
- it is a member of the class or of a derived class, and
- its results converts implicitly to IlsBoolean, and
- it can be invoked with a float as argument.
Its modifier test function, isModified(), has the following signature:
IlsBoolean holder::isModified();

This signature can be different under the following conditions:
- the function is a member of the class or of a parent class, and
- its result converts to IlsBoolean, and
- it can be invoked without arguments.

See also: ILS_RW_ATTRIBUTE_XXX().

◆ ILS_RW_ATTRIBUTE_INT

#define ILS_RW_ATTRIBUTE_INT	(	holder,
		attrLabel,
		getValue,
		setValue,
		isModified
	)

This macro declares attrLabel as a runtime attribute of the class holder. This attribute is of type long (int and long are both considered as long in Server) and can be modified.

Its accessor, getValue(), has the following signature:
long holder::getValue();

This signature can be different under the following conditions:
- the function is a member of the class or of a parent class, and
- its result converts to long, and
- it can be invoked without arguments.
Its modifier, setValue(), has the following signature:
IlsBoolean holder::setValue(long value);

When the function returns IlsFalse, the attribute cannot be set to this value. In that case, the current transaction is rolled back by the server and a rollback transaction is sent to the component having requested the modification. See section Transaction Control in the IlsMvComponent class description.

The signature of the function can be different under the following conditions:
- it is a member of the class or of a derived class, and
- its results converts implicitly to IlsBoolean, and
- it can be invoked with a long as argument.
Its modifier test function, isModified(), has the following signature:
IlsBoolean holder::isModified();

This signature can be different under the following conditions:
- the function is a member of the class or of a parent class, and
- its result converts to IlsBoolean, and
- it can be invoked without arguments.

See also: ILS_RW_ATTRIBUTE_XXX().

◆ ILS_RW_ATTRIBUTE_LONG

#define ILS_RW_ATTRIBUTE_LONG	(	holder,
		attrLabel,
		getValue,
		setValue,
		isModified
	)

This macro declares attrLabel as a runtime attribute of the class holder. This attribute is of type long and can be modified.

Its accessor, getValue(), has the following signature:
long holder::getValue();

This signature can be different under the following conditions:
- the function is a member of the class or of a parent class, and
- its result converts to long, and
- it can be invoked without arguments.
Its modifier, setValue(), has the following signature:
IlsBoolean holder::setValue(long value);

When the function returns IlsFalse, the attribute cannot be set to this value. In that case, the current transaction is rolled back by the server and a rollback transaction is sent to the component having requested the modification. See section Transaction Control in the IlsMvComponent class description.

The signature of the function can be different under the following conditions:
- it is a member of the class or of a derived class, and
- its results converts implicitly to IlsBoolean, and
- it can be invoked with a long as argument.
Its modifier test function, isModified(), has the following signature:
IlsBoolean holder::isModified();

This signature can be different under the following conditions:
- the function is a member of the class or of a parent class, and
- its result converts to IlsBoolean, and
- it can be invoked without arguments.

See also: ILS_RW_ATTRIBUTE_XXX().

◆ ILS_RW_ATTRIBUTE_MVVALUE

#define ILS_RW_ATTRIBUTE_MVVALUE	(	holder,
		attrLabel,
		getValue,
		setValue,
		isModified
	)

This macro declares attrLabel as a runtime attribute of the class holder. This attribute is of type IlsMvValue and can be modified.

Its accessor, getValue(), has the following signature:
IlsMvValue holder::getValue();

This signature can be different under the following conditions:
- the function is a member of the class or of a parent class, and
- its result converts to IlsMvValue, and
- it can be invoked without arguments.
Its modifier, setValue(), has the following signature:
IlsBoolean holder::setValue(IlsMvValue value);

When the function returns IlsFalse, the attribute cannot be set to this value. In that case, the current transaction is rolled back by the server and a rollback transaction is sent to the component having requested the modification. See section Transaction Control in the IlsMvComponent class description.

The signature of the function can be different under the following conditions:
- it is a member of the class or of a derived class, and
- its results converts implicitly to IlsBoolean, and
- it can be invoked with a IlsMvValue as argument.
Its modifier test function, isModified(), has the following signature:
IlsBoolean holder::isModified();

This signature can be different under the following conditions:
- the function is a member of the class or of a parent class, and
- its result converts to IlsBoolean, and
- it can be invoked without arguments.

See also: ILS_RW_ATTRIBUTE_XXX().

◆ ILS_RW_ATTRIBUTE_SHORT

#define ILS_RW_ATTRIBUTE_SHORT	(	holder,
		attrLabel,
		getValue,
		setValue,
		isModified
	)

This macro declares attrLabel as a runtime attribute of the class holder. This attribute is of type short and can be modified.

Its accessor, getValue(), has the following signature:
short holder::getValue();

This signature can be different under the following conditions:
- the function is a member of the class or of a parent class, and
- its result converts to short, and
- it can be invoked without arguments.
Its modifier, setValue(), has the following signature:
IlsBoolean holder::setValue(short value);

When the function returns IlsFalse, the attribute cannot be set to this value. In that case, the current transaction is rolled back by the server and a rollback transaction is sent to the component having requested the modification. See section Transaction Control in the IlsMvComponent class description.

The signature of the function can be different under the following conditions:
- it is a member of the class or of a derived class, and
- its results converts implicitly to IlsBoolean, and
- it can be invoked with a short as argument.
Its modifier test function, isModified(), has the following signature:
IlsBoolean holder::isModified();

This signature can be different under the following conditions:
- the function is a member of the class or of a parent class, and
- its result converts to IlsBoolean, and
- it can be invoked without arguments.

See also: ILS_RW_ATTRIBUTE_XXX().

◆ ILS_RW_ATTRIBUTE_STRING

#define ILS_RW_ATTRIBUTE_STRING	(	holder,
		attrLabel,
		getValue,
		setValue,
		isModified
	)

This macro declares attrLabel as a runtime attribute of the class holder. This attribute is of type IlsString and can be modified.

Its accessor, getValue(), has the following signature:
IlsString holder::getValue();

This signature can be different under the following conditions:
- the function is a member of the class or of a parent class, and
- its result converts to IlsString, and
- it can be invoked without arguments.
Its modifier, setValue(), has the following signature:
IlsBoolean holder::setValue(IlsString value);

When the function returns IlsFalse, the attribute cannot be set to this value. In that case, the current transaction is rolled back by the server and a rollback transaction is sent to the component having requested the modification. See section Transaction Control in the IlsMvComponent class description.

The signature of the function can be different under the following conditions:
- it is a member of the class or of a derived class, and
- its results converts implicitly to IlsBoolean, and
- it can be invoked with a IlsString as argument.
Its modifier test function, isModified(), has the following signature:
IlsBoolean holder::isModified();

This signature can be different under the following conditions:
- the function is a member of the class or of a parent class, and
- its result converts to IlsBoolean, and
- it can be invoked without arguments.

See also: ILS_RW_ATTRIBUTE_XXX().

◆ ILS_RW_ATTRIBUTE_USERTYPE

#define ILS_RW_ATTRIBUTE_USERTYPE	(	holder,
		attrType,
		attrLabel,
		getValue,
		setValue,
		isModified
	)

This macro declares attrLabel as a runtime attribute of the class holder. This attribute is of type attrType which derives from IlsMvUserType and can be modified.

Its accessor, getValue(), has the following signature:
attrType holder::getValue();

This signature can be different under the following conditions:
- the function is a member of the class or of a parent class, and
- its result converts to attrType, and
- it can be invoked without arguments.
Its modifier, setValue(), has the following signature:
IlsBoolean holder::setValue(attrType value);

When the function returns IlsFalse, the attribute cannot be set to this value. In that case, the current transaction is rolled back by the server and a rollback transaction is sent to the component having requested the modification. See section Transaction Control in the IlsMvComponent class description.

The signature of the function can be different under the following conditions:
- it is a member of the class or of a derived class, and
- its results converts implicitly to IlsBoolean, and
- it can be invoked with a attrType as argument.
Its modifier test function, isModified(), has the following signature:
IlsBoolean holder::isModified();

This signature can be different under the following conditions:
- the function is a member of the class or of a parent class, and
- its result converts to IlsBoolean, and
- it can be invoked without arguments.

See also: ILS_RW_ATTRIBUTE_XXX().

◆ ILS_RW_ATTRIBUTE_XXX

#define ILS_RW_ATTRIBUTE_XXX ( )

The macros ILS_RW_ATTRIBUTE_XXX() declare a read/write runtime attribute for a server object type so that it can be used in view specifications.

This attribute is defined by an accessor, a modifier and a modification test.

The accessor is used by Rogue Wave Server during the notification of a dynamic view to notify the value of a representation attribute to a component or to evaluate a condition set to representation and/or propagation (see Dynamic View Types and C++ View Types).
The modifier is used by Rogue Wave Server during a component-to-server transaction to modify the attribute value. When the modifier returns IlsFalse and the rollback mode is enabled by the component, the current transaction is rolled back by the server and a rollback transaction is sent to the component that requested the modification. See the Transaction Control sections in the IlsMvComponent and IlsMvServer class descriptions for more information.
The modification test is used by Rogue Wave Server to detect whether the attribute has changed since the latest notification cycle. For instance, if the runtime attribute is associated with an entry, the test function should call the function IlsEntry::isModified() declared on the class template IlsEntry.

These macros allow you to declare runtime attributes whose names do not correspond to any data member of the Server object type. They can be enclosed only between the following pairs of macros:

ILS_OBJECT_BEGIN() / ILS_OBJECT_END()
ILS_ENTITY_BEGIN() / ILS_ENTITY_END()
ILS_MVVIEW_BEGIN() / ILS_MVVIEW_END()

or their derivatives.

Note: ILOG Server does not differentiate between the "integer" and "long" types, int being considered an equivalent of long, both on the server side and on the component side.

Synopsis

See also: IlsEntity, IlsEntry, IlsMvComponent, IlsObject, ILS_R_ATTRIBUTE_XXX(), ILS_RW_INDEXED_ATTR_XXX(), ILS_W_ENTRY_XXX().

◆ ILS_RW_INDEXED_ATTR_BOOLEAN

#define ILS_RW_INDEXED_ATTR_BOOLEAN	(	holder,
		attrLabel,
		getValue,
		setValue,
		isModified
	)

This macro declares attrLabel as a runtime attribute of the class holder.

This attribute is of type IlsBoolean and can be modified.

Its accessor, getValue(), has the following signature:
IlsBoolean holder::getValue(int index);

When the function returns IlsFalse, the attribute cannot be set to this value. In that case the current transaction is rolled back by the server and a rollback transaction is sent to the component having requested the modification. See Transaction Control in the IlsMvComponent class description. The function signature can be different under the following conditions:
- the function is a member of the class or of a derived class.
- its result converts implicitly to IlsBoolean.
- it can be invoked with an integer as argument.
Its modifier, setValue(), has the following signature:
IlsBoolean holder::setValue(int index,IlsBoolean value);

The function signature can be different under the following conditions:
- The function is a member of the class or of a parent class, and
- Its result converts implicitly to IlsBoolean, and
- It can be invoked with an integer and a IlsBoolean as arguments.
Its modification test, isModified(), has the following signature:
IlsBoolean holder::isModified(int index);

This signature can be different under the following conditions:
- the function is a member of the class or of a derived class, and
- its result converts implicitly to IlsBoolean, and
- it can be invoked with one integer value as argument.

See also: ILS_RW_INDEXED_ATTR_XXX().

◆ ILS_RW_INDEXED_ATTR_CHAR

#define ILS_RW_INDEXED_ATTR_CHAR	(	holder,
		attrLabel,
		getValue,
		setValue,
		isModified
	)

This macro declares attrLabel as a runtime attribute of the class holder.

This attribute is of type char and can be modified.

Its accessor, getValue(), has the following signature:
char holder::getValue(int index);

When the function returns IlsFalse, the attribute cannot be set to this value. In that case the current transaction is rolled back by the server and a rollback transaction is sent to the component having requested the modification. See Transaction Control in the IlsMvComponent class description. The function signature can be different under the following conditions:
- the function is a member of the class or of a derived class.
- its result converts implicitly to char.
- it can be invoked with an integer as argument.
Its modifier, setValue(), has the following signature:
IlsBoolean holder::setValue(int index,char value);

The function signature can be different under the following conditions:
- The function is a member of the class or of a parent class, and
- Its result converts implicitly to IlsBoolean, and
- It can be invoked with an integer and a char as arguments.
Its modification test, isModified(), has the following signature:
IlsBoolean holder::isModified(int index);

This signature can be different under the following conditions:
- the function is a member of the class or of a derived class, and
- its result converts implicitly to IlsBoolean, and
- it can be invoked with one integer value as argument.

See also: ILS_RW_INDEXED_ATTR_XXX().

◆ ILS_RW_INDEXED_ATTR_DOUBLE

#define ILS_RW_INDEXED_ATTR_DOUBLE	(	holder,
		attrLabel,
		getValue,
		setValue,
		isModified
	)

This macro declares attrLabel as a runtime attribute of the class holder.

This attribute is of type double and can be modified.

Its accessor, getValue(), has the following signature:
double holder::getValue(int index);

When the function returns IlsFalse, the attribute cannot be set to this value. In that case the current transaction is rolled back by the server and a rollback transaction is sent to the component having requested the modification. See Transaction Control in the IlsMvComponent class description. The function signature can be different under the following conditions:
- the function is a member of the class or of a derived class.
- its result converts implicitly to double.
- it can be invoked with an integer as argument.
Its modifier, setValue(), has the following signature:
IlsBoolean holder::setValue(int index,double value);

The function signature can be different under the following conditions:
- The function is a member of the class or of a parent class, and
- Its result converts implicitly to IlsBoolean, and
- It can be invoked with an integer and a double as arguments.
Its modification test, isModified(), has the following signature:
IlsBoolean holder::isModified(int index);

This signature can be different under the following conditions:
- the function is a member of the class or of a derived class, and
- its result converts implicitly to IlsBoolean, and
- it can be invoked with one integer value as argument.

See also: ILS_RW_INDEXED_ATTR_XXX().

◆ ILS_RW_INDEXED_ATTR_ENUM

#define ILS_RW_INDEXED_ATTR_ENUM	(	holder,
		attrType,
		attrLabel,
		getValue,
		setValue,
		isModified
	)

This macro declares attrLabel as a runtime attribute of the class holder.

This attribute is an enum type attrType and can be modified.

Its accessor, getValue(), has the following signature:
attrType holder::getValue(int index);

When the function returns IlsFalse, the attribute cannot be set to this value. In that case the current transaction is rolled back by the server and a rollback transaction is sent to the component having requested the modification. See Transaction Control in the IlsMvComponent class description. The function signature can be different under the following conditions:
- the function is a member of the class or of a derived class.
- its result converts implicitly to attrType.
- it can be invoked with an integer as argument.
Its modifier, setValue(), has the following signature:
IlsBoolean holder::setValue(int index,attrType value);

The function signature can be different under the following conditions:
- The function is a member of the class or of a parent class, and
- Its result converts implicitly to IlsBoolean, and
- It can be invoked with an integer and a attrType as arguments.
Its modification test, isModified(), has the following signature:
IlsBoolean holder::isModified(int index);

This signature can be different under the following conditions:
- the function is a member of the class or of a derived class, and
- its result converts implicitly to IlsBoolean, and
- it can be invoked with one integer value as argument.

See also: ILS_RW_INDEXED_ATTR_XXX().

◆ ILS_RW_INDEXED_ATTR_FLOAT

#define ILS_RW_INDEXED_ATTR_FLOAT	(	holder,
		attrLabel,
		getValue,
		setValue,
		isModified
	)

This macro declares attrLabel as a runtime attribute of the class holder.

This attribute is of type float and can be modified.

Its accessor, getValue(), has the following signature:
float holder::getValue(int index);

When the function returns IlsFalse, the attribute cannot be set to this value. In that case the current transaction is rolled back by the server and a rollback transaction is sent to the component having requested the modification. See Transaction Control in the IlsMvComponent class description. The function signature can be different under the following conditions:
- the function is a member of the class or of a derived class.
- its result converts implicitly to float.
- it can be invoked with an integer as argument.
Its modifier, setValue(), has the following signature:
IlsBoolean holder::setValue(int index,float value);

The function signature can be different under the following conditions:
- The function is a member of the class or of a parent class, and
- Its result converts implicitly to IlsBoolean, and
- It can be invoked with an integer and a float as arguments.
Its modification test, isModified(), has the following signature:
IlsBoolean holder::isModified(int index);

This signature can be different under the following conditions:
- the function is a member of the class or of a derived class, and
- its result converts implicitly to IlsBoolean, and
- it can be invoked with one integer value as argument.

See also: ILS_RW_INDEXED_ATTR_XXX().

◆ ILS_RW_INDEXED_ATTR_INT

#define ILS_RW_INDEXED_ATTR_INT	(	holder,
		attrLabel,
		getValue,
		setValue,
		isModified
	)

This macro declares attrLabel as a runtime attribute of the class holder.

This attribute is of type long and can be modified.

Its accessor, getValue(), has the following signature:
long holder::getValue(int index);

When the function returns IlsFalse, the attribute cannot be set to this value. In that case the current transaction is rolled back by the server and a rollback transaction is sent to the component having requested the modification. See Transaction Control in the IlsMvComponent class description. The function signature can be different under the following conditions:
- the function is a member of the class or of a derived class.
- its result converts implicitly to long.
- it can be invoked with an integer as argument.
Its modifier, setValue(), has the following signature:
IlsBoolean holder::setValue(int index,long value);

The function signature can be different under the following conditions:
- The function is a member of the class or of a parent class, and
- Its result converts implicitly to IlsBoolean, and
- It can be invoked with an integer and a long as arguments.
Its modification test, isModified(), has the following signature:
IlsBoolean holder::isModified(int index);

This signature can be different under the following conditions:
- the function is a member of the class or of a derived class, and
- its result converts implicitly to IlsBoolean, and
- it can be invoked with one integer value as argument.

See also: ILS_RW_INDEXED_ATTR_XXX().

◆ ILS_RW_INDEXED_ATTR_LONG

#define ILS_RW_INDEXED_ATTR_LONG	(	holder,
		attrLabel,
		getValue,
		setValue,
		isModified
	)

This macro declares attrLabel as a runtime attribute of the class holder.

This attribute is of type long and can be modified.

Its accessor, getValue(), has the following signature:
long holder::getValue(int index);

When the function returns IlsFalse, the attribute cannot be set to this value. In that case the current transaction is rolled back by the server and a rollback transaction is sent to the component having requested the modification. See Transaction Control in the IlsMvComponent class description. The function signature can be different under the following conditions:
- the function is a member of the class or of a derived class.
- its result converts implicitly to long.
- it can be invoked with an integer as argument.
Its modifier, setValue(), has the following signature:
IlsBoolean holder::setValue(int index,long value);

The function signature can be different under the following conditions:
- The function is a member of the class or of a parent class, and
- Its result converts implicitly to IlsBoolean, and
- It can be invoked with an integer and a long as arguments.
Its modification test, isModified(), has the following signature:
IlsBoolean holder::isModified(int index);

This signature can be different under the following conditions:
- the function is a member of the class or of a derived class, and
- its result converts implicitly to IlsBoolean, and
- it can be invoked with one integer value as argument.

See also: ILS_RW_INDEXED_ATTR_XXX().

◆ ILS_RW_INDEXED_ATTR_MVVALUE

#define ILS_RW_INDEXED_ATTR_MVVALUE	(	holder,
		attrLabel,
		getValue,
		setValue,
		isModified
	)

This macro declares attrLabel as a runtime attribute of the class holder.

This attribute is of type IlsMvValue and can be modified.

Its accessor, getValue(), has the following signature:
IlsMvValue holder::getValue(int index);

When the function returns IlsFalse, the attribute cannot be set to this value. In that case the current transaction is rolled back by the server and a rollback transaction is sent to the component having requested the modification. See Transaction Control in the IlsMvComponent class description. The function signature can be different under the following conditions:
- the function is a member of the class or of a derived class.
- its result converts implicitly to IlsMvValue.
- it can be invoked with an integer as argument.
Its modifier, setValue(), has the following signature:
IlsBoolean holder::setValue(int index,IlsMvValue value);

The function signature can be different under the following conditions:
- The function is a member of the class or of a parent class, and
- Its result converts implicitly to IlsBoolean, and
- It can be invoked with an integer and a IlsMvValue as arguments.
Its modification test, isModified(), has the following signature:
IlsBoolean holder::isModified(int index);

This signature can be different under the following conditions:
- the function is a member of the class or of a derived class, and
- its result converts implicitly to IlsBoolean, and
- it can be invoked with one integer value as argument.

See also: ILS_RW_INDEXED_ATTR_XXX().

◆ ILS_RW_INDEXED_ATTR_SHORT

#define ILS_RW_INDEXED_ATTR_SHORT	(	holder,
		attrLabel,
		getValue,
		setValue,
		isModified
	)

This macro declares attrLabel as a runtime attribute of the class holder.

This attribute is of type short and can be modified.

Its accessor, getValue(), has the following signature:
attrType holder::getValue(int index);

When the function returns IlsFalse, the attribute cannot be set to this value. In that case the current transaction is rolled back by the server and a rollback transaction is sent to the component having requested the modification. See Transaction Control in the IlsMvComponent class description. The function signature can be different under the following conditions:
- the function is a member of the class or of a derived class.
- its result converts implicitly to attrType.
- it can be invoked with an integer as argument.
Its modifier, setValue(), has the following signature:
IlsBoolean holder::setValue(int index,attrType value);

The function signature can be different under the following conditions:
- The function is a member of the class or of a parent class, and
- Its result converts implicitly to IlsBoolean, and
- It can be invoked with an integer and a attrType as arguments.
Its modification test, isModified(), has the following signature:
IlsBoolean holder::isModified(int index);

This signature can be different under the following conditions:
- the function is a member of the class or of a derived class, and
- its result converts implicitly to IlsBoolean, and
- it can be invoked with one integer value as argument.

See also: ILS_RW_INDEXED_ATTR_XXX().

◆ ILS_RW_INDEXED_ATTR_STRING

#define ILS_RW_INDEXED_ATTR_STRING	(	holder,
		attrLabel,
		getValue,
		setValue,
		isModified
	)

This macro declares attrLabel as a runtime attribute of the class holder.

This attribute is of type IlsString and can be modified.

Its accessor, getValue(), has the following signature:
IlsString holder::getValue(int index);

When the function returns IlsFalse, the attribute cannot be set to this value. In that case the current transaction is rolled back by the server and a rollback transaction is sent to the component having requested the modification. See Transaction Control in the IlsMvComponent class description. The function signature can be different under the following conditions:
- the function is a member of the class or of a derived class.
- its result converts implicitly to IlsString.
- it can be invoked with an integer as argument.
Its modifier, setValue(), has the following signature:
IlsBoolean holder::setValue(int index,IlsString value);

The function signature can be different under the following conditions:
- The function is a member of the class or of a parent class, and
- Its result converts implicitly to IlsBoolean, and
- It can be invoked with an integer and a IlsString as arguments.
Its modification test, isModified(), has the following signature:
IlsBoolean holder::isModified(int index);

This signature can be different under the following conditions:
- the function is a member of the class or of a derived class, and
- its result converts implicitly to IlsBoolean, and
- it can be invoked with one integer value as argument.

See also: ILS_RW_INDEXED_ATTR_XXX().

◆ ILS_RW_INDEXED_ATTR_USERTYPE

#define ILS_RW_INDEXED_ATTR_USERTYPE	(	holder,
		attrType,
		attrLabel,
		getValue,
		setValue,
		isModified
	)

This macro declares attrLabel as a runtime attribute of the class holder.

This attribute is of type attrType which derives from IlsMvUserType and can be modified.

Its accessor, getValue(), has the following signature:
attrType holder::getValue(int index);

When the function returns IlsFalse, the attribute cannot be set to this value. In that case the current transaction is rolled back by the server and a rollback transaction is sent to the component having requested the modification. See Transaction Control in the IlsMvComponent class description. The function signature can be different under the following conditions:
- the function is a member of the class or of a derived class.
- its result converts implicitly to attrType.
- it can be invoked with an integer as argument.
Its modifier, setValue(), has the following signature:
IlsBoolean holder::setValue(int index,attrType value);

The function signature can be different under the following conditions:
- The function is a member of the class or of a parent class, and
- Its result converts implicitly to IlsBoolean, and
- It can be invoked with an integer and a attrType as arguments.
Its modification test, isModified(), has the following signature:
IlsBoolean holder::isModified(int index);

This signature can be different under the following conditions:
- the function is a member of the class or of a derived class, and
- its result converts implicitly to IlsBoolean, and
- it can be invoked with one integer value as argument.

See also: ILS_RW_INDEXED_ATTR_XXX().

◆ ILS_RW_INDEXED_ATTR_XXX

#define ILS_RW_INDEXED_ATTR_XXX ( )

The macros ILS_RW_INDEXED_ATTR_xxx declare a read/write runtime indexed attribute for a server object type so that it can be used in view specifications.

This attribute is defined by an accessor, a modifier and a modification test.

The accessor is used by Rogue Wave Server during the notification of a dynamic view to notify the value of a representation attribute to a component or to evaluate a condition of representation and/or of propagation (see Dynamic View Types and C++ View Types).
The modifier is used by Rogue Wave Server during a component-to-server transaction to modify the attribute value. When the modifier returns IlsFalse and if the rollback is enabled by the component, the current transaction is rolled back by the server and a rollback transaction is sent to the component that requested the modification. See the Transaction Control sections in the IlsMvComponent and IlsMvServer class descriptions for more information.
Note
When the runtime attribute is not related to an entry or to a derived data member, it is your responsibility to force the modification state of the owning object by calling the member function IlsViewed::forceModify().
The modification test is used by Rogue Wave Server to detect whether the attribute has changed since the latest notification cycle. For instance, if the runtime attribute is associated with an entry, the test function should call the function IlsEntry::isModified() declared on the class template IlsEntry.

These macros allow you to declare pure runtime attributes whose names do not correspond to any data member of the Server object type.

These macros can be enclosed only between the pairs of macros:

ILS_OBJECT_BEGIN() / ILS_OBJECT_END()
ILS_ENTITY_BEGIN() / ILS_ENTITY_END()
ILS_MVVIEW_BEGIN() / ILS_MVVIEW_END()

or their derivatives.

Synopsis

See also: IlsEntry, IlsMvComponent, ILS_R_INDEXED_ATTR_XXX().

◆ ILS_RW_RELATION_1

#define ILS_RW_RELATION_1	(	origin,
		target,
		relNm,
		relAccessor,
		targAccessor,
		modifier
	)

This macro declares a server object relation as being accessible at runtime.

This relation can be of type IlsOwns or IlsUses. It differs from the relations declared with the macros ILS_OWNS_1 and ILS_USES_1 in that its accessor, the accessor to its target, and its modifiers are user-defined.

This macro can only be enclosed between the following pairs of macros:

ILS_OBJECT_BEGIN() / ILS_OBJECT_END()
ILS_ENTITY_BEGIN() / ILS_ENTITY_END()
ILS_MVVIEW_BEGIN() / ILS_MVVIEW_END()

or their derivatives.

See also: IlsOwns, ILS_OWNS_1(), ILS_R_RELATION_1(), IlsUses, ILS_USES_1(),
ILS_W_RELATION_1().

◆ ILS_RW_RELATION_N

#define ILS_RW_RELATION_N	(	origin,
		target,
		relNm,
		relAccessor,
		modifier
	)

This macro declares multiple server object relation as being accessible at runtime.

This type of relation differs from the runtime relations declared with the macros ILS_OWNS_N(), ILS_USES_N() and ILS_W_RELATION_N() in that its accessors and its modifier (that is, the member function used to add or remove target objects) are user-defined.

This macro can only be enclosed between the following pairs of macros:

ILS_OBJECT_BEGIN() / ILS_OBJECT_END()
ILS_ENTITY_BEGIN() / ILS_ENTITY_END()
ILS_MVVIEW_BEGIN() / ILS_MVVIEW_END()

or their derivatives.

See also: IlsOwns, ILS_OWNS_N(), ILS_R_RELATION_N(), IlsUses, ILS_USES_N(), ILS_W_RELATION_N().

◆ ILS_SV_MEMBER_FUNCTION

#define ILS_SV_MEMBER_FUNCTION ( )

These macros are similar to the macros ILS_MEMBER_FUNCTION() macros except that they can accept Server types as their arguments.

When a member function is declared through these macros, that function cannot be used from a dynamic-view type specification file nor from the execCallback API. These macros are meant to be used only from scripts whithin the context of Rogue Wave Views Script integration.

Even if a Server type appears as an argument to this function, the implementation function must declare an IlsMvValue object in its signature. When the member function is called from a script file, Rogue Wave Server encapsulates the pointer to the server object into an IlsMvValue of type IlsSvRef. See section Dynamic Member Functions of Chapter Rogue Wave Views Script Integration in the User's Guide for more information.

Synopsis

Arguments

These macros take the following arguments in this order:

the type of the function return value,
the Server type to which the member function belongs,
the function name,
the types of the function parameters.

All the runtime member functions of a same class must have a unique name. The result and the parameters of a member function can be of the following types:

char
IlsString
IlsBoolean
short
int
long
float
double
Any type that derives from IlsMvUserType.

When a runtime-accessible member function is called from the component, the result is not sent back to this component, since the callback mechanism is completely asynchronous. However, to allow for macro expansion requirements, such a function cannot have a result of type void.

See also: ILS_MEMBER_FUNCTION(), IlsSvRef.

◆ ILS_SV_MEMBER_FUNCTION0

#define ILS_SV_MEMBER_FUNCTION0	(	resType,
		objType,
		funNm
	)

declare script member function with zero parameter to runtime interpreter.

Parameters

resType	type of the returned value
objType	Server type to which the member function belongs
funNm	function name

See also: ILS_SV_MEMBER_FUNCTION().

◆ ILS_SV_MEMBER_FUNCTION1

#define ILS_SV_MEMBER_FUNCTION1	(	resType,
		objType,
		funNm,
		p1Type
	)

declare script member function with one parameter to runtime interpreter.

Parameters

resType	type of the returned value
objType	Server type to which the member function belongs
funNm	function name
p1Type	type of first parameter

See also: ILS_SV_MEMBER_FUNCTION().

◆ ILS_SV_MEMBER_FUNCTION2

#define ILS_SV_MEMBER_FUNCTION2	(	resType,
		objType,
		funNm,
		p1Type,
		p2Type
	)

declare script member function with two parameters to runtime interpreter.

Parameters

resType	type of the returned value
objType	Server type to which the member function belongs
funNm	function name
p1Type	type of first parameter
p2Type	type of second parameter

See also: ILS_SV_MEMBER_FUNCTION().

◆ ILS_SV_MEMBER_FUNCTION3

#define ILS_SV_MEMBER_FUNCTION3	(	resType,
		objType,
		funNm,
		p1Type,
		p2Type,
		p3Type
	)

declare script member function with three parameters to runtime interpreter.

Parameters

resType	type of the returned value
objType	Server type to which the member function belongs
funNm	function name
p1Type	type of first parameter
p2Type	type of second parameter
p3Type	type of third parameter

See also: ILS_SV_MEMBER_FUNCTION().

◆ ILS_SV_MEMBER_FUNCTION4

#define ILS_SV_MEMBER_FUNCTION4	(	resType,
		objType,
		funNm,
		p1Type,
		p2Type,
		p3Type,
		p4Type
	)

declare script member function with four parameters to runtime interpreter.

Parameters

resType	type of the returned value
objType	Server type to which the member function belongs
funNm	function name
p1Type	type of first parameter
p2Type	type of second parameter
p3Type	type of third parameter
p4Type	type of fourth parameter

See also: ILS_SV_MEMBER_FUNCTION().

◆ ILS_SV_MEMBER_FUNCTION5

#define ILS_SV_MEMBER_FUNCTION5	(	resType,
		objType,
		funNm,
		p1Type,
		p2Type,
		p3Type,
		p4Type,
		p5Type
	)

declare script member function with five parameters to runtime interpreter.

Parameters

resType	type of the returned value
objType	Server type to which the member function belongs
funNm	function name
p1Type	type of first parameter
p2Type	type of second parameter
p3Type	type of third parameter
p4Type	type of fourth parameter
p5Type	type of fifth parameter

See also: ILS_SV_MEMBER_FUNCTION().

◆ ILS_SV_MEMBER_FUNCTION6

#define ILS_SV_MEMBER_FUNCTION6	(	resType,
		objType,
		funNm,
		p1Type,
		p2Type,
		p3Type,
		p4Type,
		p5Type,
		p6Type
	)

declare script member function with six parameters to runtime interpreter.

Parameters

resType	type of the returned value
objType	Server type to which the member function belongs
funNm	function name
p1Type	type of first parameter
p2Type	type of second parameter
p3Type	type of third parameter
p4Type	type of fourth parameter
p5Type	type of fifth parameter
p6Type	type of sixth parameter

See also: ILS_SV_MEMBER_FUNCTION().

◆ ILS_SV_MEMBER_FUNCTION7

#define ILS_SV_MEMBER_FUNCTION7	(	resType,
		objType,
		funNm,
		p1Type,
		p2Type,
		p3Type,
		p4Type,
		p5Type,
		p6Type,
		p7Type
	)

declare script member function with seven parameters to runtime interpreter.

Parameters

resType	type of the returned value
objType	Server type to which the member function belongs
funNm	function name
p1Type	type of first parameter
p2Type	type of second parameter
p3Type	type of third parameter
p4Type	type of fourth parameter
p5Type	type of fifth parameter
p6Type	type of sixth parameter
p7Type	type of seventh parameter

See also: ILS_SV_MEMBER_FUNCTION().

◆ ILS_USERTYPE_DECL

#define ILS_USERTYPE_DECL	(	typeNm,
		parentNm
	)

This macro and ILS_USERTYPE_DEF() are used to implement a user-defined type deriving from IlsMvUserType.

Library: mvserver
and mvcomp

The macro ILS_USERTYPE_DECL() must be added to any classes deriving from IlsMvUserType. As its first argument, this macro takes the name of the class where it is declared. The second argument, classNm, is either the type IlsMvUserType or the base class of classNm, which should itself derive from IlsMvUserType.

The macro ILS_USERTYPE_DECL() declares the following functions:

typeNm::typeNm(IlsMvValue&);

This constructor is called when a component executes a callback on a server runtime function that taking a user-defined type as a parameter, such as the virtual callbacks to member functions in the IlsRpObject class and the function IlsMvComponent::execUserAsyncCallback()).

This constructor must be implemented by the user and should be written as follows:
typeNm::typeNm(IlsMvValue& v) {

IlsMvUserType* uv = v; // IlsMvValue conversion operator

if (ut) {

typeNm* cv = typeNm::Narrow(*ut);

if (cv) {

// assignment of the data members ...

}

else {

// Type mismatch ....

}

}

else {

// Type mismatch ....

}

}
[static] typeNm* typeNm::Narrow(IlsMvUserType& v);

This static function returns 0 if the real type of v is neither of the type typeNm nor of a derived type. Otherwise, it returns a pointer to v after it has been converted to typeNm.
[virtual] IlsMvMessage& ilsEncode(IlsMvMessage&) const;

This virtual function is used by ILOG Server to insert an object of the type typeNm into an IlsMvMessage.
[static] IlsMvUserType* IlsDecode(IlsMvMessage&);

This static function is used to extract an object of the type typeNm from an IlsMvMessage.

Note: The implicitly-declared constructor and the functions ilsEncode() and IlsDecode() must be implemented by the user.

See also: ILS_USERTYPE_DEF(), IlsMvMessage, IlsMvUserType.

◆ ILS_USERTYPE_DEF

#define ILS_USERTYPE_DEF	(	typeNm,
		parentNm
	)

This macro and ILS_USERTYPE_DECL() are used to implement a user-defined type deriving from IlsMvUserType.

The macro ILS_USERTYPE_DEF() must be added to the typeNm definition file. It implements the static function typeNm::Narrow() and declares the function typeNm::IlsDecode() in an ILOG Server library table.

Note: The implicitly-declared constructor and the functions ilsEncode() and IlsDecode() must be implemented by the user.

See also: ILS_USERTYPE_DECL(), IlsMvMessage, IlsMvUserType.

◆ ILS_USES_1

#define ILS_USES_1	(	origin,
		target,
		relNm
	)

This macro declares a server relation of type IlsUses as being accessible at runtime, so that it can be used in view specifications.

The runtime relation uses the accessors and the modifier defined in the class template IlsUses.

This macro can only be enclosed between the following pairs of macros:

ILS_OBJECT_BEGIN() / ILS_OBJECT_END()
ILS_ENTITY_BEGIN() / ILS_ENTITY_END()
ILS_MVVIEW_BEGIN() / ILS_MVVIEW_END()

or their derivatives.

Parameters

origin	is the class where the relation is declared.
target	is the class of the relation target.
relNm	is the name of the relation.

See also: IlsUses, ILS_W_RELATION_1().

◆ ILS_USES_N

#define ILS_USES_N	(	origin,
		target,
		relNm
	)

This macro declares a server relation of type IlsUsesList, IlsUsesSet, IlsUsesDynamicArray, or IlsUsesFixedArray as being accessible at runtime, so that it can be used in view specifications.

This runtime relation uses the accessors and modifiers defined in the IlsUsesXXX class template that corresponds to its C++ type.

This macro can only be enclosed between the following pairs of macros:

ILS_OBJECT_BEGIN() / ILS_OBJECT_END()
ILS_ENTITY_BEGIN() / ILS_ENTITY_END()
ILS_MVVIEW_BEGIN() / ILS_MVVIEW_END()

or their derivatives.

Parameters

origin	is the class where the relation is declared.
target	is the class of the relation target.
relNm	is the name of the relation.

See also: ILS_R_RELATION_N(), ILS_RW_RELATION_N(), ILS_USES_1(), IlsUsesDynamicArray, IlsUsesFixedArray, IlsUsesList, IlsUsesSet, ILS_W_RELATION_N().

◆ ILS_W_ENTRY_CHAR

#define ILS_W_ENTRY_CHAR	(	holder,
		attrLabel,
		setValue
	)

This macro declares the entry data member specified by entryLabel as a runtime attribute of the class holder.

This attribute is of type char.

Its modifier, setValue(), has the following signature:

IlsBoolean holder::setValue(char value)

When the function returns IlsFalse, the attribute cannot be set to this value. In that case, any current transaction on the server side is rolled back by the server and a rollback transaction is sent to the component that requested the modification. See Transaction Control in the IlsMvComponent class description.

The signature of the function can be different under the following conditions:

it is a member of the class or of a derived class, and
its results converts implicitly to IlsBoolean, and
it can be invoked with a char as argument.

See also: ILS_W_ENTRY_XXX().

◆ ILS_W_ENTRY_DOUBLE

#define ILS_W_ENTRY_DOUBLE	(	holder,
		attrLabel,
		setValue
	)

This macro declares the entry data member specified by entryLabel as a runtime attribute of the class holder.

This attribute is of type double.

Its modifier, setValue(), has the following signature:

IlsBoolean holder::setValue(double value)

When the function returns IlsFalse, the attribute cannot be set to this value. In that case, any current transaction on the server side is rolled back by the server and a rollback transaction is sent to the component that requested the modification. See Transaction Control in the IlsMvComponent class description.

The signature of the function can be different under the following conditions:

it is a member of the class or of a derived class, and
its results converts implicitly to IlsBoolean, and
it can be invoked with a double as argument.

See also: ILS_W_ENTRY_XXX().

◆ ILS_W_ENTRY_FLOAT

#define ILS_W_ENTRY_FLOAT	(	holder,
		attrLabel,
		setValue
	)

This macro declares the entry data member specified by entryLabel as a runtime attribute of the class holder.

This attribute is of type float.

Its modifier, setValue(), has the following signature:

IlsBoolean holder::setValue(float value)

When the function returns IlsFalse, the attribute cannot be set to this value. In that case, any current transaction on the server side is rolled back by the server and a rollback transaction is sent to the component that requested the modification. See Transaction Control in the IlsMvComponent class description.

The signature of the function can be different under the following conditions:

it is a member of the class or of a derived class, and
its results converts implicitly to IlsBoolean, and
it can be invoked with a float as argument.

See also: ILS_W_ENTRY_XXX().

◆ ILS_W_ENTRY_INT

#define ILS_W_ENTRY_INT	(	holder,
		attrLabel,
		setValue
	)

This macro declares the entry data member specified by entryLabel as a runtime attribute of the class holder.

This attribute is of type long.

Its modifier, setValue(), has the following signature:

IlsBoolean holder::setValue(long value)

When the function returns IlsFalse, the attribute cannot be set to this value. In that case, any current transaction on the server side is rolled back by the server and a rollback transaction is sent to the component that requested the modification. See Transaction Control in the IlsMvComponent class description.

The signature of the function can be different under the following conditions:

it is a member of the class or of a derived class, and
its results converts implicitly to IlsBoolean, and
it can be invoked with a long as argument.

See also: ILS_W_ENTRY_XXX().

◆ ILS_W_ENTRY_LONG

#define ILS_W_ENTRY_LONG	(	holder,
		attrLabel,
		setValue
	)

This macro declares the entry data member specified by entryLabel as a runtime attribute of the class holder.

This attribute is of type long.

Its modifier, setValue(), has the following signature:

IlsBoolean holder::setValue(long value)

When the function returns IlsFalse, the attribute cannot be set to this value. In that case, any current transaction on the server side is rolled back by the server and a rollback transaction is sent to the component that requested the modification. See Transaction Control in the IlsMvComponent class description.

The signature of the function can be different under the following conditions:

it is a member of the class or of a derived class, and
its results converts implicitly to IlsBoolean, and
it can be invoked with a long as argument.

See also: ILS_W_ENTRY_XXX().

◆ ILS_W_ENTRY_MVVALUE

#define ILS_W_ENTRY_MVVALUE	(	holder,
		attrLabel,
		setValue
	)

This macro declares the entry data member specified by entryLabel as a runtime attribute of the class holder.

This attribute is of type IlsMvValue.

Its modifier, setValue(), has the following signature:

IlsBoolean holder::setValue(IlsMvValue value)

When the function returns IlsFalse, the attribute cannot be set to this value. In that case, any current transaction on the server side is rolled back by the server and a rollback transaction is sent to the component that requested the modification. See Transaction Control in the IlsMvComponent class description.

The signature of the function can be different under the following conditions:

it is a member of the class or of a derived class, and
its results converts implicitly to IlsBoolean, and
it can be invoked with an IlsMvValue as argument.

See also: ILS_W_ENTRY_XXX().

◆ ILS_W_ENTRY_SHORT

#define ILS_W_ENTRY_SHORT	(	holder,
		attrLabel,
		setValue
	)

This macro declares the entry data member specified by entryLabel as a runtime attribute of the class holder.

This attribute is of type short.

Its modifier, setValue(), has the following signature:

IlsBoolean holder::setValue(short value)

When the function returns IlsFalse, the attribute cannot be set to this value. In that case, any current transaction on the server side is rolled back by the server and a rollback transaction is sent to the component that requested the modification. See Transaction Control in the IlsMvComponent class description.

The signature of the function can be different under the following conditions:

it is a member of the class or of a derived class, and
its results converts implicitly to IlsBoolean, and
it can be invoked with a short as argument.

See also: ILS_W_ENTRY_XXX().

◆ ILS_W_ENTRY_STRING

#define ILS_W_ENTRY_STRING	(	holder,
		attrLabel,
		setValue
	)

This macro declares the entry data member specified by entryLabel as a runtime attribute of the class holder.

This attribute is of type IlsString.

Its modifier, setValue(), has the following signature:

IlsBoolean holder::setValue(IlsString value)

When the function returns IlsFalse, the attribute cannot be set to this value. In that case, any current transaction on the server side is rolled back by the server and a rollback transaction is sent to the component that requested the modification. See Transaction Control in the IlsMvComponent class description.

The signature of the function can be different under the following conditions:

it is a member of the class or of a derived class, and
its results converts implicitly to IlsBoolean, and
it can be invoked with an IlsString as argument.

See also: ILS_W_ENTRY_XXX().

◆ ILS_W_ENTRY_USERTYPE

#define ILS_W_ENTRY_USERTYPE	(	holder,
		attrType,
		attrLabel,
		setValue
	)

This macro declares the entry data member specified by entryLabel as a runtime attribute of the class holder.

This attribute is of type attrType which derives from IlsMvUserType.

Its modifier, setValue(), has the following signature:

IlsBoolean holder::setValue(attrType value)

When the function returns IlsFalse, the attribute cannot be set to this value. In that case, any current transaction on the server side is rolled back by the server and a rollback transaction is sent to the component that requested the modification. See Transaction Control in the IlsMvComponent class description.

The signature of the function can be different under the following conditions:

it is a member of the class or of a derived class, and
its results converts implicitly to IlsBoolean, and
it can be invoked with a attrType as argument.

See also: ILS_W_ENTRY_XXX().

◆ ILS_W_ENTRY_XXX

#define ILS_W_ENTRY_XXX ( )

The macros ILS_W_ENTRY_XXX() declare server entry data members as being accessible at runtime so that they can be used in view specifications.

The runtime entry data members declared with these macros differ from those declared with the ILS_ENTRY_XXX() macros, in that the modifier is user-defined.

The modifier is used by Rogue Wave Server during a component-to-server transaction to modify the attribute value. When the modifier returns IlsFalse and the rollback mode is enabled by the component, the current transaction is rolled back by the server and a rollback transaction is sent to the component that requested the modification. See the Transaction Control sections in the IlsMvComponent and IlsMvServer class descriptions for more information.

These macros can be enclosed only between the following pairs of macros:

ILS_OBJECT_BEGIN() / ILS_OBJECT_END()
ILS_ENTITY_BEGIN() / ILS_ENTITY_END()
ILS_MVVIEW_BEGIN() / ILS_MVVIEW_END()

or their derivatives.

Synopsis

ILS_W_ENTRY_CHAR(holder,entryLabel,setValue)
ILS_W_ENTRY_BOOLEAN(holder,entryLabel,setValue)
ILS_W_ENTRY_SHORT(holder,entryLabel,setValue)
ILS_W_ENTRY_INT(holder,entryLabel,setValue)
ILS_W_ENTRY_LONG(holder,entryLabel,setValue)
ILS_W_ENTRY_FLOAT(holder,entryLabel,setValue)
ILS_W_ENTRY_DOUBLE(holder,entryLabel,setValue)
ILS_W_ENTRY_STRING(holder,entryLabel,setValue)
ILS_W_ENTRY_USERTYPE(holder,userType,entryLabel,setValue)
ILS_W_ENTRY_ENUM(holder,enumType,attrLabel,setValue)

See also: IlsEntry, ILS_ENTRY_XXX().

◆ ILS_W_RELATION_1

#define ILS_W_RELATION_1	(	origin,
		target,
		relNm,
		modifier
	)

This macro declares a simple server relation as being accessible at runtime.

This relation can be of type IlsOwns or IlsUses. It differs from the relations declared with the macros ILS_OWNS_1() or ILS_USES_1() in that its modifier is user-defined.

This macro can be enclosed only between the following pairs of macros:

ILS_OBJECT_BEGIN() / ILS_OBJECT_END()
ILS_ENTITY_BEGIN() / ILS_ENTITY_END()
ILS_MVVIEW_BEGIN() / ILS_MVVIEW_END()

or their derivatives.

Parameters

origin	is the class where the relation is declared.
target	is the target class.
relNm	is the name of the relation.
modifier	is the target modifier. Its signature is the following: IlsBoolean origin::setTarget(target); It can vary under the following conditions: The function is a member of the class `origin` or of a parent class. It converts to `IlsBoolean`. It can be invoked with an argument of type `target`. When the modifier returns `IlsFalse` and the rollback mode is enabled by the component, the current transaction is rolled back by the server and a rollback transaction is sent to the component that requested the modification. See the Transaction Control sections in the `IlsMvComponent` and `IlsMvServer` class descriptions for more information.

See also: ILS_INVERTED_1(), IlsOwns, ILS_OWNS_1(), ILS_R_RELATION_1(), ILS_RW_RELATION_1(), IlsUses, ILS_USES_1().

◆ ILS_W_RELATION_N

#define ILS_W_RELATION_N	(	origin,
		target,
		relNm,
		modifier
	)

This macro declares a multiple server relation as being accessible at runtime.

This type of relation differs from the runtime relations declared with the macros ILS_OWNS_N() and ILS_USES_N() in that its modifier (that is, the member function used to add or remove target objects) is user-defined. This macro can be enclosed only between the following pairs of macros:

ILS_OBJECT_BEGIN() / ILS_OBJECT_END()
ILS_ENTITY_BEGIN() / ILS_ENTITY_END()
ILS_MVVIEW_BEGIN() / ILS_MVVIEW_END()

or their derivatives.

Arguments

This macro takes the following arguments:

Parameters

origin	designates the class where the relation is declared.
target	specifies the class of the relation target.
relNm	stands for the name of the relation.
modifier	is an editing function with the following signature: IlsBoolean origin::modifier(target&,IlsBoolean); Its first argument specifies the object to be added to or removed from the relation. The second argument is `IlsBoolean` value that indicates whether that object should be added (`IlsTrue`) or removed (`IlsFalse`). The signature of this function can vary under the following conditions: The function is a member of the class `origin` or of a parent class. Its result converts to `IlsBoolean`. It can be invoked with two arguments of type `target` and `IlsBoolean` respectively.

When the modifier returns IlsFalse and if the rollback is enabled by the component, the current transaction is rolled back by the server and a rollback transaction is sent to the component that requested the modification. See the Transaction Control sections in the IlsMvComponent and IlsMvServer class descriptions for more information.

See also: IlsOwns, ILS_OWNS_N(), ILS_R_RELATION_N(), ILS_RW_RELATION_N(), IlsUses, ILS_USES_N().

Typedef Documentation

◆ IlsAttributeAccessor

typedef IlsAttributeAccessorFunctor* IlsAttributeAccessor

This type is an accessor functor to the value of a non-indexed attribute.

The parameter owner is the owner of the attribute. It is used by the server model interpreter.

class IlsAttributeAccessorFunctor {
public:
  virtual IlsMvValue operator () (IlsViewed& owner) const; 
};

Library: server, mvcomp

See also: IlsAttributeDef, IlsModelInterpreter.

◆ IlsAttributeModifTest

typedef IlsAttributeModifTestFunctor* IlsAttributeModifTest

This type is a functor used by the server model interpreter to test the modification of a non-indexed attribute.

The parameter owner is the owner of the attribute.

class ILSIMPORT_MVSVR IlsAttributeModifTestFunctor {
public:
  virtual IlsBoolean operator()(IlsViewed& owner) const;
};

Library: server
, mvcomp.

See also: IlsAttributeDef, IlsModelInterpreter.

◆ IlsDerivedEvaluatorFunction

typedef IlsMvValue(* IlsDerivedEvaluatorFunction) (IlsViewed &)

This function pointer type is used to assign an evaluation function to a derived dynamic attribute.

Library: server
.

See also: IlsModelInterpreter::DeclDerivedEvaluator().

◆ IlsIdxAttributeAccessor

typedef IlsIdxAttributeAccessorFunctor* IlsIdxAttributeAccessor

This type is an accessor functor to the value of an indexed attribute.

It takes the following parameters:

owner is the owner of the attribute.
index is the index of the attribute.

class IlsIdxAttributeAccessorFunctor {
public:
  virtual IlsMvValue operator () (IlsViewed& owner, int index) const; 
};

Library: server
, mvcomp.

See also: IlsAttributeDef, IlsModelInterpreter.

◆ IlsIdxAttributeModifTest

typedef IlsIdxAttributeModifTestFunctor* IlsIdxAttributeModifTest

This type is a functor used by the server model interpreter to test the modification of an indexed attribute.

It takes the following parameters:

owner is the owner of the attribute.
index is the index of the attribute.

class IlsIdxAttributeModifTestFunctor {
public:
  virtual IlsBoolean operator()(IlsViewed& owner, int index) const;
};

Library: server
, mvcomp.

See also: IlsAttributeDef, IlsModelInterpreter.

◆ IlsMsgDecoder

typedef char*(* IlsMsgDecoder) (const char *buf, unsigned long &len)

This function type is used when a message is expected from the communication layer.

The incoming message of length len is in the buf argument and this function should return the new buffer that will be received and assign the new length to the len argument.

Library: server

See also: IlsInvertedRelationList, IlsOwnsList, IlsUsesList.

◆ IlsMsgEncoder

typedef char*(* IlsMsgEncoder) (const char *buf, unsigned long &len)

This function type is used when a message is to be sent over the communication layer.

The outcoming message of length len is in the buf argument and this function should return the new buffer that will be sent and assigned the new length to the len argument.

Library: server

See also: IlsInvertedRelationList, IlsOwnsList, IlsUsesList.

◆ IlsMvArray

typedef MvArray IlsMvArray

As a user type, IlsMvArray is available under the name MvArray to be compliant with the Java API naming conventions.

◆ IlsMvKeyValueTable

typedef MvKeyValueTable IlsMvKeyValueTable

As a user type, IlsMvKeyValueTable is available under the name MvKeyValueTable to be compliant with the Java API naming conventions.

◆ IlsObjectConstructor

typedef IlsObjectConstructorFunctor* IlsObjectConstructor

This functor is used by the server model interpreter to create a new instance of a server object.

The string passed as a parameter is null if the object type has no associated identifier attribute or if this identifier has not been assigned when the constructor is requested.

class IlsObjectConstructorFunctor{
public:
  virtual IlsViewed* operator ()(IlsString) const;
};

Library: server
, mvcomp.

See also: IlsObjectType, ILS_ENTITY_BEGIN, ILS_ENTITY_END, ILS_OBJECT_BEGIN, ILS_OBJECT_END.

◆ IlsRelationAccessor

typedef IlsRelationAccessorFunctor* IlsRelationAccessor

This relation accessor is a functor used by the server model interpreter.

It takes the object owning the relation as a parameter.

class IlsRelationAccessorFunctor {
public:
  virtual IlsViewedRel* operator() (IlsViewed&) const;
};

Library: server
, mvcomp.

See also: IlsModelInterpreter, IlsRelationDef.

◆ IlsRelationModifier

typedef IlsRelationModifierFunctor* IlsRelationModifier

This type is a functor used by the server model interpreter to modify a relation.

It takes the following parameters:

owner is the owner of the relation.
target is a pointer to the new target (unary relation) or to a target to be inserted or extracted (n-ary relations).

class IlsRelationModifierFunctor {
public:
  virtual IlsBoolean operator()(IlsViewed& owner, IlsViewed* target) const;
};

Library: server
, mvcomp.

See also: IlsModelInterpreter, IlsRelationDef.

◆ IlsRepresentationId

typedef unsigned long IlsRepresentationId

This numeric type is used to identify a representation.

Library: mvserver
and mvcomp

See also: IlsRepresentation, IlsRpObjectId.

◆ IlsRpAttributeId

typedef short IlsRpAttributeId

This numeric type is used to identify a representation object attribute or a representation object model attribute.

Library: mvserver
and mvcomp

See also: IlsRpObject, IlsRpObjModel.

◆ IlsRpModelId

typedef unsigned short IlsRpModelId

This numeric type is used to identify a representation model.

Library: mvserver
and mvcomp

See also: IlsRpModel, IlsRpObjModel.

◆ IlsRpObjectId

typedef unsigned long IlsRpObjectId

This numeric type is used to identify a representation object.

Library: mvserver
and mvcomp

See also: IlsRpObjModel, IlsRpModelId.

◆ IlsRpStatus

typedef unsigned short IlsRpStatus

This type is used to specify the representation status of a server object in a view.

Library: mvserver
and mvcomp

See also: IlsMvView, Chapter 2.

◆ IlsRpUpdateType

typedef int IlsRpUpdateType

This type definition is used to indicate what types of editing operations are performed on a server object by a component through a dynamic view.

Its possible values are obtained by using OR expressions with the values of the enumerated type IlsRpUpdateEnum. See the member functions IlsViewed::beginEdition() and IlsViewed::endEdition() for details.

Library: server
.

See also: IlsViewed.

◆ IlsRTFunction

typedef IlsRTFunctionFunctor* IlsRTFunction

This type is a functor to access member functions or global functions.

It is used by the server model interpreter and takes the following parameters:

ptr is a pointer to the object on which the member function applied or a null pointer if the function is a global function.
values is a pointer to an array of values that are used to assign the function parameters.
dim is the dimension of this array.

class IlsRTFunctionFunctor {
public:
  virtual IlsMvValue operator ()(void* ptr,
                                 const IlsMvValue* values,
                                 int dim) const;
};

Library: server
, mvcomp.

See also: IlsFunctionDef, IlsModelInterpreter

◆ IlsRTFunctionPtr

typedef IlsMvValue(* IlsRTFunctionPtr) (void *, const IlsMvValue *, int dim)

This type is a pointer to a function that takes a non-typed object as its first parameter and an array of arguments.

Functions of this type are registered with the server model interpreter to provide dynamic methods with a C++ implementation.

See the static function IlsModelInterpreter::DeclFunImplementation().

Library: server
, mvcomp.

See also: IlsModelInterpreter.

◆ IlsSimpleTargetAccessor

typedef IlsSimpleTargetAccessorFunctor* IlsSimpleTargetAccessor

This type is an accessor functor to the target of unary relations.

It is used by the server model interpreter and takes the following parameters:

owner is the owner of the relation.
id is the identifier of the relation target type (see IlsViewed::getTypeId).

class IlsSimpleTargetAccessorFunctor {
public:
  virtual IlsViewed* operator ()(IlsViewed& owner, IlsTypeId id) const;
};

Library: server
, mvcomp.

See also: IlsModelInterpreter, IlsRelationDef, IlsViewed.

◆ IlsTransactionId

typedef unsigned long IlsTransactionId

This numeric type is used to identify a component-to-server transaction.

Library: mvserver
and mvcomp

See also: IlsMvComponent.

◆ Priority

typedef signed char IlsMvView::Priority

View notification priority.

Library: mvserver

This type corresponds to a signed char. A priority value must range between PriorityMin and PriorityMax. The default value is PriorityDefault.

Synopsis

const IlsMvView::PriorityMin = (IlsMvView::Priority)-126;
const IlsMvView::PriorityMax = (IlsMvView::Priority)126;
const IlsMvView::PriorityDefault=(IlsMvView::Priority)0;

See also: IlsMvView::setPriority(), IlsMvView::getPriority().

Enumeration Type Documentation

◆ AttributeKind

enum IlsRTTypes::AttributeKind

This enumerated type lists the various types of server attributes.

Library: mvserver

It is used as a member of the class IlsAttributeDef.

See also: IlsAttributeDef, ILS_DERIVED_XXX(), ILS_ENTRY_XXX(), ILS_RW_ATTRIBUTE_XXX(), ILS_RW_INDEXED_ATTR_XXX(), ILS_W_ENTRY_XXX().

Enumerator
EntryValue	Defines an entry attribute. Use the function `IlsAttributeDef::isEntry()` to test whether the attribute is an entry.
DerivedValue	Defines a derived attribute. Use the function `IlsAttributeDef::isDerived()` to test whether the attribute is a derived attribute.
AttrValue	Defines a pure or simple attribute. Use the function `IlsAttributeDef::isPureAttr()` to test whether the attribute is a simple attribute.

◆ IlsRpUpdateEnum

enum IlsRpUpdateEnum

This enumerated type is used to indicate the type of editing operation to be performed on a server object by a component through a dynamic view.

See the member functions IlsViewed::beginEdition() and IlsViewed::endEdition() for details.

This enumerated type contains also not documented values that are only used internally by the dynamic view server protocol.

Library: server
.

See also: IlsViewed

Enumerator
ILS_RP_CREATION	The server object has been created.
ILS_RP_DELETION	The server object has been removed.
ILS_RP_MODIFICATION	The server object has been modified.

◆ Kind

enum IlsMvDataType::Kind

Specifies the type of an attribute attached to a representation object model.

Library: mvserver
and mvcomp

Warning: Values of type "integer" are handled as "long" values, both on the server side and on the component side.

See also: IlsMvDataType::getKind().

Enumerator
MV_VOID	`void`
MV_BOOL	`IlsBoolean`
MV_CHAR	`char`
MV_LONG	`long`
MV_FLOAT	`float`
MV_DOUBLE	`double`
MV_STRING	`IlsString`
MV_USER	User-defined.
MV_REF	A reference to a representation object.
MV_HREF	A hyper reference.
MV_COLLECTOR	A collector.
MV_ANY	`IlsAny`
MV_VALUE	`IlsMvValue`
MV_FILE	`IlsMvFile`
MV_SVREF	A reference to a server object.

◆ RelationKind

enum IlsRTTypes::RelationKind

This enumerated type lists the various types of server relations.

Library: mvserver

It is used as a member of the class IlsRelationDef.

See also: IlsRelationDef, ILS_RW_RELATION_1(), ILS_RW_RELATION_N(), ILS_W_RELATION_1(), ILS_W_RELATION_N().

Enumerator
REL_1	other unary relation
USES_1	unary use relation
OWNS_1	unary ownership relation
INVERTED_1	unary inverted relation
REL_N	other n-ary relation
USES_N	n-ary use relation
OWNS_N	n-ary ownership relation
INVERTED_N	n-ary inverted relation

◆ TraceType

enum IlsMvEndPoint::TraceType

Specifies the type of trace attached to interactions between an object server and its components. See the trace functions of the class IlsMvEndPoint for more information.

Library: mvserver
and mvcomp

See also: IlsMvEndPoint::trace(), IlsMvEndPoint::Trace().

Enumerator
NO_TRACE	No trace required.
TRACE_TRANS	Tracing input and output transaction.
TRACE_MSG	Tracing Server protocol messages.
TRACE_TAG_ERR	Tagging the user-type values exchanged Tracing type mismatches between encoding and decoding (see the class IlsMvUserType)
TRACE_TAG_PRINT	Same as `TRACE_TAG_ERR` and printing the name of the type for the exchanged data that make up those values.

Category Description

Classes

Macros

Typedefs

Enumerations

Macro Definition Documentation

◆ ILS_DERIVED_BOOLEAN

◆ ILS_DERIVED_CHAR

◆ ILS_DERIVED_DOUBLE

◆ ILS_DERIVED_ENUM

◆ ILS_DERIVED_FLOAT

◆ ILS_DERIVED_INT

◆ ILS_DERIVED_LONG

◆ ILS_DERIVED_MVVALUE

◆ ILS_DERIVED_SHORT

◆ ILS_DERIVED_STRING

◆ ILS_DERIVED_USERTYPE

◆ ILS_DERIVED_XXX

◆ ILS_ENTITY1_BEGIN

◆ ILS_ENTITY2_BEGIN

◆ ILS_ENTITY_BEGIN

◆ ILS_ENTITY_DECL

◆ ILS_ENTITY_END

◆ ILS_ENTITY_INIT

◆ ILS_ENTRY_BOOLEAN

◆ ILS_ENTRY_CHAR

◆ ILS_ENTRY_DOUBLE

◆ ILS_ENTRY_ENUM

◆ ILS_ENTRY_FLOAT

◆ ILS_ENTRY_INT

◆ ILS_ENTRY_LONG

◆ ILS_ENTRY_MVVALUE

◆ ILS_ENTRY_SHORT

◆ ILS_ENTRY_STRING

◆ ILS_ENTRY_USERTYPE

◆ ILS_ENTRY_XXX

◆ ILS_GLOBAL_FUNCTION

◆ ILS_GLOBAL_FUNCTION0

◆ ILS_GLOBAL_FUNCTION1

◆ ILS_GLOBAL_FUNCTION2

◆ ILS_GLOBAL_FUNCTION3

◆ ILS_GLOBAL_FUNCTION4

◆ ILS_GLOBAL_FUNCTION5

◆ ILS_GLOBAL_FUNCTION6

◆ ILS_GLOBAL_FUNCTION7

◆ ILS_INVERTED_1

◆ ILS_INVERTED_N

◆ ILS_MEMBER_FUNCTION

◆ ILS_MEMBER_FUNCTION0

◆ ILS_MEMBER_FUNCTION1

◆ ILS_MEMBER_FUNCTION2

◆ ILS_MEMBER_FUNCTION3

◆ ILS_MEMBER_FUNCTION4

◆ ILS_MEMBER_FUNCTION5

◆ ILS_MEMBER_FUNCTION6

◆ ILS_MEMBER_FUNCTION7

◆ ILS_MVVIEW_BEGIN

◆ ILS_MVVIEW_DECL

◆ ILS_MVVIEW_END

◆ ILS_MVVIEW_INIT

◆ ILS_OBJECT1_BEGIN

◆ ILS_OBJECT1_WITH_ID_BEGIN

◆ ILS_OBJECT2_BEGIN

◆ ILS_OBJECT2_WITH_ID_BEGIN

◆ ILS_OBJECT_BEGIN

◆ ILS_OBJECT_DECL

◆ ILS_OBJECT_END

◆ ILS_OBJECT_INIT

◆ ILS_OBJECT_WITH_ID_BEGIN

◆ ILS_OWNS_1

◆ ILS_OWNS_N

◆ ILS_R_ATTRIBUTE_BOOLEAN

◆ ILS_R_ATTRIBUTE_CHAR

◆ ILS_R_ATTRIBUTE_DOUBLE

◆ ILS_R_ATTRIBUTE_ENUM

◆ ILS_R_ATTRIBUTE_FLOAT

◆ ILS_R_ATTRIBUTE_INT

◆ ILS_R_ATTRIBUTE_LONG

◆ ILS_R_ATTRIBUTE_MVVALUE

◆ ILS_R_ATTRIBUTE_SHORT