SPL Operator Code Generation API Documentation

Introduction

This is the SPL Operator Code Generation API documentation. This API is used to develop generic SPL primitive operators using code generator templates (.cgt files), in order to achieve a level of reusability and genericity that is not available to SPL primitive operators written in pure C++ or Java.

There are three main classes of interest in this API:

• SPL::CodeGen: Provides helper routines for common code generation tasks (such as errorln, emitClass, or getOutputTupleCppInitializer)
• SPL::CodeGen::Type: Provides helper routines for common type inspection taks (such as isPrimitive or getElementType)
• SPL::Operator::Instance::OperatorInstance and its support classes (such as Context, Parameter, etc.): These are used to access the operator instance model.

Operator Instance Model

The operator instance model captures the configuration of the operator instance for which code will be generated. The configuration of the operator instance is based on its invocation in the SPL source code after composite operator expansion is performed by the compiler.

Additional details about usage of this API can be found in the "Developing operators" section of the "Streams Information Center".