IlsFunctionDef

Category

Dynamic view-related class (server side)

Inheritance Path

IlsFunctionDef

Description

An IlsFunctionDef object defines the runtime visibility and access to a member function of a server object type or a global function. It is implicitly created in the server model interpreter via static initialization data declared in macros such as ILS_MEMBER_FUNCTION or ILS_GLOBAL_FUNCTION.

Libraries

Header File

#include <ilserver/rtmodel.h>

Synopsis

class IlsFunctionDef

{

public:

IlsMvValue execute(void* obj,

const IlsMvValue* args,

int dim) const;

Accessors

IlsRTFunction getFunction()const;

const IlsString& getName() const;

const IlsMvDataType& getResType()const;

const char* getSignature()const;

IlsBoolean isExported() const;

IlsBoolean isImplicit() const;

IlsRTFunction getImplementation() const;

IlsMvDataType*const* getParameters(int& dim)const;

int getParamsNb()const;

Modifier

void setExported(IlsBoolean b);

};

Member Functions

IlsMvValue execute(void* obj,const IlsMvValue* args,int dim) const;

This member function executes the function registered in this definition object. The argument obj is the Server object on which the user function should be called. It should be cast to void*. This method also takes an array of arguments and returns the return value of the user function.

Accessors

lsRTFunction getFunction()const;

This member function returns a wrapper of the user function.

const IlsString& getName() const;

This member function returns the name of the function.

const IlsMvDataType& getResType()const;

This member function returns the type of the result yielded by the function.

const char* getSignature()const;

This member function returns a string containing the signature of the function.

IlsBoolean isExported() const;

This member function returns IlsTrue if this element of the server model interpreter is exported. By default, all model interpreter elements are exported.

IlsBoolean isImplicit() const;

This member function returns IlsTrue if the function has been implicitly declared by Rogue Wave Server, as is, for instance, the member function isOriginfunction,which is implicitly declared on Server object types.

IlsRTFunction getImplementation() const;

This member function returns a wrapper on the user function registered in this definition object. See the definition of IlsRTFunction.

IlsMvDataType*const* getParameters(int& dim)const;

This member function returns an array of the parameter types of of the user function. The returned array must not be destroyed.

int getParamsNb()const;

This member function returns the number of parameters of the user function.

Modifier

void setExported(IlsBoolean b);

Use this member function to export an element of the server model interpreter or to cancel exportation. Non-exported elements are not seen in Rogue Wave Server Studio.