Skip to content

Next Gen STEP AP242 Native-ish BREP Geometric Modeling Kernel

19.8 KB
Raw Blame
using Aetheris.Semantics;
using Aetheris.Kernel.Firmament.FirmamentV2;
using Aetheris.Kernel.Firmament.FirmamentV2.Syntax;

namespace Aetheris.Kernel.Firmament.Assembly;

public enum AssemblyInstanceKind { Assembly, Part, Panel }
public enum AssemblyDiagnosticSeverity { Warning, Error }
public enum PlacementConstraintKind { AxisCoincident, AxisAligned, PlaneCoincident, PointCoincident, OffsetAlongAxis, FrameCoincident }
public enum DatumOrientationRelation { SameDirection, OpposedDirection }
public enum PlacementStatus { Anchored, Resolved, Underconstrained, Overconstrained, Unresolved }
public enum PlacementAuthority { MateDerived, ImportedOccurrence, LegacyExplicit, AuthoredFrame }
public enum MechanicalInterfaceFamily { Custom, Fixed, Axial, Revolute, Prismatic, Gear }

public sealed record AssemblyDiagnostic(string Code, string Message, AssemblyDiagnosticSeverity Severity = AssemblyDiagnosticSeverity.Error)
{
    public SemanticSourceSpan? SourceSpan { get; init; }
    public string? LocationNote { get; init; }
}
public sealed record AssemblyPath(IReadOnlyList<string> Segments)
{
    public override string ToString() => string.Join(".", Segments);
    public static AssemblyPath Parse(string value) => new(value.Split('.', StringSplitOptions.RemoveEmptyEntries | StringSplitOptions.TrimEntries));
    public AssemblyPath Append(string segment) => new([.. Segments, segment]);
}

public sealed record InterfaceRoleDefinition(string Name, IReadOnlyList<string> RequiredCapabilities, int Minimum = 1, int Maximum = 1);
public sealed record AssemblyConceptMemberDefinition(string Name, string Type);
public sealed record AssemblyConceptDefinition(string Name, IReadOnlyList<AssemblyConceptMemberDefinition> Members, SemanticSourceSpan? SourceSpan = null);
public sealed record InterfaceRequirementDefinition(PlacementConstraintKind Kind, string FirstRole, string FirstMember, string SecondRole, string SecondMember, double OffsetMm = 0, DatumOrientationRelation Orientation = DatumOrientationRelation.SameDirection);
public sealed record InterfaceClearancePolicyDefinition(double MinimumClearanceMm, double MaximumClearanceMm);
public sealed record ManufacturingVariationDefinition(double LinearToleranceMm, double ThicknessToleranceMm,
    double BendAngleToleranceDegrees, double BendLocationToleranceMm, double CoatingThicknessMm,
    double CoatingThicknessToleranceMm, double EngagementLengthMm);
public sealed record InterfaceFitDefinition(string ShaftRole, string ShaftDimension, string BoreRole, string BoreDimension,
    double ClearanceScale = 1d, InterfaceClearancePolicyDefinition? Policy = null, ManufacturingVariationDefinition? Variation = null);
public sealed record InterfacePredicateRequirementDefinition(string Name, string Expression, bool Passed);
public enum FitClassification { GuaranteedClearance, PossibleContact, PossibleInterference, GuaranteedInterference, Unknown }
public sealed record InterfaceDefinition(
    string StableId, string Name, IReadOnlyList<InterfaceRoleDefinition> Roles,
    IReadOnlyList<InterfaceRequirementDefinition> Requirements,
    InterfaceFitDefinition? Fit = null,
    IReadOnlyList<string>? AdmittedFreeMotions = null,
    SemanticSourceSpan? SourceSpan = null,
    string? Continuity = null,
    string EdgeCorrespondence = "OppositeDirections",
    double GapToleranceMm = 1e-6,
    MechanicalInterfaceFamily Family = MechanicalInterfaceFamily.Custom,
    bool CompilerOwnedExpansion = false,
    IReadOnlyList<InterfacePredicateRequirementDefinition>? PredicateRequirements = null,
    GearInterfaceOptions? GearOptions = null,
    FixedSeatingOptions? Seating = null,
    AssemblyDatumContract? DatumContract = null)
{
    internal bool IsFramePlacement { get; init; }
}

public sealed record AssemblyDatumContract(string Datum, IReadOnlyList<string> Members);
public sealed record AssemblyDatumSeat(string Interface, string Datum, string Port, double[] Origin, double[] Normal, bool Support);

public sealed record FixedSeatingOptions(double GapMm, double ClockingDegrees, DatumOrientationRelation Orientation);

public sealed record GearInterfaceOptions(double? ShaftAngleDegrees, double? EngagementPhaseDegrees, string? AllowedDirection);

public sealed record AssemblyMemberSource(
    string Name, AssemblyInstanceKind Kind, string DefinitionIdentity,
    IReadOnlyList<AssemblyMemberSource> Children,
    IReadOnlyList<SemanticValue> ExposedSemantics,
    IReadOnlyList<DimensionalRelationSource>? DimensionalRelations = null,
    IReadOnlyList<SemanticProvenance>? Provenance = null,
    AssemblyTransform? ExplicitTransform = null,
    PlacementAuthority PlacementAuthority = PlacementAuthority.MateDerived,
    bool IsEncapsulatedDefinition = false,
    AssemblyDefinitionIr? SolvedAssemblyDefinition = null,
    SemanticValue? TypedEndpoint = null,
    AssemblyFramePlacementSource? FramePlacement = null,
    AssemblyDatumSeat? DatumSeat = null,
    AssemblyMaterialSelection? MaterialSelection = null,
    IReadOnlyList<AssemblyRouteInput>? RouteInputs = null);

public sealed record AssemblyFrameTransformSource(string Name, string From, double[] Translation,
    string RotationAxis, double RotationDegrees, double[]? Normal = null, double[]? Up = null,
    SemanticSourceSpan? SourceSpan = null);
public sealed record AssemblyFramePlacementSource(string From, AssemblyFrameTransformSource Target,
    MechanicalInterfaceFamily? JointFamily = null, string? MateName = null, AssemblyAxisSeatSource? AxisSeat = null);
public sealed record AssemblyAxisSeatSource(string Interface, string Datum, string Member,
    double StationMm, double ClockingDegrees, DatumOrientationRelation Orientation);
public sealed record AssemblyAxisSeatEvidence(string Mate, string InstanceStableId, AssemblyAxisSeatSource Seating,
    int DegreesOfFreedom, double AxisResidualMm, double StationResidualMm, double AngularResidualRadians,
    bool Passed, string Evidence = "exact published axis/frame against Concept target; no material-carrier inference");

/// <summary>A reusable, locally-authored Assembly product definition.  Its children
/// remain product-visible, while only <see cref="AssemblyMemberSource.ExposedSemantics"/>
/// participates in references outside an occurrence boundary.</summary>
public sealed record AssemblyDefinitionSource(
    string Name, string ParameterName, string ParameterType, AssemblyMemberSource LocalRoot,
    string DefinitionIdentity, IReadOnlyList<SemanticProvenance> Provenance,
    AssemblyPath? LocalAnchor = null,
    IReadOnlyList<MateSource>? LocalMates = null,
    IReadOnlyList<DimensionalRelationSource>? LocalDimensionalRelations = null,
    IReadOnlyList<ToleranceStackupAssertSource>? LocalStackupAsserts = null,
    IReadOnlyList<AssemblyExposedRelationSource>? ExposedRelations = null,
    string? ClaimedConcept = null,
    IReadOnlyList<AssemblyFrameTransformSource>? FrameTransforms = null)
{
    internal IReadOnlyList<InterfaceDefinition>? LocalInterfaces { get; init; }
    internal IReadOnlyDictionary<string, AssemblyExposedMateSource> ExposedMates { get; init; } = new Dictionary<string, AssemblyExposedMateSource>();
}

internal sealed record AssemblyExposedMateSource(string Target, SemanticSourceSpan SourceSpan);

public sealed record AssemblyExposedRelationSource(
    string Name, string PublicFrom, string PublicTo, AssemblyPath InternalFrom, AssemblyPath InternalTo);

public sealed record MateRoleAssignment(string Role, AssemblyPath Participant);
public sealed record MateSource(string Name, string InterfaceName, IReadOnlyList<MateRoleAssignment> Roles, SemanticSourceSpan? SourceSpan = null);
public sealed record DimensionalRelationSource(string Name, AssemblyPath From, AssemblyPath To, double Nominal, double LowerTolerance, double UpperTolerance, string Unit, string Provenance);
public sealed record ToleranceStackupAssertSource(string Name, AssemblyPath From, AssemblyPath To, double RequiredMinimum, string Unit, SemanticSourceSpan? SourceSpan = null)
{
    public string? LocationNote { get; init; }
}
public sealed record AssemblySource(
    string Name, AssemblyMemberSource Root, IReadOnlyList<InterfaceDefinition> Interfaces,
    IReadOnlyList<MateSource> Mates, AssemblyPath Anchor,
    IReadOnlyList<DimensionalRelationSource> DimensionalRelations,
    IReadOnlyList<ToleranceStackupAssertSource> StackupAsserts,
    string SourceIdentity,
    string? DefinitionSource = null,
    IReadOnlyList<AssemblyDefinitionSource>? AssemblyDefinitions = null,
    IReadOnlyList<AssemblySourceDependencyIr>? SourceDependencies = null,
    IReadOnlyList<AssemblyFrameTransformSource>? FrameTransforms = null,
    IReadOnlyList<FirmamentV2CanonicalPatternDecl>? Patterns = null,
    IReadOnlyList<ConceptIrKeyedPointSetValue>? ConceptPoints = null,
    AssemblyAppearanceCatalog? AppearanceCatalog = null,
    AssemblyAnnotations? Annotations = null)
{
    internal IReadOnlyList<DeclarationSyntax> MotionSyntax { get; init; } = [];
    internal IReadOnlyDictionary<string, AssemblyExposedMateSource> ExposedMates { get; init; } = new Dictionary<string, AssemblyExposedMateSource>();
    internal Func<AssemblyDiagnostic, AssemblyDiagnostic>? MapMotionDiagnostic { get; init; }
    internal Aetheris.Kernel.Firmament.Modules.FirmamentModuleGraph? ModuleGraph { get; init; }
    public bool HasModuleBindings => ModuleGraph?.HasModuleBindings == true;
}

public sealed record AssemblySourceDependencyIr(string Path, string Sha256, bool IsRoot);

public sealed record AssemblyTransform(double[] Matrix)
{
    public static AssemblyTransform Identity { get; } = new([1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1]);
}

public sealed record AssemblyInstanceIr(
    string StableId, AssemblyPath Path, AssemblyInstanceKind Kind, string DefinitionIdentity,
    string? ParentStableId, IReadOnlyList<string> ChildrenStableIds,
    SemanticValue SemanticRoot, AssemblyTransform? LocalTransform, AssemblyTransform? ResolvedTransform,
    IReadOnlyList<SemanticProvenance> Provenance,
    PlacementAuthority PlacementAuthority = PlacementAuthority.MateDerived,
    bool IsEncapsulatedDefinition = false,
    AssemblyDatumSeat? DatumSeat = null,
    AssemblyMaterialSelection? MaterialSelection = null,
    AssemblyAppearanceBinding? Appearance = null);

public sealed record MateEndpointIr(string Role, AssemblyPath ParticipantPath, string ParticipantSemanticValueId, IReadOnlyList<string> RequiredCapabilities);
public sealed record InterfaceRequirementResultIr(string Name, string Expression, string Status);
public sealed record GearEndpointIr(
    string ExposedPortPath, string HierarchicalPath, string DefinitionIdentity, string OccurrenceIdentity,
    GearFamily Family, int? Teeth, double? ModuleMm, double? PressureAngleDegrees,
    double? PitchDiameterMm, double PhaseDegrees, double[] Origin, double[] Axis);
public sealed record GearInterfaceResultIr(
    GearEndpointIr A, GearEndpointIr B, string Kind, double? Ratio, int RotationSign,
    string AxisRelation, double? ExpectedCenterDistanceMm, double ActualCenterDistanceMm,
    string CompatibilityStatus, IReadOnlyList<string> RejectionReasons);
public sealed record MateIr(string StableId, string Name, string InterfaceStableId, IReadOnlyList<MateEndpointIr> Roles, IReadOnlyList<string> ConstraintIds, string ValidationStatus,
    IReadOnlyList<InterfaceRequirementResultIr>? RequirementResults = null,
    GearInterfaceResultIr? GearResult = null);
public sealed record PanelMateEvidenceIr(string MateStableId,string FirstEdgeStableId,string SecondEdgeStableId,string Continuity,string Correspondence,double EndpointResidualMm,double G0ResidualMm,string Status);
public sealed record PlacementConstraintIr(
    string StableId, PlacementConstraintKind Kind, string MateStableId,
    string FirstSemanticValueId, string SecondSemanticValueId, double OffsetMm,
    double Residual, string Status,
    DatumOrientationRelation Orientation = DatumOrientationRelation.SameDirection,
    string? SeatFrameSemanticId = null,
    FixedSeatingOptions? Seating = null);
public sealed record PlacementResultIr(string InstanceStableId, PlacementStatus Status, AssemblyTransform? Transform, IReadOnlyList<string> FreeTranslations, IReadOnlyList<string> FreeRotations, IReadOnlyList<string> ConstraintIds, PlacementAuthority Authority = PlacementAuthority.MateDerived);

public sealed record DimensionalRelationIr(
    string StableId, string FromSemanticValueId, string ToSemanticValueId,
    double Nominal, double LowerTolerance, double UpperTolerance, string Unit,
    int Sign, string OriginInstancePath, string Provenance, string? MateStableId = null, string? InterfaceStableId = null,
    IReadOnlyList<SemanticProvenance>? SourceProvenance = null,
    IReadOnlyList<StackupContributionIr>? ExpandedContributors = null,
    string? AssemblyDefinitionStableId = null);

public sealed record StackupContributionIr(
    string RelationStableId, int Sign, double Nominal, double LowerTolerance, double UpperTolerance,
    string Unit, string OriginInstancePath, string Provenance, string? MateStableId, string? InterfaceStableId,
    IReadOnlyList<SemanticProvenance>? SourceProvenance = null,
    IReadOnlyList<StackupContributionIr>? ExpandedContributors = null);
public sealed record ToleranceStackupResultIr(
    string Name, string StartSemanticValueId, string EndSemanticValueId,
    double Nominal, double WorstCaseMinimum, double WorstCaseMaximum,
    double RequiredMinimum, string Unit, bool Passed, string Status,
    IReadOnlyList<StackupContributionIr> Contributions);
public sealed record FitContributionIr(string Source, string SemanticPath, double WorstCaseClearanceReductionMm);
public sealed record InterfaceFitResultIr(
    string MateStableId, double NominalClearance, double WorstCaseMinimum, double WorstCaseMaximum, string Unit, bool Compatible,
    FitClassification NominalState = FitClassification.Unknown,
    FitClassification VariationEnvelopeState = FitClassification.Unknown,
    double MaximumPenetration = 0,
    IReadOnlyList<FitContributionIr>? Contributions = null,
    string Evidence = "dimension-interval");
public sealed record AssemblyDatumIr(string SemanticValueId, string SemanticPath, string Kind, string StableBindingId);
public sealed record DatumMateSolutionIr(string MateStableId, string FirstDatumSemanticValueId, string SecondDatumSemanticValueId,
    DatumOrientationRelation Orientation, int ConstrainedDegreesOfFreedom, string Status, AssemblyTransform? DerivedTransform);

/// <summary>One occurrence relationship. Local frames are source-addressable semantic datums;
/// Z is the motion axis and X fixes the angular zero. State is degrees or millimetres.</summary>
public sealed record AssemblyJointIr(string MateStableId, string Name, MechanicalInterfaceFamily Family,
    string ParentOccurrenceId, string ChildOccurrenceId, string ParentFrameSemanticId, string ChildFrameSemanticId,
    AssemblyTransform ParentLocalFrame, AssemblyTransform ChildLocalFrame, int DegreesOfFreedom, double DefaultState = 0)
{
    public IReadOnlyList<string> PublicNames { get; init; } = [];
}

/// <summary>An exposed semantic keeps its owning occurrence, rather than freezing
/// a moving child's port at the reusable definition's zero pose.</summary>
public sealed record AssemblyExposedSemanticBinding(IReadOnlyList<string> RelativeOccurrencePath, string SemanticPath,
    string SourceSemanticId) : SemanticBinding("AssemblyExposedSemantic", SourceSemanticId);

public sealed record AssemblyDefinitionIr(
    string StableId, string DefinitionIdentity, string TemplateName, string SpecializationIdentity,
    IReadOnlyList<SemanticProvenance> Provenance, IReadOnlyList<AssemblyInstanceIr> LocalInstances,
    IReadOnlyList<MateIr> LocalMates, IReadOnlyList<PlacementResultIr> LocalPlacements,
    IReadOnlyList<DimensionalRelationIr> LocalDimensionalRelations,
    IReadOnlyList<ToleranceStackupResultIr> LocalToleranceStackups,
    IReadOnlyList<SemanticValue> PublicSemantics, IReadOnlyList<DimensionalRelationIr> PublicDimensionalRelations,
    double SolveMilliseconds,
    IReadOnlyList<PlacementConstraintIr>? LocalPlacementConstraints = null,
    IReadOnlyList<AssemblyDatumIr>? LocalDatums = null,
    IReadOnlyList<DatumMateSolutionIr>? LocalDatumMateSolutions = null,
    IReadOnlyList<InterfaceFitResultIr>? LocalFitResults = null,
    IReadOnlyList<AssemblyAxisSeatEvidence>? LocalAxisSeats = null,
    IReadOnlyList<AssemblyJointIr>? LocalJoints = null,
    IReadOnlyList<AssemblyJointIr>? LocalFrameDependencies = null)
{
    public IReadOnlyDictionary<string, string> PublicJointChannels { get; init; } = new Dictionary<string, string>();
}

public sealed record AssemblyPerformanceIr(double ParseMilliseconds, double BindMilliseconds, double MateValidationMilliseconds, double PlacementMilliseconds, double DimensionalGraphMilliseconds, double ToleranceAnalysisMilliseconds, double DefinitionMaterializationMilliseconds = 0, double GeometryExecutionMilliseconds = 0, double RouteBindingMilliseconds = 0);
public sealed record AssemblyGeometryMetricsIr(int Bodies, int Faces, int Edges, int Vertices, double[] Minimum, double[] Maximum);
public sealed record AssemblyDefinitionArtifactIr(string StableId, string DefinitionIdentity, string SpecializationIdentity, string StepSha256, AssemblyGeometryMetricsIr Metrics, IReadOnlyList<SemanticProvenance> Provenance);
public sealed record AssemblyInstanceGeometryIr(string InstanceStableId, string DefinitionArtifactStableId, AssemblyTransform WorldTransform, AssemblyGeometryMetricsIr Metrics);
public sealed record AssemblyMateResidualIr(string ConstraintStableId, PlacementConstraintKind Kind, double PositionResidualMm, double AngularResidualRadians, bool Passed, string Evidence);
public sealed record AssemblyDatumSeatEvidence(string InstanceStableId, string Interface, string Datum, double PlaneResidualMm, IReadOnlyList<string> MaterialFaces, bool Support, bool Passed);
public sealed record AssemblyGeometryArtifactIr(string Schema, IReadOnlyList<AssemblyDefinitionArtifactIr> Definitions, IReadOnlyList<AssemblyInstanceGeometryIr> Instances, IReadOnlyList<AssemblyMateResidualIr> MateResiduals, string DeterministicSha256,
    IReadOnlyList<AssemblyDatumSeatEvidence>? DatumSeats = null);
public sealed record AssemblyIr(
    string Schema, string StableId, string Name, string RootInstanceStableId,
    IReadOnlyList<AssemblyInstanceIr> Instances, IReadOnlyList<InterfaceDefinition> Interfaces,
    IReadOnlyList<MateIr> Mates, IReadOnlyList<PlacementConstraintIr> PlacementConstraints,
    IReadOnlyList<PlacementResultIr> Placements, IReadOnlyList<DimensionalRelationIr> DimensionalRelations,
    IReadOnlyList<ToleranceStackupResultIr> ToleranceStackups, IReadOnlyList<InterfaceFitResultIr> FitResults,
    IReadOnlyList<AssemblyDiagnostic> Diagnostics,
    IReadOnlyList<AssemblyDefinitionIr>? AssemblyDefinitions = null,
    IReadOnlyList<PanelMateEvidenceIr>? PanelMateEvidence = null,
    IReadOnlyList<AssemblyDatumIr>? Datums = null,
    IReadOnlyList<DatumMateSolutionIr>? DatumMateSolutions = null,
    IReadOnlyList<AssemblySourceDependencyIr>? SourceDependencies = null,
    IReadOnlyList<AssemblyJointIr>? Joints = null,
    IReadOnlyList<FirmamentV2CanonicalPatternDecl>? Patterns = null,
    IReadOnlyList<AssemblyAxisSeatEvidence>? AxisSeats = null,
    IReadOnlyList<ConceptIrKeyedPointSetValue>? ConceptPoints = null,
    IReadOnlyList<AssemblyRouteBindingEvidence>? RouteBindings = null,
    AssemblyAnnotations? Annotations = null)
{
    public IReadOnlyList<AssemblyMotionIr> Motions { get; init; } = [];
    // The same exact frame-relation data drives pose evaluation, but authored
    // Placement is not exported or counted as a physical mechanical joint.
    public IReadOnlyList<AssemblyJointIr> FrameDependencies { get; init; } = [];
    public IReadOnlyList<Aetheris.Kernel.Firmament.Modules.FirmamentInventoryBinding> InventoryBindings { get; init; } = [];
}

public sealed record AssemblyCompilationResult(AssemblyIr? Ir, IReadOnlyList<AssemblyDiagnostic> Diagnostics, AssemblyPerformanceIr? Performance = null)
{
    public bool IsSuccess => Ir is not null && Diagnostics.All(d => d.Severity != AssemblyDiagnosticSeverity.Error);
}