Set of classes and macros to be used on component (client) side when using dynamic views. More...

Category Description

Set of classes and macros to be used on component (client) side when using dynamic views.

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

class	IlsMvComponent
	This class implements components for a dynamic-view server (see the class `IlsMvServer`). More...

class	IlsMvComponentFactory
	This class is the factory class used to create instances of the `IlsMvComponent` class. 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	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	IlsRepresentation
	This class implements in a component the representations that are associated with each dynamic view in the server. More...

class	IlsRpAttrModel
	This class defines an attribute of a dynamic representation object model (see `IlsRpObjModel`). More...

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

class	IlsRpModelInterpreter
	This class is a runtime model interpreter used on the component side in Rogue Wave Server applications. More...

class	IlsRpObject
	Base class for component side representation objects. More...

class	IlsRpObjModel
	This class defines the dynamic model of a representation object. More...

class	IlsRtModelParser
	This class is a base class of `IlsMvComponent`. 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...

class	IlsMvComponent::RepresentationListener
	This nested class is the interface of a representation listener that can be registered to the component. More...

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

Macros
#define	ILS_REPRESENTATION1_BEGIN(typeNm, parent1)
	macro to declare to the representation model interpreter a subclass of `IlsRepresentation` that derives from another subclass of `IlsRepresentation`. See `ILS_REPRESENTATION_BEGIN()`. More...

#define	ILS_REPRESENTATION_BEGIN(typeNm)
	This macro allows you to declare these classes to the representation model interpreter, which is implemented in the Rogue Wave Server library (see `IlsRpModel`). More...

#define	ILS_REPRESENTATION_DECL(typeNm)
	This macro allows you to declare classes that derive from `IlsRepresentation` to the representation model interpreter, which is implemented in the Rogue Wave Server library. More...

#define	ILS_REPRESENTATION_END(typeNm)
	macro used for declaring an `IlsRepresentation` subclass to the representation model interpreter. See `ILS_REPRESENTATION_BEGIN()`. More...

#define	ILS_REPRESENTATION_INIT(typeNm)

#define	ILS_RP_ATTR_BOOLEAN(rpType, attrLabel, modifier)
	This macro associates the member function `rpType::modifier()` with the Boolean runtime attribute `attrLabel`. More...

#define	ILS_RP_ATTR_CHAR(rpType, attrLabel, modifier)
	This macro associates the member function `rpType::modifier()` with the runtime attribute `attrLabel` of type `char`. More...

#define	ILS_RP_ATTR_DOUBLE(rpType, attrLabel, modifier)
	This macro associates the member function `rpType::modifier()` with the runtime attribute `attrLabel` of type `double`. More...

#define	ILS_RP_ATTR_FILE(rpType, attrLabel, modifier)
	This macro associates the member function `rpType::modifier()` with the runtime attribute `attrLabel` of type `IlsMvFile`. More...

#define	ILS_RP_ATTR_FLOAT(rpType, attrLabel, modifier)
	This macro associates the member function `rpType::modifier()` with the runtime attribute `attrLabel` of type `float`. More...

#define	ILS_RP_ATTR_HREF(rpType, attrLabel, modifier)
	This macro associates the member function `rpType::modifier()` with the runtime attribute `attrLabel`, which is a hyper-reference. At the representation level, a hyper-reference is defined by its label, which is of type `IlsString`. More...

#define	ILS_RP_ATTR_INT(rpType, attrLabel, modifier)
	This macro associates the member function `rpType::modifier()` with the runtime attribute `attrLabel` of type long. More...

#define	ILS_RP_ATTR_LONG(rpType, attrLabel, modifier)
	This macro associates the member function `rpType::modifier()` with the runtime attribute `attrLabel` of type long. More...

#define	ILS_RP_ATTR_MVVALUE(rpType, attrLabel, modifier)
	This macro associates the member function `rpType::modifier()` with the runtime attribute `attrLabel` of type `IlsMvValue`. More...

#define	ILS_RP_ATTR_REF(rpType, attrLabel, modifier, attrType)
	This macro associates the member function `rpType::modifier()` with the runtime attribute `attrLabel`, which is a reference to a representation object of type `refType`. More...

#define	ILS_RP_ATTR_STRING(rpType, attrLabel, modifier)
	This macro associates the member function `rpType::modifier()` with the runtime attribute `attrLabel` of type `string`. More...

#define	ILS_RP_ATTR_USERTYPE(rpType, userType, attrLabel, modifier)
	This macro associates the member function `rpType::modifier()` with the runtime attribute `attrLabel`, which is a user-defined type. More...

#define	ILS_RP_ATTR_XXX()
	The macros `ILS_RP_ATTR_XXX()` let you associate editing functions with representation attributes referenced in dynamic view type specifications. More...

#define	ILS_RP_DEFAULT_BOOLEAN(rpType, modifier)
	This macro declares a default modifier for `IlsBoolean` type. More...

#define	ILS_RP_DEFAULT_CHAR(rpType, modifier)
	This macro declares a default modifier for `char` type. More...

#define	ILS_RP_DEFAULT_DOUBLE(rpType, modifier)
	This macro declares a default modifier for `double` type. More...

#define	ILS_RP_DEFAULT_FILE(rpType, modifier)
	This macro declares a default modifier for `IlsBoolean` type. More...

#define	ILS_RP_DEFAULT_FLOAT(rpType, modifier)
	This macro declares a default modifier for `float` type. More...

#define	ILS_RP_DEFAULT_HREF(rpType, modifier)
	This macro declares a default modifier for hyper-reference type. More...

#define	ILS_RP_DEFAULT_INT(rpType, modifier)
	This macro declares a default modifier for `long` type. More...

#define	ILS_RP_DEFAULT_LONG(rpType, modifier)
	This macro declares a default modifier for `long` type. More...

#define	ILS_RP_DEFAULT_MVVALUE(rpType, modifier)
	This macro declares a default modifier for `IlsMvValue` type. More...

#define	ILS_RP_DEFAULT_REF(rpType, modifier, attrType)
	This macro declares a default modifier for reference type. More...

#define	ILS_RP_DEFAULT_STRING(rpType, modifier)
	This macro declares a default modifier for `IlsString` type. More...

#define	ILS_RP_DEFAULT_USERTYPE(rpType, userType, modifier)
	This macro declares a default modifier for user type. More...

#define	ILS_RP_DEFAULT_XXX()
	The macros `ILS_RP_DEFAULT_XXX()` let you associate a default editing function with runtime representation attributes. More...

#define	ILS_RP_GLOBAL_FUNCTION()
	These macros declare global functions of the component as being usable in callbacks invoked from a dynamic view server (see class `IlsMvEndPoint`). More...

#define	ILS_RP_GLOBAL_FUNCTION0(resType, funNm)
	This macro declares a global function with zero parameter to the representation model interpreter. More...

#define	ILS_RP_GLOBAL_FUNCTION1(resType, funNm, p1Type)
	This macro declares a global function with one parameter to the representation model interpreter. More...

#define	ILS_RP_GLOBAL_FUNCTION2(resType, funNm, p1Type, p2Type)
	This macro declares a global function with two parameters to the representation model interpreter. More...

#define	ILS_RP_GLOBAL_FUNCTION3(resType, funNm, p1Type, p2Type, p3Type)
	This macro declares a global function with three parameters to the representation model interpreter. More...

#define	ILS_RP_GLOBAL_FUNCTION4(resType, funNm, p1Type, p2Type, p3Type, p4Type)
	This macro declares a global function with four parameters to the representation model interpreter. More...

#define	ILS_RP_GLOBAL_FUNCTION5(resType, funNm, p1Type, p2Type, p3Type, p4Type, p5Type)
	This macro declares a global function with five parameters to the representation model interpreter. More...

#define	ILS_RP_GLOBAL_FUNCTION6(resType, funNm, p1Type, p2Type, p3Type, p4Type, p5Type, p6Type)
	This macro declares a global function with six parameters to the representation model interpreter. More...

#define	ILS_RP_GLOBAL_FUNCTION7(resType, funNm, p1Type, p2Type, p3Type, p4Type, p5Type, p6Type, p7Type)
	This macro declares a global function with seven parameters to the representation model interpreter. More...

#define	ILS_RP_INDEXED_ATTR_BOOLEAN(rpType, attrLabel, modifier)
	This macro declares an indexed attribute of type `IlsBoolean` to the representation model interpreter. More...

#define	ILS_RP_INDEXED_ATTR_CHAR(rpType, attrLabel, modifier)
	This macro declares an indexed attribute of type `IlsBoolean` to the representation model interpreter. More...

#define	ILS_RP_INDEXED_ATTR_DOUBLE(rpType, attrLabel, modifier)
	This macro declares an indexed attribute of type `double` to the representation model interpreter. More...

#define	ILS_RP_INDEXED_ATTR_FILE(rpType, attrLabel, modifier)
	This macro declares an indexed attribute of type `IlsMvFile` to the representation model interpreter. More...

#define	ILS_RP_INDEXED_ATTR_FLOAT(rpType, attrLabel, modifier)
	This macro declares an indexed attribute of type `float` to the representation model interpreter. More...

#define	ILS_RP_INDEXED_ATTR_HREF(rpType, attrLabel, modifier)
	This macro declares an indexed attribute of type `HREF` to the representation model interpreter. More...

#define	ILS_RP_INDEXED_ATTR_INT(rpType, attrLabel, modifier)
	This macro declares an indexed attribute of type `long` to the representation model interpreter. More...

#define	ILS_RP_INDEXED_ATTR_LONG(rpType, attrLabel, modifier)
	This macro declares an indexed attribute of type `long` to the representation model interpreter. More...

#define	ILS_RP_INDEXED_ATTR_MVVALUE(rpType, attrLabel, modifier)
	This macro declares an indexed attribute of type `IlsMvValue` to the representation model interpreter. More...

#define	ILS_RP_INDEXED_ATTR_REF(rpType, attrLabel, modifier, attrType)
	This macro declares an indexed attribute of type `REF` to the representation model interpreter. More...

#define	ILS_RP_INDEXED_ATTR_STRING(rpType, attrLabel, modifier)
	This macro declares an indexed attribute of type `IlsString` to the representation model interpreter. More...

#define	ILS_RP_INDEXED_ATTR_USERTYPE(rpType, userType, attrLabel, modifier)
	This macro declares an indexed attribute of type `userType` that derives from `IlsMvUserTpe` to the representation model interpreter. More...

#define	ILS_RP_INDEXED_ATTR_XXX()
	The macros `ILS_RP_INDEXED_ATTR_XXX()` let you associate editing functions with indexed runtime representation attributes. More...

#define	ILS_RP_INDEXED_DEFAULT_BOOLEAN(rpType, modifier)
	This macros declare a default attribute modifier of type `IlsBoolean`. More...

#define	ILS_RP_INDEXED_DEFAULT_CHAR(rpType, modifier)
	This macros declare a default attribute modifier of type `char`. More...

#define	ILS_RP_INDEXED_DEFAULT_DOUBLE(rpType, modifier)
	This macros declare a default attribute modifier of type `double`. More...

#define	ILS_RP_INDEXED_DEFAULT_FILE(rpType, modifier)
	This macros declare a default attribute modifier of type `IlsMvFile`. More...

#define	ILS_RP_INDEXED_DEFAULT_FLOAT(rpType, modifier)
	This macros declare a default attribute modifier of type `float`. More...

#define	ILS_RP_INDEXED_DEFAULT_HREF(rpType, modifier)
	This macros declare a default attribute modifier of type `HREF`. More...

#define	ILS_RP_INDEXED_DEFAULT_INT(rpType, modifier)
	This macros declare a default attribute modifier of type `long`. More...

#define	ILS_RP_INDEXED_DEFAULT_LONG(rpType, modifier)
	This macros declare a default attribute modifier of type `long`. More...

#define	ILS_RP_INDEXED_DEFAULT_MVVALUE(rpType, modifier)
	This macros declare a default attribute modifier of type `IlsMvValue`. More...

#define	ILS_RP_INDEXED_DEFAULT_REF(rpType, modifier, attrType)
	This macros declare a default attribute modifier of type `REF`. More...

#define	ILS_RP_INDEXED_DEFAULT_STRING(rpType, modifier)
	This macros declare a default attribute modifier of type `IlsString`. More...

#define	ILS_RP_INDEXED_DEFAULT_USERTYPE(rpType, userType, modifier)
	This macros declare a default attribute modifier of type `userType which` derives from `IlsMvUserType`. More...

#define	ILS_RP_INDEXED_DEFAULT_XXX()
	The macros `ILS_RP_INDEXED_DEFAULT_XXX()` let you associate a default editing function with indexed runtime representation attributes. More...

#define	ILS_RP_MEMBER_FUNCTION()
	These macros declare member functions of representation object classes as being usable in callbacks that are invoked from a dynamic view server. More...

#define	ILS_RP_MEMBER_FUNCTION0(resType, objType, funNm)
	This macros declares a member function `objType::funNm()` with no parameter. More...

#define	ILS_RP_MEMBER_FUNCTION1(resType, objType, funNm, p1Type)
	This macros declares a member function `objType::funNm()` with one parameter. More...

#define	ILS_RP_MEMBER_FUNCTION2(resType, objType, funNm, p1Type, p2Type)
	This macros declares a member function `objType::funNm()` with two parameters. More...

#define	ILS_RP_MEMBER_FUNCTION3(resType, objType, funNm, p1Type, p2Type, p3Type)
	This macros declares a member function `objType::funNm()` with three parameters. More...

#define	ILS_RP_MEMBER_FUNCTION4(resType, objType, funNm, p1Type, p2Type, p3Type, p4Type)
	This macros declares a member function `objType::funNm()` with four parameters. More...

#define	ILS_RP_MEMBER_FUNCTION5(resType, objType, funNm, p1Type, p2Type, p3Type, p4Type, p5Type)
	This macros declares a member function `objType::funNm()` with five parameters. More...

#define	ILS_RP_MEMBER_FUNCTION6(resType, objType, funNm, p1Type, p2Type, p3Type, p4Type, p5Type, p6Type)
	This macros declares a member function `objType::funNm()` with six parameters. More...

#define	ILS_RP_MEMBER_FUNCTION7(resType, objType, funNm, p1Type, p2Type, p3Type, p4Type, p5Type, p6Type, p7Type)
	This macros declares a member function `objType::funNm()` with seven parameters. More...

#define	ILS_RP_OBJECT1_BEGIN(typeNm, parent1)
	This macros declare representation object with one parent class. See `ILS_RP_OBJECT_BEGIN()`. More...

#define	ILS_RP_OBJECT2_BEGIN(typeNm, parent1, parent2)
	This macros declare representation object with two parent classes. See `ILS_RP_OBJECT_BEGIN()`. More...

#define	ILS_RP_OBJECT3_BEGIN(typeNm, parent1, parent2, parent3)
	This macros declare representation object with three parent classes. See `ILS_RP_OBJECT_BEGIN()`. More...

#define	ILS_RP_OBJECT_BEGIN(typeNm)
	This macros and `ILS_OBJECT_END()` allow you to declare classes that derive from `IlsRpObject` to the representation model interpreter, which is implemented in the Rogue Wave Server library. More...

#define	ILS_RP_OBJECT_DECL(typeNm)
	This macro is used with classes that derive from `IlsRpObject` together with the pair of macros `ILS_RP_OBJECT_BEGIN()`/`ILS_RP_OBJECT_END()`. More...

#define	ILS_RP_OBJECT_END(typeNm)
	This macros and `ILS_OBJECT_BEGIN()` allow you to declare classes that derive from `IlsRpObject` to the representation model interpreter, which is implemented in the Rogue Wave Server library. More...

#define	ILS_RP_OBJECT_INIT(typeNm)

Typedefs
typedef unsigned short	IlsC2STransStatus
	An `IlsC2STransStatus` object can be assigned one of the `IlsC2STransStatusEnum` values or a boolean ORing expression on these values. More...

typedef short	IlsCbArgNb
	This type is used in callback execution functions, such as those that belong to the classes `IlsMvEndPoint`, `IlsRpObject`, `IlsMvComponent`) to define the size of the parameter arrays, and of the size of indexes in these arrays. More...

Enumerations
enum	IlsC2STransStatusEnum { ILS_C2S_ALL, ILS_C2S_DEFAULT, ILS_C2S_NO_ROLLBACK, ILS_C2S_NO_ACKNOWLEDGE, ILS_C2S_NO_NOTIFY, ILS_C2S_SV_ROLLBACK }
	This type definition specifies the kind of component transactions that are executed within a server. More...

enum	IlsS2CTransStatus { , ILS_S2C_ACKNOWLEDGE, ILS_S2C_SV_ROLLBACK, ILS_S2C_CP_ROLLBACK, ILS_S2C_NOTIFY , ILS_S2C_NOTIFY_CREATION }
	This enumerated type defines the kind of incoming server transactions that are executed within a component. More...

enum	IlsEditRights::Value { IlsEditRights::NO_EDIT, IlsEditRights::HREF_LABEL, IlsEditRights::HREF_TARGET, IlsEditRights::HREF_SELECT, IlsEditRights::DEFAULT_EDIT }
	This enumerated type defines the editing rights on representation object attributes. More...

Macro Definition Documentation

◆ ILS_REPRESENTATION1_BEGIN

#define ILS_REPRESENTATION1_BEGIN	(	typeNm,
		parent1
	)

macro to declare to the representation model interpreter a subclass of IlsRepresentation that derives from another subclass of IlsRepresentation. See ILS_REPRESENTATION_BEGIN().

Parameters

typeNm	name of the class to be declared.
parent1	parent class of `typeNm`.

See also: IlsRepresentation, ILS_REPRESENTATION_BEGIN(), ILS_REPRESENTATION_END(), ILS_REPRESENTATION_DECL().

◆ ILS_REPRESENTATION_BEGIN

#define ILS_REPRESENTATION_BEGIN ( typeNm )

This macro allows you to declare these classes to the representation model interpreter, which is implemented in the Rogue Wave Server library (see IlsRpModel).

This macro is used with the macros ILS_REPRESENTATION_END() and ILS_REPRESENTATION_DECL() for classes that derive from IlsRepresentation. Using this declaration, the representation model interpreter can create representations whose C++ type corresponds to the dynamic representation model associated with the dynamic view type instantiated.

Both these macros must be added to the source file defining the member functions related to the representation class. Only macros related to representation attributes, such as ILS_RP_ATTR_BOOLEAN(), ILS_RP_ATTR_CHAR(), can be enclosed between these macros. The associated representation class must contain a constructor with the following signature:

typeNm::typeNm(IlsMvComponent&, IlsRpModel&);

This constructor will be called by Rogue Wave Server to instantiate representations whose type is referenced in dynamic view type specifications and consequently in the associated dynamic representation model.

Synopsis

Note: Use the macro ILS_REPRESENTATION1_BEGIN() if the representation type derives from another type.

See also: IlsRepresentation, ILS_REPRESENTATION_DECL(), ILS_REPRESENTATION_INIT(), ILS_RP_ATTR_XXX(), IlsRpModel, IlsRpObject, IlsRpObjModel.

◆ ILS_REPRESENTATION_DECL

#define ILS_REPRESENTATION_DECL ( typeNm )

This macro allows you to declare classes that derive from IlsRepresentation to the representation model interpreter, which is implemented in the Rogue Wave Server library.

This macro is used together with the pair of macros ILS_REPRESENTATION_BEGIN()/ILS_REPRESENTATION_END(). Using this declaration, the representation model interpreter can create representations whose C++ type corresponds to the dynamic representation model appearing in the dynamic view type specification.

In the following view specification, for example, the class IlsSwRepresentation, which derives from IlsRepresentation, should be declared to the representation model interpreter so that when the representation associated with the view NetworkPanel is created, the interpreter instantiates an object of type IlsSwRepresentation in the application component.

view NetworkPanel:
       represent IlsSwRepresentation repres:...;
...

The macro ILS_REPRESENTATION_DECL() must be added to the declaration of all the classes deriving from IlsRepresentation, as shown below:

class IlsSwRepresentation: public IlsRepresentation
{
   ...
   ILS_REPRESENTATION_DECL(IlsSwRepresentation)
}

It defines the following function:

static IlsSwRepresentation* Narrow(IlsRepresentation&);

When this function takes a reference to a representation as its parameter, it returns a pointer to IlsSwRepresentation if the object is of type IlsSwRepresentation or of a derived type. Otherwise, it returns a null pointer.

See also: IlsRepresentation, ILS_REPRESENTATION_BEGIN()/ILS_REPRESENTATION_END(), ILS_REPRESENTATION_INIT(), IlsRpModel, IlsRpObject, IlsRpObjModel.

◆ ILS_REPRESENTATION_END

#define ILS_REPRESENTATION_END ( typeNm )

macro used for declaring an IlsRepresentation subclass to the representation model interpreter. See ILS_REPRESENTATION_BEGIN().

Parameters

typeNm name of the class to be declared.

See also: IlsRepresentation, ILS_REPRESENTATION_BEGIN(), ILS_REPRESENTATION_DECL().

◆ ILS_REPRESENTATION_INIT

#define ILS_REPRESENTATION_INIT ( typeNm )

A subtype of the class IlsRepresentation is automatically declared to the runtime representation model interpreter by a static initialization of a variable included in the macro ILS_REPRESENTATION_BEGIN(). If this variable is embedded in a library, its initialization may be postponed depending on the platform. To work around this potential problem, the ILS_REPRESENTATION_INIT() macro is supplied to force the runtime declaration of a IlsRepresentation-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_REPRESENTATION_BEGIN()/ILS_REPRESENTATION_END(), ILS_RP_OBJECT_INIT().

◆ ILS_RP_ATTR_BOOLEAN

#define ILS_RP_ATTR_BOOLEAN	(	rpType,
		attrLabel,
		modifier
	)

This macro associates the member function rpType::modifier() with the Boolean runtime attribute attrLabel.

The signature of the editing function should be the following:

void rpType::modifier(IlsBoolean);

This function can have other parameters provided they have a default value.

The type of the first parameter can be changed provided the type IlsBoolean can be implicitly converted to that new type.

See also: ILS_RP_ATTR_XXX().

◆ ILS_RP_ATTR_CHAR

#define ILS_RP_ATTR_CHAR	(	rpType,
		attrLabel,
		modifier
	)

This macro associates the member function rpType::modifier() with the runtime attribute attrLabel of type char.

The signature of the editing function should be the following:

void rpType::modifier(char);

This function can have other parameters provided they have a default value.

The type of the first parameter can be changed provided the type char can be implicitly converted to that new type.

See also: ILS_RP_ATTR_XXX().

◆ ILS_RP_ATTR_DOUBLE

#define ILS_RP_ATTR_DOUBLE	(	rpType,
		attrLabel,
		modifier
	)

This macro associates the member function rpType::modifier() with the runtime attribute attrLabel of type double.

The signature of the editing function should be the following:

void rpType::modifier(double)

This function can have other parameters provided they have a default value.

The type of the first parameter can be changed provided the type double can be implicitly converted to that new type.

See also: ILS_RP_ATTR_XXX().

◆ ILS_RP_ATTR_FILE

#define ILS_RP_ATTR_FILE	(	rpType,
		attrLabel,
		modifier
	)

This macro associates the member function rpType::modifier() with the runtime attribute attrLabel of type IlsMvFile.

The signature of the editing function should be the following:

void rpType::modifier(IlsMvFile);

This function can have other parameters provided they have a default value.

The type of the first parameter can be changed provided the type IlsMvFile can be implicitly converted to that new types.

See also: ILS_RP_ATTR_XXX().

◆ ILS_RP_ATTR_FLOAT

#define ILS_RP_ATTR_FLOAT	(	rpType,
		attrLabel,
		modifier
	)

This macro associates the member function rpType::modifier() with the runtime attribute attrLabel of type float.

The signature of the editing function should be the following:

void rpType::modifier(float);

This function can have other parameters provided they have a default value.

The type of the first parameter can be changed provided the type float can be implicitly converted to that new type.

See also: ILS_RP_ATTR_XXX().

◆ ILS_RP_ATTR_HREF

#define ILS_RP_ATTR_HREF	(	rpType,
		attrLabel,
		modifier
	)

This macro associates the member function rpType::modifier() with the runtime attribute attrLabel, which is a hyper-reference. At the representation level, a hyper-reference is defined by its label, which is of type IlsString.

The signature of the editing function should be the following:

void rpType::modifier(IlsString);

This function can have other parameters provided they have a default value.

The type of the first parameter can be changed provided the type IlsString can be implicitly converted to that new type (char*, for example).

See also: ILS_RP_ATTR_XXX().

◆ ILS_RP_ATTR_INT

#define ILS_RP_ATTR_INT	(	rpType,
		attrLabel,
		modifier
	)

This macro associates the member function rpType::modifier() with the runtime attribute attrLabel of type long.

The signature of the editing function should be the following:

void rpType::modifier(long);

This function can have other parameters provided they have a default value.

The type of the first parameter can be changed provided the type int can be implicitly converted to that new type.

See also: ILS_RP_ATTR_XXX().

◆ ILS_RP_ATTR_LONG

#define ILS_RP_ATTR_LONG	(	rpType,
		attrLabel,
		modifier
	)

This macro associates the member function rpType::modifier() with the runtime attribute attrLabel of type long.

The signature of the editing function should be the following:

void rpType::modifier(long);

This function can have other parameters provided they have a default value.

The type of the first parameter can be changed provided the type int can be implicitly converted to that new type.

See also: ILS_RP_ATTR_XXX().

◆ ILS_RP_ATTR_MVVALUE

#define ILS_RP_ATTR_MVVALUE	(	rpType,
		attrLabel,
		modifier
	)

This macro associates the member function rpType::modifier() with the runtime attribute attrLabel of type IlsMvValue.

The signature of the editing function should be the following:

void rpType::modifier(IlsMvValue);

This function can have other parameters provided they have a default value.

The type of the first parameter can be changed provided the type IlsMvValue can be implicitly converted to that new types.

See also: ILS_RP_ATTR_XXX().

◆ ILS_RP_ATTR_REF

#define ILS_RP_ATTR_REF	(	rpType,
		attrLabel,
		modifier,
		attrType
	)

This macro associates the member function rpType::modifier() with the runtime attribute attrLabel, which is a reference to a representation object of type refType.

The editing function takes a pointer to the target object as its argument. Its signature should be the following:

void rpType::modifier(refType*);

This function can have other parameters provided they have a default value.

The type of the first parameter can be changed provided the type refType* can be implicitly converted to that new type.

See also: ILS_RP_ATTR_XXX().

◆ ILS_RP_ATTR_STRING

#define ILS_RP_ATTR_STRING	(	rpType,
		attrLabel,
		modifier
	)

This macro associates the member function rpType::modifier() with the runtime attribute attrLabel of type string.

The signature of the editing function should be the following:

void rpType::modifier(IlsString);

This function can have other parameters provided they have a default value.

The type of the first parameter can be changed if the type IlsString can be implicitly converted to that new type (char*, for example).

See also: ILS_RP_ATTR_XXX().

◆ ILS_RP_ATTR_USERTYPE

#define ILS_RP_ATTR_USERTYPE	(	rpType,
		userType,
		attrLabel,
		modifier
	)

This macro associates the member function rpType::modifier() with the runtime attribute attrLabel, which is a user-defined type.

The signature of the editing function should be the following:

void rpType::modifier(userType);

This function can have other parameters provided they have a default value.

The type of the first parameter can be changed if the user-defined type can be implicitly converted to that new type.

See also: ILS_RP_ATTR_XXX().

◆ ILS_RP_ATTR_XXX

#define ILS_RP_ATTR_XXX ( )

The macros ILS_RP_ATTR_XXX() let you associate editing functions with representation attributes referenced in dynamic view type specifications.

If a representation attribute is related to a representation object type – IlsRpObject – these macros must be enclosed between the macros ILS_RP_OBJECT_BEGIN()/ILS_RP_OBJECT_END() or their derivatives.
If it is related to a representation – IlsRepresentation) –, they must be bound by the macros ILS_REPRESENTATION_BEGIN()/ILS_REPRESENTATION_END() or their derivatives.

The same representation attribute can be associated with different editing functions for different types of values.

The association between the name of a representation attribute and an editing function is established by the representation model interpreter, which is implemented in the Rogue Wave Server component library. Using this association, Rogue Wave Server will call the appropriate editing function whenever the value of an attribute must be updated.

Note: It is not necessary to have a runtime representation attribute designate a data member declared on the underlying representation (object) type, because Rogue Wave Server only needs to execute its associated editing function.

Let us consider the following view specification:

view  NetworkTree:
...
subscribe Network:
        represent TreeGadget tree:...
             string label=name;

Here is how you associate the function setLabel() with the runtime attribute label:

ILS_RP_OBJECT_BEGIN(TreeGadget)
ILS_RP_ATTR_STRING(TreeGadget, label, setLabel)
ILS_RP_OBJECT_END(TreeGadget)

Assuming that a network object of type Network is represented by a tree object of type TreeGadget, any modifications of the attribute network.name required by the server will execute the function tree.setLabel().

Warning: Rogue Wave 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: IlsRpObject, ILS_RP_OBJECT_BEGIN()/ILS_RP_OBJECT_END(), IlsRepresentation, ILS_REPRESENTATION_BEGIN()/ILS_REPRESENTATION_END(), ILS_RP_DEFAULT_XXX(), ILS_RP_INDEXED_ATTR_XXX(), ILS_RP_INDEXED_DEFAULT_XXX(), IlsMvFile, IlsString.

◆ ILS_RP_DEFAULT_BOOLEAN

#define ILS_RP_DEFAULT_BOOLEAN	(	rpType,
		modifier
	)

This macro declares a default modifier for IlsBoolean type.

Parameters

rpType	class the modifier belongs to.
modifier	name of the modifier function.

See also: ILS_RP_DEFAULT_XXX().

◆ ILS_RP_DEFAULT_CHAR

#define ILS_RP_DEFAULT_CHAR	(	rpType,
		modifier
	)

This macro declares a default modifier for char type.

Parameters

rpType	class the modifier belongs to.
modifier	name of the modifier function.

See also: ILS_RP_DEFAULT_XXX().

◆ ILS_RP_DEFAULT_DOUBLE

#define ILS_RP_DEFAULT_DOUBLE	(	rpType,
		modifier
	)

This macro declares a default modifier for double type.

Parameters

rpType	class the modifier belongs to.
modifier	name of the modifier function.

See also: ILS_RP_DEFAULT_XXX().

◆ ILS_RP_DEFAULT_FILE

#define ILS_RP_DEFAULT_FILE	(	rpType,
		modifier
	)

This macro declares a default modifier for IlsBoolean type.

Parameters

rpType	class the modifier belongs to.
modifier	name of the modifier function.

See also: ILS_RP_DEFAULT_XXX().

◆ ILS_RP_DEFAULT_FLOAT

#define ILS_RP_DEFAULT_FLOAT	(	rpType,
		modifier
	)

This macro declares a default modifier for float type.

Parameters

rpType	class the modifier belongs to.
modifier	name of the modifier function.

See also: ILS_RP_DEFAULT_XXX().

◆ ILS_RP_DEFAULT_HREF

#define ILS_RP_DEFAULT_HREF	(	rpType,
		modifier
	)

This macro declares a default modifier for hyper-reference type.

Parameters

rpType	class the modifier belongs to.
modifier	name of the modifier function.

See also: ILS_RP_DEFAULT_XXX().

◆ ILS_RP_DEFAULT_INT

#define ILS_RP_DEFAULT_INT	(	rpType,
		modifier
	)

This macro declares a default modifier for long type.

Parameters

rpType	class the modifier belongs to.
modifier	name of the modifier function.

See also: ILS_RP_DEFAULT_XXX().

◆ ILS_RP_DEFAULT_LONG

#define ILS_RP_DEFAULT_LONG	(	rpType,
		modifier
	)

This macro declares a default modifier for long type.

Parameters

rpType	class the modifier belongs to.
modifier	name of the modifier function.

See also: ILS_RP_DEFAULT_XXX().

◆ ILS_RP_DEFAULT_MVVALUE

#define ILS_RP_DEFAULT_MVVALUE	(	rpType,
		modifier
	)

This macro declares a default modifier for IlsMvValue type.

Parameters

rpType	class the modifier belongs to.
modifier	name of the modifier function.

See also: ILS_RP_DEFAULT_XXX().

◆ ILS_RP_DEFAULT_REF

#define ILS_RP_DEFAULT_REF	(	rpType,
		modifier,
		attrType
	)

This macro declares a default modifier for reference type.

Parameters

rpType	class the modifier belongs to.
modifier	name of the modifier function.
attrType	referenced object type

See also: ILS_RP_DEFAULT_XXX().

◆ ILS_RP_DEFAULT_STRING

#define ILS_RP_DEFAULT_STRING	(	rpType,
		modifier
	)

This macro declares a default modifier for IlsString type.

Parameters

rpType	class the modifier belongs to.
modifier	name of the modifier function.

See also: ILS_RP_DEFAULT_XXX().

◆ ILS_RP_DEFAULT_USERTYPE

#define ILS_RP_DEFAULT_USERTYPE	(	rpType,
		userType,
		modifier
	)

This macro declares a default modifier for user type.

Parameters

rpType	class the modifier belongs to.
userType	the user type
modifier	name of the modifier function.

See also: ILS_RP_DEFAULT_XXX().

◆ ILS_RP_DEFAULT_XXX

#define ILS_RP_DEFAULT_XXX ( )

The macros ILS_RP_DEFAULT_XXX() let you associate a default editing function with runtime representation attributes.

These editing functions are called when a runtime representation attribute is updated and has not declared any editing function for its value type (see the macros ILS_RP_ATTR_XXX() for details). These macros have the same semantics and are used in the same way as the ILS_RP_ATTR_XXX() macros, except that:

These macros do not take any attrLabel argument.
The associated editing function takes a string that is the label of the attribute as its first argument.

For instance, the editing function has the following signature, or a derivative, for attributes of type long:

void rpType::modifier(IlsString attrLabel,long value);

Synopsis

Warning: Rogue Wave 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. As a consequence, the macros ILS_RP_DEFAULT_INT() and ILS_RP_DEFAULT_LONG() are mutually exclusive.

See also: IlsRepresentation, IlsRpObject, ILS_RP_ATTR_XXX(), ILS_RP_INDEXED_DEFAULT_XXX(), IlsString, IlsMvFile.

◆ ILS_RP_GLOBAL_FUNCTION

#define ILS_RP_GLOBAL_FUNCTION ( )

These macros declare global functions of the component as being usable in callbacks invoked from a dynamic view server (see class IlsMvEndPoint).

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

ILS_OBJECT_BEGIN() / ILS_OBJECT_END()
ILS_REPRESENTATION_BEGIN() / ILS_REPRESENTATION_END()

or their derivatives.

Synopsis

Arguments

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 parameters of a global function can be of the following types:

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

Such functions cannot have a result of type void.

See also: IlsMvEndPoint, ILS_OBJECT_BEGIN/ILS_OBJECT_END, ILS_REPRESENTATION_BEGIN/ILS_REPRESENTATION_END

◆ ILS_RP_GLOBAL_FUNCTION0

#define ILS_RP_GLOBAL_FUNCTION0	(	resType,
		funNm
	)

This macro declares a global function with zero parameter to the representation model interpreter.

Parameters

resType	return value type.
funNm	function name.

See also: ILS_RP_GLOBAL_FUNCTION().

◆ ILS_RP_GLOBAL_FUNCTION1

#define ILS_RP_GLOBAL_FUNCTION1	(	resType,
		funNm,
		p1Type
	)

This macro declares a global function with one parameter to the representation model interpreter.

Parameters

resType	return value type.
funNm	function name.
p1Type	type of first parameter.

See also: ILS_RP_GLOBAL_FUNCTION().

◆ ILS_RP_GLOBAL_FUNCTION2

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

This macro declares a global function with two parameters to the representation model interpreter.

Parameters

resType	return value type.
funNm	function name.
p1Type	type of first parameter.
p2Type	type of second parameter.

See also: ILS_RP_GLOBAL_FUNCTION().

◆ ILS_RP_GLOBAL_FUNCTION3

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

This macro declares a global function with three parameters to the representation model interpreter.

Parameters

resType	return value type.
funNm	function name.
p1Type	type of first parameter.
p2Type	type of second parameter.
p3Type	type of third parameter.

See also: ILS_RP_GLOBAL_FUNCTION().

◆ ILS_RP_GLOBAL_FUNCTION4

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

This macro declares a global function with four parameters to the representation model interpreter.

Parameters

resType	return value type.
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_RP_GLOBAL_FUNCTION().

◆ ILS_RP_GLOBAL_FUNCTION5

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

This macro declares a global function with five parameters to the representation model interpreter.

Parameters

resType	return value type.
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_RP_GLOBAL_FUNCTION().

◆ ILS_RP_GLOBAL_FUNCTION6

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

This macro declares a global function with six parameters to the representation model interpreter.

Parameters

resType	return value type.
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_RP_GLOBAL_FUNCTION().

◆ ILS_RP_GLOBAL_FUNCTION7

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

This macro declares a global function with seven parameters to the representation model interpreter.

Parameters

resType	return value type.
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_RP_GLOBAL_FUNCTION().

◆ ILS_RP_INDEXED_ATTR_BOOLEAN

#define ILS_RP_INDEXED_ATTR_BOOLEAN	(	rpType,
		attrLabel,
		modifier
	)

This macro declares an indexed attribute of type IlsBoolean to the representation model interpreter.

Parameters

rpType	the class the attribute belongs to.
attrLabel	the name of the attribute.
modifier	the modifier function for the attribute. Its signature must be: void rpType::modifier(int index,IlsBoolean value);

See also: ILS_RP_INDEXED_ATTR_XXX().

◆ ILS_RP_INDEXED_ATTR_CHAR

#define ILS_RP_INDEXED_ATTR_CHAR	(	rpType,
		attrLabel,
		modifier
	)

This macro declares an indexed attribute of type IlsBoolean to the representation model interpreter.

Parameters

rpType	the class the attribute belongs to.
attrLabel	the name of the attribute.
modifier	the modifier function for the attribute. Its signature must be: void rpType::modifier(int index,IlsBoolean value);

See also: ILS_RP_INDEXED_ATTR_XXX().

◆ ILS_RP_INDEXED_ATTR_DOUBLE

#define ILS_RP_INDEXED_ATTR_DOUBLE	(	rpType,
		attrLabel,
		modifier
	)

This macro declares an indexed attribute of type double to the representation model interpreter.

Parameters

rpType	the class the attribute belongs to.
attrLabel	the name of the attribute.
modifier	the modifier function for the attribute. Its signature must be: void rpType::modifier(int index,double value);

See also: ILS_RP_INDEXED_ATTR_XXX().

◆ ILS_RP_INDEXED_ATTR_FILE

#define ILS_RP_INDEXED_ATTR_FILE	(	rpType,
		attrLabel,
		modifier
	)

This macro declares an indexed attribute of type IlsMvFile to the representation model interpreter.

Parameters

rpType	the class the attribute belongs to.
attrLabel	the name of the attribute.
modifier	the modifier function for the attribute. Its signature must be: void rpType::modifier(int index,IlsMvFile value);

See also: ILS_RP_INDEXED_ATTR_XXX().

◆ ILS_RP_INDEXED_ATTR_FLOAT

#define ILS_RP_INDEXED_ATTR_FLOAT	(	rpType,
		attrLabel,
		modifier
	)

This macro declares an indexed attribute of type float to the representation model interpreter.

Parameters

rpType	the class the attribute belongs to.
attrLabel	the name of the attribute.
modifier	the modifier function for the attribute. Its signature must be: void rpType::modifier(int index,float value);

See also: ILS_RP_INDEXED_ATTR_XXX().

◆ ILS_RP_INDEXED_ATTR_HREF

#define ILS_RP_INDEXED_ATTR_HREF	(	rpType,
		attrLabel,
		modifier
	)

This macro declares an indexed attribute of type HREF to the representation model interpreter.

Parameters

rpType	the class the attribute belongs to.
attrLabel	the name of the attribute.
modifier	the modifier function for the attribute. Its signature must be: void rpType::modifier(int index,IlsString value);

See also: ILS_RP_INDEXED_ATTR_XXX().

◆ ILS_RP_INDEXED_ATTR_INT

#define ILS_RP_INDEXED_ATTR_INT	(	rpType,
		attrLabel,
		modifier
	)

This macro declares an indexed attribute of type long to the representation model interpreter.

Parameters

rpType	the class the attribute belongs to.
attrLabel	the name of the attribute.
modifier	the modifier function for the attribute. Its signature must be: void rpType::modifier(int index,long value);

See also: ILS_RP_INDEXED_ATTR_XXX().

◆ ILS_RP_INDEXED_ATTR_LONG

#define ILS_RP_INDEXED_ATTR_LONG	(	rpType,
		attrLabel,
		modifier
	)

This macro declares an indexed attribute of type long to the representation model interpreter.

Parameters

rpType	the class the attribute belongs to.
attrLabel	the name of the attribute.
modifier	the modifier function for the attribute. Its signature must be: void rpType::modifier(int index,long value);

See also: ILS_RP_INDEXED_ATTR_XXX().

◆ ILS_RP_INDEXED_ATTR_MVVALUE

#define ILS_RP_INDEXED_ATTR_MVVALUE	(	rpType,
		attrLabel,
		modifier
	)

This macro declares an indexed attribute of type IlsMvValue to the representation model interpreter.

Parameters

rpType	the class the attribute belongs to.
attrLabel	the name of the attribute.
modifier	the modifier function for the attribute. Its signature must be: void rpType::modifier(int index,IlsMvValue value);

See also: ILS_RP_INDEXED_ATTR_XXX().

◆ ILS_RP_INDEXED_ATTR_REF

#define ILS_RP_INDEXED_ATTR_REF	(	rpType,
		attrLabel,
		modifier,
		attrType
	)

This macro declares an indexed attribute of type REF to the representation model interpreter.

Parameters

rpType	the class the attribute belongs to.
attrLabel	the name of the attribute.
modifier	the modifier function for the attribute. Its signature must be: void rpType::modifier(int index,attrType value);
attrType	type of the referenced object

See also: ILS_RP_INDEXED_ATTR_XXX().

◆ ILS_RP_INDEXED_ATTR_STRING

#define ILS_RP_INDEXED_ATTR_STRING	(	rpType,
		attrLabel,
		modifier
	)

This macro declares an indexed attribute of type IlsString to the representation model interpreter.

Parameters

rpType	the class the attribute belongs to.
attrLabel	the name of the attribute.
modifier	the modifier function for the attribute. Its signature must be: void rpType::modifier(int index,IlsString value);

See also: ILS_RP_INDEXED_ATTR_XXX().

◆ ILS_RP_INDEXED_ATTR_USERTYPE

#define ILS_RP_INDEXED_ATTR_USERTYPE	(	rpType,
		userType,
		attrLabel,
		modifier
	)

This macro declares an indexed attribute of type userType that derives from IlsMvUserTpe to the representation model interpreter.

Parameters

rpType	the class the attribute belongs to.
userType	the user type.
attrLabel	the name of the attribute.
modifier	the modifier function for the attribute. Its signature must be: void rpType::modifier(int index,IlsMvFile value);

See also: ILS_RP_INDEXED_ATTR_XXX().

◆ ILS_RP_INDEXED_ATTR_XXX

#define ILS_RP_INDEXED_ATTR_XXX ( )

The macros ILS_RP_INDEXED_ATTR_XXX() let you associate editing functions with indexed runtime representation attributes.

These macros have the same semantics and are used in the same way as the ILS_RP_ATTR_XXX() macros. However, the signature of their editing functions varies slightly in that it takes the attribute index as the first argument and the attribute value as the second argument.

Warning: Rogue Wave 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.

Let us consider the following view specification:

view DomainNodes:
...
subscribe Node:
        represent Row row
              string column[1]=...;
              int column[2]=...;
              int column[3]=...;
              HyperRef column[4]=...;

Here is how you would associate the editing functions setStringColumn(), setIntColumn(), and setHRefColumn() with the runtime attribute column:

ILS_RP_OBJECT_BEGIN(Row)
ILS_RP_INDEXED_ATTR_STRING(Row,column,setStringColumn)
ILS_RP_INDEXED_ATTR_LONG(Row,column,setLongColumn)
ILS_RP_INDEXED_ATTR_HREF(Row,column,setHRefColumn)
ILS_RP_OBJECT_END(Row)

The signatures of the editing functions must be the following or their derivatives:

void Row::setStringColumn(int index,IlsString value);
void Row::setLongColumn(int index,long value);
void Row::setHRefColumn(int index,IlsString value);

Synopsis

See also: IlsRepresentation, IlsRpObject, ILS_RP_ATTR_XXX(), ILS_RP_DEFAULT_XXX(), ILS_RP_INDEXED_DEFAULT_XXX(), IlsString, IlsMvFile.

◆ ILS_RP_INDEXED_DEFAULT_BOOLEAN

#define ILS_RP_INDEXED_DEFAULT_BOOLEAN	(	rpType,
		modifier
	)

This macros declare a default attribute modifier of type IlsBoolean.

Parameters

rpType	class the attribute belongs to.
modifier	the modifier name.

See also: ILS_RP_INDEXED_DEFAULT_XXX().

◆ ILS_RP_INDEXED_DEFAULT_CHAR

#define ILS_RP_INDEXED_DEFAULT_CHAR	(	rpType,
		modifier
	)

This macros declare a default attribute modifier of type char.

Parameters

rpType	class the attribute belongs to.
modifier	the modifier name.

See also: ILS_RP_INDEXED_DEFAULT_XXX().

◆ ILS_RP_INDEXED_DEFAULT_DOUBLE

#define ILS_RP_INDEXED_DEFAULT_DOUBLE	(	rpType,
		modifier
	)

This macros declare a default attribute modifier of type double.

Parameters

rpType	class the attribute belongs to.
modifier	the modifier name.

See also: ILS_RP_INDEXED_DEFAULT_XXX().

◆ ILS_RP_INDEXED_DEFAULT_FILE

#define ILS_RP_INDEXED_DEFAULT_FILE	(	rpType,
		modifier
	)

This macros declare a default attribute modifier of type IlsMvFile.

Parameters

rpType	class the attribute belongs to.
modifier	the modifier name.

See also: ILS_RP_INDEXED_DEFAULT_XXX().

◆ ILS_RP_INDEXED_DEFAULT_FLOAT

#define ILS_RP_INDEXED_DEFAULT_FLOAT	(	rpType,
		modifier
	)

This macros declare a default attribute modifier of type float.

Parameters

rpType	class the attribute belongs to.
modifier	the modifier name.

See also: ILS_RP_INDEXED_DEFAULT_XXX().

◆ ILS_RP_INDEXED_DEFAULT_HREF

#define ILS_RP_INDEXED_DEFAULT_HREF	(	rpType,
		modifier
	)

This macros declare a default attribute modifier of type HREF.

Parameters

rpType	class the attribute belongs to.
modifier	the modifier name.

See also: ILS_RP_INDEXED_DEFAULT_XXX().

◆ ILS_RP_INDEXED_DEFAULT_INT

#define ILS_RP_INDEXED_DEFAULT_INT	(	rpType,
		modifier
	)

This macros declare a default attribute modifier of type long.

Parameters

rpType	class the attribute belongs to.
modifier	the modifier name.

See also: ILS_RP_INDEXED_DEFAULT_XXX().

◆ ILS_RP_INDEXED_DEFAULT_LONG

#define ILS_RP_INDEXED_DEFAULT_LONG	(	rpType,
		modifier
	)

This macros declare a default attribute modifier of type long.

Parameters

rpType	class the attribute belongs to.
modifier	the modifier name.

See also: ILS_RP_INDEXED_DEFAULT_XXX().

◆ ILS_RP_INDEXED_DEFAULT_MVVALUE

#define ILS_RP_INDEXED_DEFAULT_MVVALUE	(	rpType,
		modifier
	)

This macros declare a default attribute modifier of type IlsMvValue.

Parameters

rpType	class the attribute belongs to.
modifier	the modifier name.

See also: ILS_RP_INDEXED_DEFAULT_XXX().

◆ ILS_RP_INDEXED_DEFAULT_REF

#define ILS_RP_INDEXED_DEFAULT_REF	(	rpType,
		modifier,
		attrType
	)

This macros declare a default attribute modifier of type REF.

Parameters

rpType	class the attribute belongs to.
modifier	the modifier name.
attrType	type of referenced object.

See also: ILS_RP_INDEXED_DEFAULT_XXX().

◆ ILS_RP_INDEXED_DEFAULT_STRING

#define ILS_RP_INDEXED_DEFAULT_STRING	(	rpType,
		modifier
	)

This macros declare a default attribute modifier of type IlsString.

Parameters

rpType	class the attribute belongs to.
modifier	the modifier name.

See also: ILS_RP_INDEXED_DEFAULT_XXX().

◆ ILS_RP_INDEXED_DEFAULT_USERTYPE

#define ILS_RP_INDEXED_DEFAULT_USERTYPE	(	rpType,
		userType,
		modifier
	)

This macros declare a default attribute modifier of type userType which derives from IlsMvUserType.

Parameters

rpType	class the attribute belongs to.
userType	the user type.
modifier	the modifier name.

See also: ILS_RP_INDEXED_DEFAULT_XXX().

◆ ILS_RP_INDEXED_DEFAULT_XXX

#define ILS_RP_INDEXED_DEFAULT_XXX ( )

The macros ILS_RP_INDEXED_DEFAULT_XXX() let you associate a default editing function with indexed runtime representation attributes.

These editing functions are called if a runtime representation attribute is updated and has not declared any editing function for its value type (see the macros ILS_RP_INDEXED_ATTR_XXX() for details). These macros have the same semantics and are used in the same way as the ILS_RP_INDEXED_ATTR_XXX() macros, except that:

They do not take any attrLabel argument.
The associated editing function takes a string that is the label of the attribute as its first argument.

For instance, the editing function has the following signature, or a derivative, for attributes of type long:

void rpType::modifier(IlsString attrLabel,int index,long value);

Warning: Rogue Wave 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: IlsRepresentation, ILS_RP_ATTR_XXX(), ILS_RP_DEFAULT_XXX(), ILS_RP_INDEXED_ATTR_XXX(), IlsRpObject, IlsString, IlsMvFile.

◆ ILS_RP_MEMBER_FUNCTION

#define ILS_RP_MEMBER_FUNCTION ( )

These macros declare member functions of representation object classes as being usable in callbacks that are invoked from a dynamic view server.

See classes IlsRpObject and IlsMvEndPoint.

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

ILS_OBJECT_BEGIN() / ILS_OBJECT_END()
ILS_REPRESENTATION_BEGIN() / ILS_REPRESENTATION_END()

or their derivatives.

Synopsis

Arguments

These macros take the following arguments in this order:

The type of the value returned by the function
The type of the representation object to which the member function belongs
The function name
The types of the function parameters

All the functions declared with these macros for a same class must have a unique name. The result and parameters of a member function can be of the following types:

char
char*
IlsString
IlsBoolean
short
int
long
float
double
Any type derived from IlsMvUserType.

Such functions cannot have a result of type void.

See also: IlsMvEndPoint, ILS_OBJECT_BEGIN()/ILS_OBJECT_END(), ILS_REPRESENTATION_BEGIN()/ILS_REPRESENTATION_END(), IlsRpObject.

◆ ILS_RP_MEMBER_FUNCTION0

#define ILS_RP_MEMBER_FUNCTION0	(	resType,
		objType,
		funNm
	)

This macros declares a member function objType::funNm() with no parameter.

Parameters

resType	type of returned value.
objType	class the member function belongs to.
funNm	member function name.

See also: ILS_RP_MEMBER_FUNCTION().

◆ ILS_RP_MEMBER_FUNCTION1

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

This macros declares a member function objType::funNm() with one parameter.

Parameters

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

See also: ILS_RP_MEMBER_FUNCTION().

◆ ILS_RP_MEMBER_FUNCTION2

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

This macros declares a member function objType::funNm() with two parameters.

Parameters

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

See also: ILS_RP_MEMBER_FUNCTION().

◆ ILS_RP_MEMBER_FUNCTION3

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

This macros declares a member function objType::funNm() with three parameters.

Parameters

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

See also: ILS_RP_MEMBER_FUNCTION().

◆ ILS_RP_MEMBER_FUNCTION4

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

This macros declares a member function objType::funNm() with four parameters.

Parameters

resType	type of returned value.
objType	class the member function belongs to.
funNm	member 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_RP_MEMBER_FUNCTION().

◆ ILS_RP_MEMBER_FUNCTION5

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

This macros declares a member function objType::funNm() with five parameters.

Parameters

resType	type of returned value.
objType	class the member function belongs to.
funNm	member 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_RP_MEMBER_FUNCTION().

◆ ILS_RP_MEMBER_FUNCTION6

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

This macros declares a member function objType::funNm() with six parameters.

Parameters

resType	type of returned value.
objType	class the member function belongs to.
funNm	member 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_RP_MEMBER_FUNCTION().

◆ ILS_RP_MEMBER_FUNCTION7

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

This macros declares a member function objType::funNm() with seven parameters.

Parameters

resType	type of returned value.
objType	class the member function belongs to.
funNm	member 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_RP_MEMBER_FUNCTION().

◆ ILS_RP_OBJECT1_BEGIN

#define ILS_RP_OBJECT1_BEGIN	(	typeNm,
		parent1
	)

This macros declare representation object with one parent class. See ILS_RP_OBJECT_BEGIN().

Parameters

typeNm	class name.
parent1	parent class.

See also: ILS_RP_OBJECT_BEGIN().

◆ ILS_RP_OBJECT2_BEGIN

#define ILS_RP_OBJECT2_BEGIN	(	typeNm,
		parent1,
		parent2
	)

This macros declare representation object with two parent classes. See ILS_RP_OBJECT_BEGIN().

Parameters

typeNm	class name.
parent1	first parent class.
parent2	second parent class.

See also: ILS_RP_OBJECT_BEGIN().

◆ ILS_RP_OBJECT3_BEGIN

#define ILS_RP_OBJECT3_BEGIN	(	typeNm,
		parent1,
		parent2,
		parent3
	)

This macros declare representation object with three parent classes. See ILS_RP_OBJECT_BEGIN().

Parameters

typeNm	class name.
parent1	first parent class.
parent2	second parent class.
parent3	third parent class.

See also: ILS_RP_OBJECT_BEGIN().

◆ ILS_RP_OBJECT_BEGIN

#define ILS_RP_OBJECT_BEGIN ( typeNm )

This macros and ILS_OBJECT_END() allow you to declare classes that derive from IlsRpObject to the representation model interpreter, which is implemented in the Rogue Wave Server library.

They are used together with the macro ILS_RP_OBJECT_DECL(). Using this declaration, the representation model interpreter can create representation objects whose C++ type corresponds to the dynamic representation model described in a dynamic view type specification.

Synopsis

The pair of macros ILS_RP_OBJECT_BEGIN()/ILS_RP_OBJECT_END() must be added to the source file defining the member functions related to classes of representation objects. Only macros related to representation attributes, such as ILS_RP_ATTR_BOOLEAN(), ILS_RP_ATTR_CHAR(), can be enclosed between these macros. The associated class of representation must contain a constructor with the following signature:

rpObjectType::rpObjectType(IlsRepresentation&,IlsRpObjModel&);

The first parameter specifies the representation into which the representation object will be inserted, while the second parameter indicates the associated representation object model. This constructor will be called by Rogue Wave Server to instantiate representation objects whose associated dynamic representation model references rpObjectType.

If rpObjectType directly derives from one, two, or three other representation classes, you must use the appropriate BEGIN macro (for example, ILS_RP_OBJECT1_BEGIN() if rpObjectType directly derives from another representation object class). The representation attributes declared for a parent type are inherited by the derived type.

See also: IlsRepresentation, IlsRpObject, ILS_RP_OBJECT_DECL(), ILS_RP_OBJECT_END(), ILS_RP_OBJECT_INIT(), IlsRpObjModel.

◆ ILS_RP_OBJECT_DECL

#define ILS_RP_OBJECT_DECL ( typeNm )

This macro is used with classes that derive from IlsRpObject together with the pair of macros ILS_RP_OBJECT_BEGIN()/ILS_RP_OBJECT_END().

It allows you to declare these classes to the representation model interpreter, which is implemented in the Rogue Wave Server libraries. Using this declaration, the representation model interpreter can create representation objects whose C++ type corresponds to the object representation types described in a view specification.

In the following dynamic view type specification, for example, the class of representation objects TreeGadget should be declared to the representation model interpreter so that when a panel representation is created in the view NetworkTree, the interpreter will instantiate an object of type TreeGadget in the application component.

view NetworkTree: ... subscribe Network: represent TreeGadget panel:...

Synopsis

ILS_RP_OBJECT_DECL(rpObjectType)
class TreeGadget: public IlsRpObject
{
   ...
   ILS_RP_OBJECT_DECL(TreeGadget)
}

See also: IlsRpModel, IlsRpObject, ILS_RP_OBJECT_BEGIN/ILS_RP_OBJECT_END, ILS_RP_OBJECT_INIT, IlsRpObjModel

◆ ILS_RP_OBJECT_END

#define ILS_RP_OBJECT_END ( typeNm )

This macros and ILS_OBJECT_BEGIN() allow you to declare classes that derive from IlsRpObject to the representation model interpreter, which is implemented in the Rogue Wave Server library.

See ILS_OBJECT_BEGIN().

◆ ILS_RP_OBJECT_INIT

#define ILS_RP_OBJECT_INIT ( typeNm )

The declaration of a IlsRpObject derived class to the representation model interpreter is automatically performed by a static initialization of a variable included in the macro ILS_RP_OBJECT_BEGIN(). If this variable is embedded in a library, its initialization may be postponed depending on the platform. To work around this potential problem, the ILS_RP_OBJECT_INIT() macro is supplied to force the runtime declaration of a IlsRpObject 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_REPRESENTATION_INIT(), IlsRpObject, ILS_RP_OBJECT_BEGIN()/ILS_RP_OBJECT_END().

Typedef Documentation

◆ IlsC2STransStatus

typedef unsigned short IlsC2STransStatus

An IlsC2STransStatus object can be assigned one of the IlsC2STransStatusEnum values or a boolean ORing expression on these values.

See also: IlsC2STransStatusEnum.

◆ IlsCbArgNb

typedef short IlsCbArgNb

This type is used in callback execution functions, such as those that belong to the classes IlsMvEndPoint, IlsRpObject, IlsMvComponent) to define the size of the parameter arrays, and of the size of indexes in these arrays.

Library: server
and mvcomp

See also: IlsMvComponent, IlsMvEndPoint, IlsRpObject.

Enumeration Type Documentation

◆ IlsC2STransStatusEnum

enum IlsC2STransStatusEnum

This type definition specifies the kind of component transactions that are executed within a server.

It is passed as a parameter to the function that is committing a component transaction (see the function IlsMvComponent::commitC2SCTransaction()).

This type definition is received on the server side as a parameter to the functions IlsMvServer::beginTransaction() and IlsMvServer::endTransaction(). An IlsC2STransStatus object can be assigned one of the following values or a Boolean ORing expression on these values.

Library: server
and mvcomp

See also: IlsMvComponent, IlsMvServer, IlsC2STransStatus.

Enumerator
ILS_C2S_ALL	This value selects all the transaction optional features (rollback, acknowledgement, notification).
ILS_C2S_DEFAULT	This value refers to the default component-to-server transaction status assigned via the function `IlsMvComponent::setDefaultC2STransStatus()`.
ILS_C2S_NO_ROLLBACK	This value indicates that the component transaction must be rolled back by the server. It is automatically assigned to a transaction that is rolled back through a call to `IlsMvComponent::rollbackC2STransaction()`. This value should not be assigned directly by the user to the `tStat` parameter passed to the function `IlsMvComponent::commitC2SCTransaction()`. However, it can be used to set the default component-to-server transaction status (that is, the `tStat` parameter of the function `IlsMvComponent::setDefaultC2STransStatus()`).
ILS_C2S_NO_ACKNOWLEDGE	No acknowledgement from the server is requested on the component side when the transaction is completed.
ILS_C2S_NO_NOTIFY	No notification cycle must be performed by the server after the transaction is completed.
ILS_C2S_SV_ROLLBACK	The component transaction must not fail and must not be rolled back even if some of its editing operations fail.

◆ IlsS2CTransStatus

enum IlsS2CTransStatus

This enumerated type defines the kind of incoming server transactions that are executed within a component.

It is passed as a parameter at the beginning and at the end of the transactions that apply to components, representations and representation objects.

Library: server
and mvcomp

See also: IlsMvComponent, IlsRepresentation, IlsRpObject.

Enumerator
ILS_S2C_ACKNOWLEDGE	acknowledgement
ILS_S2C_SV_ROLLBACK	rollback performed by the server
ILS_S2C_CP_ROLLBACK	rollback performed locally to the component
ILS_S2C_NOTIFY	notification
ILS_S2C_NOTIFY_CREATION	notification of creation

◆ Value

enum IlsEditRights::Value

This enumerated type defines the editing rights on representation object attributes.

Library: mvserver
and mvcomp

When the attribute is a hyper reference, the value DEFAULT_EDIT is equivalent to HREF_TARGET.

See also: IlsRpAttrModel, IlsRpObject.

Enumerator
NO_EDIT	not editable
HREF_LABEL	hyper reference attribute with editable label
HREF_TARGET	hyper reference attribute with editable target
HREF_SELECT	selectable (or dereferenceable) hyper reference attribute
DEFAULT_EDIT	editable

Category Description

Classes

Macros

Typedefs

Enumerations

Macro Definition Documentation

◆ ILS_REPRESENTATION1_BEGIN

◆ ILS_REPRESENTATION_BEGIN

◆ ILS_REPRESENTATION_DECL

◆ ILS_REPRESENTATION_END

◆ ILS_REPRESENTATION_INIT

◆ ILS_RP_ATTR_BOOLEAN

◆ ILS_RP_ATTR_CHAR

◆ ILS_RP_ATTR_DOUBLE

◆ ILS_RP_ATTR_FILE

◆ ILS_RP_ATTR_FLOAT

◆ ILS_RP_ATTR_HREF

◆ ILS_RP_ATTR_INT

◆ ILS_RP_ATTR_LONG

◆ ILS_RP_ATTR_MVVALUE

◆ ILS_RP_ATTR_REF

◆ ILS_RP_ATTR_STRING

◆ ILS_RP_ATTR_USERTYPE

◆ ILS_RP_ATTR_XXX

◆ ILS_RP_DEFAULT_BOOLEAN

◆ ILS_RP_DEFAULT_CHAR

◆ ILS_RP_DEFAULT_DOUBLE

◆ ILS_RP_DEFAULT_FILE

◆ ILS_RP_DEFAULT_FLOAT

◆ ILS_RP_DEFAULT_HREF

◆ ILS_RP_DEFAULT_INT

◆ ILS_RP_DEFAULT_LONG

◆ ILS_RP_DEFAULT_MVVALUE

◆ ILS_RP_DEFAULT_REF

◆ ILS_RP_DEFAULT_STRING

◆ ILS_RP_DEFAULT_USERTYPE

◆ ILS_RP_DEFAULT_XXX

◆ ILS_RP_GLOBAL_FUNCTION

◆ ILS_RP_GLOBAL_FUNCTION0

◆ ILS_RP_GLOBAL_FUNCTION1

◆ ILS_RP_GLOBAL_FUNCTION2

◆ ILS_RP_GLOBAL_FUNCTION3

◆ ILS_RP_GLOBAL_FUNCTION4

◆ ILS_RP_GLOBAL_FUNCTION5

◆ ILS_RP_GLOBAL_FUNCTION6

◆ ILS_RP_GLOBAL_FUNCTION7

◆ ILS_RP_INDEXED_ATTR_BOOLEAN

◆ ILS_RP_INDEXED_ATTR_CHAR

◆ ILS_RP_INDEXED_ATTR_DOUBLE

◆ ILS_RP_INDEXED_ATTR_FILE

◆ ILS_RP_INDEXED_ATTR_FLOAT

◆ ILS_RP_INDEXED_ATTR_HREF

◆ ILS_RP_INDEXED_ATTR_INT

◆ ILS_RP_INDEXED_ATTR_LONG

◆ ILS_RP_INDEXED_ATTR_MVVALUE

◆ ILS_RP_INDEXED_ATTR_REF

◆ ILS_RP_INDEXED_ATTR_STRING

◆ ILS_RP_INDEXED_ATTR_USERTYPE

◆ ILS_RP_INDEXED_ATTR_XXX

◆ ILS_RP_INDEXED_DEFAULT_BOOLEAN

◆ ILS_RP_INDEXED_DEFAULT_CHAR

◆ ILS_RP_INDEXED_DEFAULT_DOUBLE

◆ ILS_RP_INDEXED_DEFAULT_FILE

◆ ILS_RP_INDEXED_DEFAULT_FLOAT

◆ ILS_RP_INDEXED_DEFAULT_HREF

◆ ILS_RP_INDEXED_DEFAULT_INT

◆ ILS_RP_INDEXED_DEFAULT_LONG

◆ ILS_RP_INDEXED_DEFAULT_MVVALUE

◆ ILS_RP_INDEXED_DEFAULT_REF

◆ ILS_RP_INDEXED_DEFAULT_STRING

◆ ILS_RP_INDEXED_DEFAULT_USERTYPE

◆ ILS_RP_INDEXED_DEFAULT_XXX

◆ ILS_RP_MEMBER_FUNCTION

◆ ILS_RP_MEMBER_FUNCTION0

◆ ILS_RP_MEMBER_FUNCTION1

◆ ILS_RP_MEMBER_FUNCTION2

◆ ILS_RP_MEMBER_FUNCTION3

◆ ILS_RP_MEMBER_FUNCTION4

◆ ILS_RP_MEMBER_FUNCTION5

◆ ILS_RP_MEMBER_FUNCTION6