API Conventions

This page describes the conventions used across the FASTSUITE E2 Python API.

Naming Patterns

• Get/Set pairs: Most properties are exposed via GetXxx() / SetXxx() method pairs rather than Python properties.
• Is/Has/Can prefixes: Boolean queries use IsXxx(), HasXxx(), or CanXxx() naming.
• Create/Add/Remove: Factory and collection methods follow CreateXxx(), AddXxx(), RemoveXxx() patterns.

Type Conventions

• Return types and parameter types reference classes within the API where possible.
• Primitive types (str, int, float, bool) follow standard Python conventions.
• Enum-like types may appear as integer constants or dedicated enum classes.

Common Patterns

• Operator pattern: Many workflows involve creating or obtaining an operator object, configuring it, then executing it.
• Event pattern: Events are subscribed via event handler registration methods and fire callbacks with context objects.
• Download/Upload pattern: Data transfer follows a profile-based configuration, then execution via an operator class.

Package Structure

The API spans the following packages:

• cenpydownload
• cenpylib
• cenpymath
• cenpyolpcore
• cenpyunits
• cenpyupload