10.3 IDL Structure Naming Principles

Go To Mapping from FX Logical Information Structures to IDL and Generated Types

IDL structure names should preserve a clear relationship to the FX logical information structure they realize.

IDL names should:

• use stable, descriptive names;
• preserve the FX domain context where helpful;
• avoid implementation-only abbreviations when they obscure traceability;
• align with DDS Topic and generated type naming conventions;
• distinguish commands, acknowledgements, records, assertions, status reports, replay requests, and replay results; and
• remain consistent with the Phase 0 Developer Handbook.

A recommended IDL structure naming pattern is:

Fx<LogicalInformationStructureName>

Examples include:

FxTransactionCandidate
FxValidationResult
FxSemanticAssertion
FxContractState
FxCashFlowObligation
FxPolicyDecision
FxReleasePackage
FxAuditRecord
FxProvenanceRecord
FxNodeStatus
FxControlCommand
FxCommandAcknowledgement
FxReplayRequest
FxReplayResult

The IDL structure name is an implementation-level name. It does not redefine the FX logical information structure.