SCOMIDispatch: Define S-level COM class

View source: R/constructors.S

SCOMIDispatchR Documentation

Define S-level COM class

Description

This defines an S-level COM object in terms of a generator function that, when called, creates a list of functions and meta-information about properties that represents a unique object whose methods are the functions and whose properties are identified by a .properties element within the list. This object is then used in conjunction with createCOMObject to provide an invokable COM object.

Usage

SCOMIDispatch(generator, name, help = "", def = new("SCOMIDispatch"), where = "")

Arguments

generator

the generator function which is called to create each individual object. This should return a named list of functions and property identifiers. The properties are identified by a character vector in the element of the returned list named .properties.

name

the user-friendly name of the COM class which clients can use to create an instance of the COM object.

help

a string providing a description of the COM class.

def

a COM object which is filled in by this function and the .initSCOMClass function. This allows us to use inheritance relatively easily within these constructor functions by creating an object of a derived class and passing it up to the constructor functions for the ancestor classes.

where

ignored at present, but could be used to register the class.

Value

An object of class SCOMIDispatchClass.

Author(s)

Duncan Temple Lang <duncan@wald.ucdavis.edu>

References

http://www.omegahat.org/RDCOMServer

See Also

SCOMFunctionClass createCOMObject


omegahat/RDCOMServer documentation built on July 17, 2022, 7:25 p.m.