RCOMTypeInterfaceDefinition-class: Classes for representing R code to interface to DCOM classes.

In omegahat/SWinTypeLibs: Type Library Information Reader

Classes for representing R code to interface to DCOM classes.

Description

These classes provide basic structures for representing R code that interfaces to (i) a DCOM interface/class, and (ii) a DCOM event handler interface.

RCOMDispatchInterfaceDefinition is used to represent code that interfaces to the methods and property accessors of a DCOM interface. The elements define the R functions that interface to these DCOM methods.

The RCOMEventInterfaceDefinition class does something similar but provides code to create an event handler for the particular DCOM event interface. It provides a constructor function for this, along with template functions to implement the event server methods.

Objects from the Class

Objects can be created by calls of the form new("RCOMDispatchInterfaceDefinition", ...) and new("RCOMEventInterfaceDefinition", ...). However, they are not expected to be used except by developers. They are exported so that others can use their contents. Instead, they are created in calls to generateClass and generateEventInterface.

Slots

className:

Object of class ClassDefinition-class, code defining an S4 class representing the interface.

methods:

Object of class "list", a list of COMMethodDefinition-class elements corresponding to the methods (not property accessors) in the DCOM interface.

guid:

Object of class "character", a collection of the UUIDs implemented by the interface. In general, there will be just one of these. This allows us to map between the human-readable name of the DCOM interface and its precise, unique identifier.

interfaceName:

Object of class "character", the name of the DCOM interface/class for which the code is being generated. This may be different from the R class name used to interface to the DCOM class.

constructor:

a character string giving the code for an R function that creates an R event handler for this type of DCOM interface. See createEventServerFromTemplate.

template:

an object of class COMEventServerInfo-class that is used to provide a stub or template for each method in the DCOM interface along with information about the parameters and their types, and the return value of the method.

propertyGets:

a list of COMPropertyGetDefinition-class objects corresponding to the property read-accessors methods in the DCOM interface.

propertySets:

a list of COMPropertySetDefinition-class objects corresponding to the property write-accessors, i.e. the methods that set the value of a property, in the DCOM interface.

Methods

writeCode

signature(def = "RCOMTypeInterfaceDefinition", file = "character"): ...

writeCode

signature(def = "RCOMTypeInterfaceDefinition", file = "ANY"): ...

Author(s)

Duncan Temple Lang <[e-mail]>

References

http://msdn.microsoft.com/library http://www.omegahat.org/RWinTypeLibs

See Also

generateInterface writeCode

Non-exported methods in generate.S: generateClass, generateMethod

omegahat/SWinTypeLibs documentation built on Jan. 17, 2024, 6:40 p.m.