This class is a base class of IlsMvComponent. More...

#include <ilserver/rtmodelp.h>

Inheritance diagram for IlsRtModelParser:

Public Member Functions
virtual void	declAttribute (const IlsString &name, IlsMvDataType type, IlsRTTypes::AttributeKind kind, const IlsMvValue &defaultValue, IlsBoolean isIndexed, IlsBoolean canEdit, IlsBoolean isImplicit, IlsBoolean isExported, IlsBoolean isDynamic)
	Called by Rogue Wave Server to declare the Server attribute name. More...

virtual void	declClass (const IlsString &name, IlsBoolean isExported, IlsBoolean isDynamic)
	Called by Rogue Wave Server to declare a Server object type. More...

virtual void	declFunction (const IlsString &signature, IlsBoolean isImplicit, IlsBoolean isExported, IlsBoolean isDynamic, IlsBoolean global)
	Called by Rogue Wave Server to declare a Server member function. More...

virtual void	declParentClass (IlsString derived, IlsString parent)
	Called by Rogue Wave Server to declare that the Server type derived derives directly from the Server type parent. More...

virtual void	declRelation (const IlsString &name, const IlsString &target, IlsRTTypes::RelationKind kind, const IlsString &reverseRelName, IlsBoolean canEdit, IlsBoolean isImplicit, IlsBoolean isMandatory, IlsBoolean isExported, IlsBoolean isDynamic)
	Called by Rogue Wave Server to declare the Server relation name. More...

virtual void	declViewType (const IlsString &viewTypeName, const IlsString &viewInfo, const IlsString &filename, IlsMvViewParamInfo **params, int nbParams)
	Called for each view types received that matches the request (see the member function `IlsMvComponent::getViewTypes()`). More...

Friends
class	IlsMvComponent

Detailed Description

This class is a base class of IlsMvComponent.

Library: mvserver
and mvcomp

It allows a component to receive the specification of a server model—asynchronously in the case of a remote component—after the function IlsMvComponent::getServerModel() has been called. All the functions in the synopsis below are virtual and have empty implementations. They are called automatically by Rogue Wave Server when it receives the model description. It is the user's responsibility to subclass IlsMvComponent and override these functions to obtain a specific representation of the server model.

See also: IlsAttributeDef, IlsFunctionDef, IlsModelInterpreter, IlsMvComponent, IlsObjectType, IlsRelationDef, IlsRTTypes::RelationKind.

Member Function Documentation

◆ declAttribute()

virtual void IlsRtModelParser::declAttribute	(	const IlsString &	name,
		IlsMvDataType	type,
		IlsRTTypes::AttributeKind	kind,
		const IlsMvValue &	defaultValue,
		IlsBoolean	isIndexed,
		IlsBoolean	canEdit,
		IlsBoolean	isImplicit,
		IlsBoolean	isExported,
		IlsBoolean	isDynamic
	)

virtual

Called by Rogue Wave Server to declare the Server attribute name.

This attribute is owned by the object type that was declared last (see the function declClass() above).

Parameters

name	attribute name.
type	the type of the attribute value.
kind	only defined for future extensions. It should not be used.
defaultValue	lets you pass a default value for the attribute.
isIndexed	set to `IlsTrue` if the attribute is indexed.
canEdit	set to `IlsTrue` if the relation is editable.
isImplicit	set to `IlsTrue` if the relation has been implicitly declared in the server model interpreter.
isExported	specifies whether this attribute has been exported. An element that has been marked as "not exported" should be considered as internal, which means that it is not available in Rogue Wave Views Studio, for example.
isDynamic	specifies whether the corresponding element has been declared using the API of the dynamic modeling services.

Warning: This member function is private.

◆ declClass()

virtual void IlsRtModelParser::declClass	(	const IlsString &	name,
		IlsBoolean	isExported,
		IlsBoolean	isDynamic
	)

virtual

Called by Rogue Wave Server to declare a Server object type.

Parameters

name	name of the type
isExported	specifies whether this attribute has been exported. An element that has been marked as "not exported" should be considered as internal, which means that it is not available in Rogue Wave Views Studio, for example.
isDynamic	specifies whether the corresponding element has been declared using the API of the dynamic modeling services.

Warning: This member function is private.

◆ declFunction()

virtual void IlsRtModelParser::declFunction	(	const IlsString &	signature,
		IlsBoolean	isImplicit,
		IlsBoolean	isExported,
		IlsBoolean	isDynamic,
		IlsBoolean	global
	)

virtual

Called by Rogue Wave Server to declare a Server member function.

This function is owned by the object type that was declared last (see the function declClass() above).

Parameters

signature	the signature of the function.
isImplicit	set to `IlsTrue` if the function has been implicitly declared in the server model interpreter.
isExported	specifies whether this attribute has been exported. An element that has been marked as "not exported" should be considered as internal, which means that it is not available in Rogue Wave Views Studio, for example.
isDynamic	set to `IlsTrue` if the function is a script function.
global	set to `IlsTrue` if a global function is currently declared.

Warning: This member function is private.

◆ declParentClass()

virtual void IlsRtModelParser::declParentClass	(	IlsString	derived,
		IlsString	parent
	)

virtual

Called by Rogue Wave Server to declare that the Server type derived derives directly from the Server type parent.

Warning: This member function is private.

Reimplemented in IlsMvComponent.

◆ declRelation()

virtual void IlsRtModelParser::declRelation	(	const IlsString &	name,
		const IlsString &	target,
		IlsRTTypes::RelationKind	kind,
		const IlsString &	reverseRelName,
		IlsBoolean	canEdit,
		IlsBoolean	isImplicit,
		IlsBoolean	isMandatory,
		IlsBoolean	isExported,
		IlsBoolean	isDynamic
	)

virtual

Called by Rogue Wave Server to declare the Server relation name.

This relation is owned by the object type that was declared last (see the function declClass()).

Parameters

name	relation name.
target	the name of the relation target type
kind	the kind of the relation
reverseRelName	the name of the direct relation in case of an inverted relation or the name of the inverted relation in case of a direct relation.
canEdit	set to `IlsTrue` if the relation is editable.
isImplicit	set to `IlsTrue` if the relation has been implicitly declared in the server model interpreter.
isMandatory	specifies whether the relation has been declared mandatory or not. This argument is only revelant for unary relations.
isExported	specifies whether this attribute has been exported. An element that has been marked as "not exported" should be considered as internal, which means that it is not available in Rogue Wave Views Studio, for example.
isDynamic	specifies whether the corresponding element has been declared using the API of the dynamic modeling services.

Warning: This member function is private.

◆ declViewType()

virtual void IlsRtModelParser::declViewType	(	const IlsString &	viewTypeName,
		const IlsString &	viewInfo,
		const IlsString &	filename,
		IlsMvViewParamInfo **	params,
		int	nbParams
	)

virtual

Called for each view types received that matches the request (see the member function IlsMvComponent::getViewTypes()).

If it is non-null, the params array parameter and its contents are not freed by Rogue Wave Server. You are responsible for freeing it when you no longer need it.

Warning: This member function is private.

Public Member Functions

Friends

Detailed Description

Member Function Documentation

◆ declAttribute()

◆ declClass()

◆ declFunction()

◆ declParentClass()

◆ declRelation()

◆ declViewType()