Documentation Language: Swift

ATL

Essentials

Getting Started with ATL
Understanding ATL

Transformation Execution

C ATLVirtualMachine
- Initializers
  - M init(module: ATLModule, enableDebugging: Bool)
- Instance Properties
  - P let module: ATLModule
  - P var statistics: ATLExecutionStatistics
- Instance Methods
C ATLExecutionContext
S ATLExecutionStatistics
- Initializers
  - M init()
- Instance Properties
- Instance Methods

Modules and Rules

S ATLModule
- Operators
  - static func == (ATLModule, ATLModule) -> Bool
- Initializers
  - M init(name: String, sourceMetamodels: OrderedDictionary<String, EPackage>, targetMetamodels: OrderedDictionary<String, EPackage>, helpers: OrderedDictionary<String, any ATLHelperType>, matchedRules: [ATLMatchedRule], calledRules: OrderedDictionary<String, ATLCalledRule>)
- Instance Properties
- Instance Methods
  - M func hash(into: inout Hasher)
- Default Implementations
  - Equatable Implementations
    - Operators
      - static func != (Self, Self) -> Bool
S ATLMatchedRule
- Operators
  - static func == (ATLMatchedRule, ATLMatchedRule) -> Bool
- Initializers
  - M init(name: String, sourcePattern: ATLSourcePattern, targetPatterns: [ATLTargetPattern], guard: (any ATLExpression)?)
- Instance Properties
- Instance Methods
  - M func hash(into: inout Hasher)
- Default Implementations
  - ATLRuleType Implementations
    - Instance Methods
      - M func toECoreExpressions() -> [ECoreExpression]
  - Equatable Implementations
    - Operators
      - static func != (Self, Self) -> Bool
S ATLCalledRule
- Operators
  - static func == (ATLCalledRule, ATLCalledRule) -> Bool
- Initializers
  - M init(name: String, parameters: [ATLParameter], targetPatterns: [ATLTargetPattern], body: [any ATLStatement])
- Instance Properties
- Instance Methods
  - M func hash(into: inout Hasher)
- Default Implementations
  - ATLRuleType Implementations
    - Instance Methods
      - M func toECoreExpressions() -> [ECoreExpression]
  - Equatable Implementations
    - Operators
      - static func != (Self, Self) -> Bool
S ATLHelper
- Operators
  - static func == (ATLHelper<BodyExpression>, ATLHelper<BodyExpression>) -> Bool
- Initializers
  - M init(name: String, contextType: String?, returnType: String, parameters: [ATLParameter], body: BodyExpression)
- Instance Properties
- Instance Methods
- Default Implementations
  - Equatable Implementations
    - Operators
      - static func != (Self, Self) -> Bool

Expressions

Pr ATLExpression
- Instance Methods
  - M func evaluate(in: ATLExecutionContext) async throws -> (any EcoreValue)?
  - M func toECoreExpression() -> ECoreExpression
S ATLNavigationExpression
- Operators
  - static func == (ATLNavigationExpression, ATLNavigationExpression) -> Bool
- Initializers
  - M init(source: any ATLExpression, property: String)
- Instance Properties
  - P let property: String
  - P let source: any ATLExpression
- Instance Methods
  - M func evaluate(in: ATLExecutionContext) async throws -> (any EcoreValue)?
  - M func hash(into: inout Hasher)
- Default Implementations
  - Equatable Implementations
    - Operators
      - static func != (Self, Self) -> Bool
S ATLCollectionExpression
- Operators
  - static func == (ATLCollectionExpression, ATLCollectionExpression) -> Bool
- Initializers
  - M init(source: any ATLExpression, operation: ATLCollectionOperation, iterator: String?, body: (any ATLExpression)?)
- Instance Properties
- Instance Methods
  - M func evaluate(in: ATLExecutionContext) async throws -> (any EcoreValue)?
  - M func hash(into: inout Hasher)
- Default Implementations
  - Equatable Implementations
    - Operators
      - static func != (Self, Self) -> Bool
S ATLLiteralExpression
- Operators
  - static func == (ATLLiteralExpression, ATLLiteralExpression) -> Bool
- Initializers
  - M init(value: (any EcoreValue)?)
- Instance Properties
  - P let value: (any EcoreValue)?
- Instance Methods
  - M func evaluate(in: ATLExecutionContext) async throws -> (any EcoreValue)?
  - M func hash(into: inout Hasher)
- Default Implementations
  - Equatable Implementations
    - Operators
      - static func != (Self, Self) -> Bool

Parsing

C ATLParser
- Initializers
  - M init(enableDebugging: Bool)
- Instance Methods
  - M func parse(URL) async throws -> ATLModule
  - M func parseContent(String, filename: String, searchPaths: [String], continueAfterErrors: Bool) async throws -> ATLModule
- Default Implementations
  - Actor Implementations
    - Instance Methods

Model Adapters

S ATLSourceModel
- Initializers
  - M init(resource: Resource, alias: String, metamodel: EPackage)
- Instance Properties
- Instance Methods
S ATLTargetModel
- Initializers
  - M init(resource: Resource, alias: String, metamodel: EPackage)
- Instance Properties
- Instance Methods
S ATLModelAdapterFactory
- Type Methods

Errors

E ATLExecutionError
- Enumeration Cases
- Instance Properties
  - P var errorDescription: String?
- Default Implementations
  - Error Implementations
    - Instance Properties
      - P var localizedDescription: String
  - LocalizedError Implementations
    - Instance Properties
E ATLParseError
- Enumeration Cases
- Default Implementations
  - Error Implementations
    - Instance Properties
      - P var localizedDescription: String

Classes

C ATLResource
- Initializers
  - M init(uri: String)
  - M init(uri: String, module: ATLModule)
- Instance Properties
- Instance Methods

Protocols

Pr ATLHelperType
- Instance Properties
- Instance Methods
  - M func hashValue() -> Int
  - M func isEqual(to: any ATLHelperType) -> Bool
Pr ATLRuleType
- Instance Properties
  - P var name: String
- Instance Methods
  - M func toECoreExpressions() -> [ECoreExpression]
Pr ATLStatement
- Instance Methods
  - M func execute(in: ATLExecutionContext) async throws

Structures

S ATLBinaryExpression
- Operators
  - static func == (ATLBinaryExpression, ATLBinaryExpression) -> Bool
- Initializers
  - M init(left: any ATLExpression, operator: ATLBinaryOperator, right: any ATLExpression)
- Instance Properties
- Instance Methods
  - M func evaluate(in: ATLExecutionContext) async throws -> (any EcoreValue)?
  - M func hash(into: inout Hasher)
- Default Implementations
  - Equatable Implementations
    - Operators
      - static func != (Self, Self) -> Bool
S ATLCollectionLiteralExpression
- Operators
  - static func == (ATLCollectionLiteralExpression, ATLCollectionLiteralExpression) -> Bool
- Initializers
  - M init(collectionType: String, elements: [any ATLExpression])
- Instance Properties
  - P let collectionType: String
  - P let elements: [any ATLExpression]
- Instance Methods
  - M func evaluate(in: ATLExecutionContext) async throws -> (any EcoreValue)?
  - M func hash(into: inout Hasher)
- Default Implementations
  - ATLExpression Implementations
    - Instance Methods
      - M func toECoreExpression() -> ECoreExpression
  - Equatable Implementations
    - Operators
      - static func != (Self, Self) -> Bool
S ATLConditionalExpression
- Operators
  - static func == (ATLConditionalExpression, ATLConditionalExpression) -> Bool
- Initializers
  - M init(condition: any ATLExpression, thenExpression: any ATLExpression, elseExpression: any ATLExpression)
- Instance Properties
- Instance Methods
  - M func evaluate(in: ATLExecutionContext) async throws -> (any EcoreValue)?
  - M func hash(into: inout Hasher)
- Default Implementations
  - Equatable Implementations
    - Operators
      - static func != (Self, Self) -> Bool
S ATLErrorContext
- Operators
  - static func == (ATLErrorContext, ATLErrorContext) -> Bool
- Instance Properties
- Instance Methods
  - M func summary() -> String
- Default Implementations
  - Equatable Implementations
    - Operators
      - static func != (Self, Self) -> Bool
S ATLExpressionXMIParser
- Initializers
  - M init()
- Instance Methods
  - M func parse(String) throws -> any ATLExpression
S ATLExpressionXMISerializer
- Initializers
  - M init()
- Instance Methods
  - M func serialize(any ATLExpression, indent: Int) -> String
S ATLHelperCallExpression
- Operators
  - static func == (ATLHelperCallExpression, ATLHelperCallExpression) -> Bool
- Initializers
  - M init(helperName: String, arguments: [any ATLExpression])
- Instance Properties
  - P let arguments: [any ATLExpression]
  - P let helperName: String
- Instance Methods
  - M func evaluate(in: ATLExecutionContext) async throws -> (any EcoreValue)?
  - M func hash(into: inout Hasher)
- Default Implementations
  - Equatable Implementations
    - Operators
      - static func != (Self, Self) -> Bool
S ATLHelperWrapper
- Operators
  - static func == (ATLHelperWrapper, ATLHelperWrapper) -> Bool
- Initializers
  - M init(name: String, contextType: String?, returnType: String, parameters: [ATLParameter], body: any ATLExpression)
- Instance Properties
- Instance Methods
- Default Implementations
  - Equatable Implementations
    - Operators
      - static func != (Self, Self) -> Bool
S ATLIterateExpression
- Operators
  - static func == (ATLIterateExpression, ATLIterateExpression) -> Bool
- Initializers
  - M init(source: any ATLExpression, parameter: String, accumulator: String, accumulatorType: String?, defaultValue: any ATLExpression, body: any ATLExpression)
- Instance Properties
- Instance Methods
  - M func evaluate(in: ATLExecutionContext) async throws -> (any EcoreValue)?
  - M func hash(into: inout Hasher)
- Default Implementations
  - ATLExpression Implementations
    - Instance Methods
      - M func toECoreExpression() -> ECoreExpression
  - Equatable Implementations
    - Operators
      - static func != (Self, Self) -> Bool
S ATLLambdaExpression
- Operators
  - static func == (ATLLambdaExpression, ATLLambdaExpression) -> Bool
- Initializers
  - M init(parameter: String, body: any ATLExpression)
- Instance Properties
  - P let body: any ATLExpression
  - P let parameter: String
- Instance Methods
- Default Implementations
  - ATLExpression Implementations
    - Instance Methods
      - M func toECoreExpression() -> ECoreExpression
  - Equatable Implementations
    - Operators
      - static func != (Self, Self) -> Bool
S ATLLazyBinding
- Initializers
  - M init(targetElement: EUUID, property: String, expression: any ATLExpression, capturedVariables: [String : (any EcoreValue)?])
- Instance Properties
S ATLLetExpression
- Operators
  - static func == (ATLLetExpression, ATLLetExpression) -> Bool
- Initializers
  - M init(variableName: String, variableType: String?, initExpression: any ATLExpression, inExpression: any ATLExpression)
- Instance Properties
- Instance Methods
  - M func evaluate(in: ATLExecutionContext) async throws -> (any EcoreValue)?
  - M func hash(into: inout Hasher)
- Default Implementations
  - ATLExpression Implementations
    - Instance Methods
      - M func toECoreExpression() -> ECoreExpression
  - Equatable Implementations
    - Operators
      - static func != (Self, Self) -> Bool
S ATLMethodCallExpression
- Operators
  - static func == (ATLMethodCallExpression, ATLMethodCallExpression) -> Bool
- Initializers
  - M init(receiver: any ATLExpression, methodName: String, arguments: [any ATLExpression])
- Instance Properties
- Instance Methods
  - M func evaluate(in: ATLExecutionContext) async throws -> (any EcoreValue)?
  - M func hash(into: inout Hasher)
- Default Implementations
  - ATLExpression Implementations
    - Instance Methods
      - M func toECoreExpression() -> ECoreExpression
  - Equatable Implementations
    - Operators
      - static func != (Self, Self) -> Bool
S ATLOperationExpression
- Operators
  - static func == (ATLOperationExpression, ATLOperationExpression) -> Bool
- Initializers
  - M init(source: (any ATLExpression)?, operationName: String, arguments: [any ATLExpression])
- Instance Properties
- Instance Methods
  - M func evaluate(in: ATLExecutionContext) async throws -> (any EcoreValue)?
  - M func hash(into: inout Hasher)
- Default Implementations
  - Equatable Implementations
    - Operators
      - static func != (Self, Self) -> Bool
S ATLParameter
- Initializers
  - M init(name: String, type: String)
- Instance Properties
  - P let name: String
  - P let type: String
- Default Implementations
  - Equatable Implementations
    - Operators
      - static func != (Self, Self) -> Bool
S ATLPerformanceMetrics
- Structures
  - S ATLPerformanceMetrics.HelperMetrics
    - Instance Properties
    - Instance Methods
  - S ATLPerformanceMetrics.MemoryMetrics
    - Instance Properties
    - Instance Methods
      - M func finalize()
      - M func summary() -> String
  - S ATLPerformanceMetrics.NavigationMetrics
    - Instance Properties
      - P var averageOperationsPerSecond: Double
      - P var operationCount: Int
    - Instance Methods
  - S ATLPerformanceMetrics.RuleMetrics
    - Instance Properties
    - Instance Methods
- Instance Properties
- Instance Methods
S ATLPropertyBinding
- Operators
  - static func == (ATLPropertyBinding, ATLPropertyBinding) -> Bool
- Initializers
  - M init(property: String, expression: any ATLExpression)
- Instance Properties
  - P let expression: any ATLExpression
  - P let property: String
- Instance Methods
  - M func hash(into: inout Hasher)
- Default Implementations
  - Equatable Implementations
    - Operators
      - static func != (Self, Self) -> Bool
S ATLSourcePattern
- Operators
  - static func == (ATLSourcePattern, ATLSourcePattern) -> Bool
- Initializers
  - M init(variableName: String, type: String, guard: (any ATLExpression)?)
- Instance Properties
- Instance Methods
  - M func hash(into: inout Hasher)
- Default Implementations
  - Equatable Implementations
    - Operators
      - static func != (Self, Self) -> Bool
S ATLTargetPattern
- Operators
  - static func == (ATLTargetPattern, ATLTargetPattern) -> Bool
- Initializers
  - M init(variableName: String, type: String, bindings: [ATLPropertyBinding])
- Instance Properties
- Instance Methods
  - M func hash(into: inout Hasher)
- Default Implementations
  - Equatable Implementations
    - Operators
      - static func != (Self, Self) -> Bool
S ATLTraceLink
- Initializers
  - M init(ruleName: String, sourceElement: EUUID, targetElements: [EUUID])
- Instance Properties
- Default Implementations
  - Equatable Implementations
    - Operators
      - static func != (Self, Self) -> Bool
S ATLTupleExpression
- Operators
  - static func == (ATLTupleExpression, ATLTupleExpression) -> Bool
- Initializers
  - M init(fields: [TupleField])
- Instance Properties
  - P let fields: [TupleField]
- Instance Methods
  - M func evaluate(in: ATLExecutionContext) async throws -> (any EcoreValue)?
  - M func hash(into: inout Hasher)
- Type Aliases
  - T ATLTupleExpression.TupleField
- Default Implementations
  - ATLExpression Implementations
    - Instance Methods
      - M func toECoreExpression() -> ECoreExpression
  - Equatable Implementations
    - Operators
      - static func != (Self, Self) -> Bool
S ATLTypeLiteralExpression
- Operators
  - static func == (ATLTypeLiteralExpression, ATLTypeLiteralExpression) -> Bool
- Initializers
  - M init(typeName: String)
- Instance Properties
  - P let typeName: String
- Instance Methods
  - M func evaluate(in: ATLExecutionContext) async throws -> (any EcoreValue)?
  - M func hash(into: inout Hasher)
- Default Implementations
  - ATLExpression Implementations
    - Instance Methods
      - M func toECoreExpression() -> ECoreExpression
  - Equatable Implementations
    - Operators
      - static func != (Self, Self) -> Bool
S ATLUnaryExpression
- Operators
  - static func == (ATLUnaryExpression, ATLUnaryExpression) -> Bool
- Initializers
  - M init(operator: ATLUnaryOperator, operand: any ATLExpression)
- Instance Properties
  - P let operand: any ATLExpression
  - P let `operator`: ATLUnaryOperator
- Instance Methods
  - M func evaluate(in: ATLExecutionContext) async throws -> (any EcoreValue)?
  - M func hash(into: inout Hasher)
- Default Implementations
  - Equatable Implementations
    - Operators
      - static func != (Self, Self) -> Bool
S ATLVariableExpression
- Initializers
  - M init(name: String)
- Instance Properties
  - P let name: String
- Instance Methods
  - M func evaluate(in: ATLExecutionContext) async throws -> (any EcoreValue)?
- Default Implementations
  - Equatable Implementations
    - Operators
      - static func != (Self, Self) -> Bool
S ATLXMIParser
- Initializers
  - M init()
- Instance Methods
  - M func parse(String) throws -> ATLModule
S ATLXMISerializer
- Initializers
  - M init()
- Instance Methods
  - M func serialize(ATLModule) throws -> String
S ElementCreationStatistics
- Instance Properties
- Default Implementations
  - Equatable Implementations
    - Operators
      - static func != (Self, Self) -> Bool

Enumerations

E ATLBinaryOperator
- Enumeration Cases
  - E case and
  - E case difference
  - E case divide
  - E case equals
  - E case excludes
  - E case greaterThan
  - E case greaterThanOrEqual
  - E case implies
  - E case includes
  - E case intersection
  - E case lessThan
  - E case lessThanOrEqual
  - E case minus
  - E case modulo
  - E case multiply
  - E case notEquals
  - E case or
  - E case plus
  - E case union
- Initializers
  - M init?(rawValue: String)
- Default Implementations
  - Equatable Implementations
    - Operators
      - static func != (Self, Self) -> Bool
  - RawRepresentable Implementations
    - Instance Properties
      - P var hashValue: Int
    - Instance Methods
      - M func hash(into: inout Hasher)
E ATLCollectionOperation
- Enumeration Cases
  - E case any
  - E case asBag
  - E case asSequence
  - E case asSet
  - E case collect
  - E case difference
  - E case excluding
  - E case exists
  - E case first
  - E case flatten
  - E case forAll
  - E case including
  - E case intersection
  - E case isEmpty
  - E case iterate
  - E case last
  - E case notEmpty
  - E case one
  - E case reject
  - E case select
  - E case size
  - E case sortedBy
  - E case union
- Initializers
  - M init?(rawValue: String)
- Default Implementations
  - Equatable Implementations
    - Operators
      - static func != (Self, Self) -> Bool
  - RawRepresentable Implementations
    - Instance Properties
      - P var hashValue: Int
    - Instance Methods
      - M func hash(into: inout Hasher)
E ATLExpressionNever
- Instance Methods
  - M func evaluate(in: ATLExecutionContext) async throws -> (any EcoreValue)?
- Default Implementations
  - ATLExpression Implementations
    - Instance Methods
      - M func toECoreExpression() -> ECoreExpression
  - Equatable Implementations
    - Operators
      - static func != (Self, Self) -> Bool
E ATLModelError
- Enumeration Cases
- Instance Properties
  - P var description: String
- Default Implementations
  - Equatable Implementations
    - Operators
      - static func != (Self, Self) -> Bool
  - Error Implementations
    - Instance Properties
      - P var localizedDescription: String
E ATLResourceError
- Enumeration Cases
- Instance Properties
  - P var errorDescription: String?
- Default Implementations
  - Error Implementations
    - Instance Properties
      - P var localizedDescription: String
  - LocalizedError Implementations
    - Instance Properties
E ATLUnaryOperator
- Enumeration Cases
  - E case minus
  - E case not
- Initializers
  - M init?(rawValue: String)
- Default Implementations
  - Equatable Implementations
    - Operators
      - static func != (Self, Self) -> Bool
  - RawRepresentable Implementations
    - Instance Properties
      - P var hashValue: Int
    - Instance Methods
      - M func hash(into: inout Hasher)
E ExpressionParseError
- Enumeration Cases
- Instance Properties
  - P var errorDescription: String?
- Default Implementations
  - Error Implementations
    - Instance Properties
      - P var localizedDescription: String
  - LocalizedError Implementations
    - Instance Properties

/

ATL / ATLExecutionContext

Property

debug

Debug mode flag for systematic tracing.

@MainActor var debug: Bool

swift-docc-static by René Hexel