Classes for C++ SDK

Version:
Current
Last modified: June 12, 2020

Classes allow you to control data and determine functionality, bundling them together for easy control. More information on C++ classes can be found on www.cplusplus.com.

The following classes can be used when creating custom tools.

Spatial Objects and the C++ SDK

While some classes can interact with blobs, they cannot manipulate spatial objects, and the string functions cannot translate to and from GeoJSON.

Class Description Documentation
EngineInterface Interface with the Alteryx Engine, providing control for low-level actions. EngineInterface
PluginInterface Connect the Alteryx Engine to your tool and drive communication between the two instances. PluginInterface
ImplementPluginInterface Use a templated format that manages communication between the Alteryx Engine and your tool. ImplementPluginInterface
IncomingConnectionInterface Connect the Alteryx Engine to your tool and manage any incoming data connections. IncomingConnectionInterface
ImplementIncomingConnectionInterface Use a templated format that manages communication between the Alteryx Engine and your tool's incoming data connections. ImplementIncomingConnectionInterface
PluginOutputConnectionHelper Manage outgoing data connections. PluginOutputConnectionHelper
GenericEngine_Alteryx Interact with the Alteryx Engine using an abstraction to associate RecordInfo with FieldBase objects. GenericEngine_Alteryx
Record Represents a row of data. Record instances are not created directly using this class. Record
RecordInfo Retrieve information about the data structure of an input or output record. RecordInfo
RecordCopier Create a field map between different RecordInfo objects. RecordCopier
ConfigUtility Construct and evaluate configuration XML. ConfigUtility
FieldBase Represents a field within a row of data. FieldBase instances are not created directly using this class. FieldBase
Was This Helpful?

Running into problems or issues with your Alteryx product? Visit the Alteryx Community or contact support.