engmodel

package module

Go to main page

Versions in this module

v0

v0.3.1

Sep 24, 2026

v0.3.0

Sep 23, 2026

v0.2.0

Sep 21, 2026

Changes in this version

+ const AirborneDisclaimer

+ const CompositionLockFileName

+ var ErrNoAviationProfile = errors.New("no aviation assurance profile is authored")

+ var ErrNoLobsterActivities = errors.New("LOBSTER activity trace requires at least one TRLC-linked source artifact")

+ var ErrNoOSCALCompliance = errors.New("OSCAL export requires at least one authored compliance mapping")

+ var ErrNoOSCALProfiles = errors.New("no OSCAL compliance profiles are authored")

+ var ErrNoPOAMItems = errors.New("OSCAL POA&M requires at least one authored POA&M item")

+ func CompareSysMLV2RoundTrip(expected, actual model.SemanticModel) []string

+ func GenerateOSCALProfile(bundle model.Bundle, options OSCALProfileOptions) (string, error)

+ func GenerateOSCALProfileFromFile(path string, options OSCALProfileOptions) (string, error)

+ func GenerateSysMLV2Projection(semantic model.SemanticModel) (string, []model.SemanticDiagnostic)

+ func ImportSysMLV2Project(sourcePath string) (model.SemanticModel, error)

+ func ResolveCompositionProjection(bundle model.Bundle) (CompositionProjection, CompositionResult, error)

+ func ValidateSysMLV2Coverage(manifest SysMLCoverageManifest) error

+ func WriteCompositionLock(path string, lock CompositionLockDocument) error

+ type AirborneAssuranceOptions struct

+ Date string

+ Version string

+ type AirborneAssuranceResult struct

+ Diagnostics []model.AviationDiagnostic

+ Files map[string][]byte

+ func GenerateAirborneAssuranceFromFile(manifestPath string, options AirborneAssuranceOptions) (AirborneAssuranceResult, error)

type ComposedSystem

+ Dependency string

+ ModulePath string

+ Publication string

+ PublishedFacet map[string]string

+ PublishedIDs map[string]bool

+ Version string

+ type CompositionLockDependency struct

+ Alias string

+ Digest string

+ Path string

+ Publications []string

+ Version string

+ type CompositionLockDocument struct

+ Dependencies []CompositionLockDependency

+ SchemaVersion int

+ type CompositionProjection struct

+ Entities []PublishedProjectionEntity

+ Publications []PublishedProjection

+ func BuildCompositionProjection(result CompositionResult) CompositionProjection

+ func (projection CompositionProjection) Domain(domain string) []PublishedProjectionEntity

+ func (projection CompositionProjection) EnrichBundle(bundle model.Bundle, domains ...string) model.Bundle

type CompositionResult

+ Lock CompositionLockDocument

+ Provenance []ImportedEntityProvenance

type GemaraExportOptions

+ AssessmentPlanHref string

+ type ImportedEntityProvenance struct

+ Alias string

+ Domain string

+ ModulePath string

+ Publication string

+ QualifiedID string

+ ResolvedDir string

+ SourceID string

+ SourceModel string

+ Version string

+ type NAFExportResult struct

+ Diagnostics []validate.Diagnostic

+ Document string

+ func GenerateNAFV41(bundle model.Bundle) (NAFExportResult, error)

+ func GenerateNAFV41FromFile(architecturePath string) (NAFExportResult, error)

+ type OSCALAPDocument struct

+ AssessmentPlan oscalAssessmentPlan

+ type OSCALAPOptions struct

+ CatalogHref string

+ LastModified string

+ ProfileHref string

+ SSPHref string

+ type OSCALAPResult struct

+ Diagnostics []validate.Diagnostic

+ Document OSCALAPDocument

+ JSON string

+ func GenerateOSCALAssessmentPlan(bundle model.Bundle, options OSCALAPOptions) (OSCALAPResult, error)

+ func GenerateOSCALAssessmentPlanFromFile(architecturePath string, options OSCALAPOptions) (OSCALAPResult, error)

type OSCALAROptions

+ LastModified string

type OSCALPOAMOptions

+ LastModified string

+ type OSCALProfileOptions struct

+ LastModified string

+ Title string

+ Version string

type OSCALSSPOptions

+ ImportProfileHref string

+ LastModified string

+ type PublishedProjection struct

+ Alias string

+ Entities []PublishedProjectionEntity

+ ModulePath string

+ Publication string

+ SourceModel string

+ Version string

+ type PublishedProjectionEntity struct

+ Domain string

+ Facet string

+ Provenance ImportedEntityProvenance

+ QualifiedID string

+ Source *model.Bundle

+ SourceID string

+ Value any

type Result

+ SVG string

+ type SysMLCoverageAuthority struct

+ Baseline string

+ FormalRelease sysmlmetamodel.FormalRelease

+ InventorySHA256 string

+ MetamodelAuthority string

+ SourceManifestSHA256 string

+ Sources []sysmlmetamodel.Source

+ type SysMLCoverageCheckEvidence struct

+ Evidence []string

+ ID string

+ Status string

+ type SysMLCoverageManifest struct

+ Authority SysMLCoverageAuthority

+ Checks []SysMLCoverageCheckEvidence

+ Claim string

+ Extensions []SysMLExtensionCoverage

+ Limitations []string

+ Metaclasses []SysMLMetaclassCoverage

+ Properties []SysMLPropertyCoverage

+ Relationships []SysMLRelationshipCoverage

+ SchemaVersion string

+ Totals SysMLCoverageTotals

+ func SysMLV2Coverage() SysMLCoverageManifest

+ type SysMLCoverageTotals struct

+ AbstractOrImplicit int

+ ClassifiedRelationships int

+ CoverageDerived int

+ CoverageMapped int

+ CoverageUnimplemented int

+ DerivedProperties int

+ EffectiveProperties int

+ InheritanceEdges int

+ Metaclasses int

+ MissingRenderer int

+ NativeRendered int

+ OwnedProperties int

+ Relationships int

+ type SysMLExportResult struct

+ Diagnostics []model.SemanticDiagnostic

+ Text string

+ func ExportSysMLV2Project(architecturePath, projectDir, kparPath, sysandPath string) (SysMLExportResult, error)

+ func GenerateSysMLV2(bundle model.Bundle) (SysMLExportResult, error)

+ func GenerateSysMLV2FromFile(architecturePath string) (SysMLExportResult, error)

+ type SysMLExtensionCoverage struct

+ Evidence []string

+ ID string

+ Namespace string

+ Status string

+ type SysMLMetaclassCoverage struct

+ Abstract bool

+ Evidence []string

+ ID string

+ Origin string

+ Relationship bool

+ RendererClassification string

+ Status string

+ Syntax string

+ type SysMLPropertyCoverage struct

+ Evidence []string

+ ID string

+ Metaclass string

+ Status string

+ type SysMLRelationshipCoverage struct

+ Classification string

+ Evidence []string

+ ID string

+ Status string

+ type SysMLRendererCoverage struct

+ Entries []SysMLRendererEvidence

+ MissingRules int

+ NativeRules int

+ NonInstantiable int

+ OfficialMetaclasses int

+ Relationships int

+ type SysMLRendererEvidence struct

+ Explanation string

+ Metaclass string

+ Status string

+ Syntax string

+ type SysMLRoundTripResult struct

+ KPARPath string

+ ProjectDir string

+ ReopenedDir string

+ SourcePath string

+ SourceText string

+ func ReopenSysMLV2Project(kparPath, reopenedDir, sysandPath string) (SysMLRoundTripResult, error)

+ func VerifySysMLV2RoundTrip(architecturePath, kparPath, reopenedDir, sysandPath string) (SysMLRoundTripResult, error)

+ type TraceProvenance struct

+ Alias string

+ ModulePath string

+ Publication string

+ SourceID string

+ SourceModel string

+ Version string

type TraceRow

+ Provenance *TraceProvenance

v0.1.0

Sep 16, 2026

Changes in this version

+ const GemaraVersion

+ func GenerateGemaraOSCALAssessmentResults(bundle model.Bundle, requirements model.RequirementsDocument, codeRoot string, ...) (string, error)

+ func GenerateGemaraOSCALAssessmentResultsFromFiles(architecturePath, requirementsPath, codeRoot string, ...) (string, error)

+ func GenerateGemaraOSCALCatalog(bundle model.Bundle, options GemaraExportOptions) (string, error)

+ func GenerateGemaraOSCALCatalogFromFile(architecturePath string, options GemaraExportOptions) (string, error)

+ func HasComposition(bundle model.Bundle) bool

+ type AsciiDocOptions struct

+ CodeRoot string

+ DecisionsDocPath string

+ ViewIDs []string

+ type AsciiDocResult struct

+ DecisionsDocument string

+ Diagnostics []validate.Diagnostic

+ Document string

+ func GenerateAsciiDoc(bundle model.Bundle, requirements model.RequirementsDocument, ...) (AsciiDocResult, error)

+ func GenerateAsciiDocFromFiles(architecturePath, requirementsPath, designPath string, options AsciiDocOptions) (AsciiDocResult, error)

+ type ComposedSystem struct

+ Bundle model.Bundle

+ Children []*ComposedSystem

+ Dir string

+ Requirements model.RequirementsDocument

+ SubsystemID string

+ type CompositionResult struct

+ Allocations []MaterializedAllocation

+ Diagnostics []validate.Diagnostic

+ Root *ComposedSystem

+ func GenerateCompositionFromFile(architecturePath string) (CompositionResult, error)

+ type DanglingLink struct

+ From string

+ Kind string

+ Target string

+ type GemaraEvaluationResult struct

+ EvaluationLog gemara.EvaluationLog

+ HasContent bool

+ YAML string

+ func GenerateGemaraEvaluationLog(bundle model.Bundle, requirements model.RequirementsDocument, codeRoot string, ...) (GemaraEvaluationResult, error)

+ func GenerateGemaraEvaluationLogFromFiles(architecturePath, requirementsPath, codeRoot string, ...) (GemaraEvaluationResult, error)

+ type GemaraExportOptions struct

+ AuthorID string

+ AuthorName string

+ Date string

+ Version string

+ type GemaraExportResult struct

+ AuditLog gemara.AuditLog

+ CapabilityCatalog gemara.CapabilityCatalog

+ ControlCatalog gemara.ControlCatalog

+ ControlThreatMapping gemara.MappingDocument

+ EnforcementLog gemara.EnforcementLog

+ GuidanceCatalog gemara.GuidanceCatalog

+ HasAudit bool

+ HasEnforcement bool

+ HasGuidance bool

+ HasMapping bool

+ HasPolicy bool

+ Lexicon gemara.Lexicon

+ Policy gemara.Policy

+ PrincipleCatalog gemara.PrincipleCatalog

+ RiskCatalog gemara.RiskCatalog

+ ThreatCatalog gemara.ThreatCatalog

+ VectorCatalog gemara.VectorCatalog

+ YAML map[string]string

+ func GenerateGemara(bundle model.Bundle, options GemaraExportOptions) (GemaraExportResult, error)

+ func GenerateGemaraFromFile(architecturePath string, options GemaraExportOptions) (GemaraExportResult, error)

+ type LobsterActivityExportOptions struct

+ ActivityNamespace string

+ RequirementsPackage string

+ type LobsterActivityExportResult struct

+ JSON string

+ func GenerateLobsterActivityTraceFromDir(testsDir string, options LobsterActivityExportOptions) (LobsterActivityExportResult, error)

+ type MaterializedAllocation struct

+ Note string

+ Requirement string

+ Resolved bool

+ Subsystem string

+ System string

+ Target string

+ TargetRef string

+ TargetRefResolved bool

+ type OSCALARDocument struct

+ AssessmentResults oscalAssessmentResults

+ type OSCALAROptions struct

+ AssessmentPlanHref string

+ CatalogHref string

+ CodeRoot string

+ ProfileHref string

+ RequirementsPath string

+ type OSCALARResult struct

+ Diagnostics []validate.Diagnostic

+ Document OSCALARDocument

+ JSON string

+ func GenerateOSCALAssessmentResults(bundle model.Bundle, requirements model.RequirementsDocument, ...) (OSCALARResult, error)

+ func GenerateOSCALAssessmentResultsFromFile(architecturePath string, options OSCALAROptions) (OSCALARResult, error)

+ type OSCALPOAMDocument struct

+ PlanOfActionAndMilestones oscalPOAMRoot

+ type OSCALPOAMOptions struct

+ SSPHref string

+ type OSCALPOAMResult struct

+ Diagnostics []validate.Diagnostic

+ Document OSCALPOAMDocument

+ JSON string

+ func GenerateOSCALPOAM(bundle model.Bundle, options OSCALPOAMOptions) (OSCALPOAMResult, error)

+ func GenerateOSCALPOAMFromFile(architecturePath string, options OSCALPOAMOptions) (OSCALPOAMResult, error)

+ type OSCALSSPDocument struct

+ SystemSecurityPlan oscalSystemSecurityPlan

+ type OSCALSSPOptions struct

+ CatalogHref string

+ ProfileHref string

+ SystemDescription string

+ SystemName string

+ type OSCALSSPResult struct

+ Diagnostics []validate.Diagnostic

+ Document OSCALSSPDocument

+ JSON string

+ func GenerateOSCALSSP(bundle model.Bundle, options OSCALSSPOptions) (OSCALSSPResult, error)

+ func GenerateOSCALSSPFromFile(architecturePath string, options OSCALSSPOptions) (OSCALSSPResult, error)

+ type RequirementsDelta struct

+ Requirements RequirementsDeltaOperations

+ Version int

+ type RequirementsDeltaOperations struct

+ Add []model.Requirement

+ Remove []string

+ Update []model.Requirement

+ type RequirementsDeltaResult struct

+ Added []string

+ Candidate model.RequirementsDocument

+ Diagnostics []validate.Diagnostic

+ Diff string

+ Removed []string

+ Updated []string

+ YAML []byte

+ func ApplyRequirementsDelta(root, deltaPath string) (result RequirementsDeltaResult, err error)

+ func PlanRequirementsDelta(root, deltaPath string) (RequirementsDeltaResult, error)

+ type Result struct

+ Bundle model.Bundle

+ Diagnostics []validate.Diagnostic

+ Mermaid string

+ View view.ProjectedView

+ func Generate(bundle model.Bundle, viewID string) (Result, error)

+ func GenerateFromFile(architecturePath, viewID string) (Result, error)

+ type StructurizrExportResult struct

+ DSL string

+ Diagnostics []validate.Diagnostic

+ func GenerateStructurizrDSL(bundle model.Bundle) (StructurizrExportResult, error)

+ func GenerateStructurizrDSLFromFile(architecturePath string) (StructurizrExportResult, error)

+ type TRLCExportOptions struct

+ PackageName string

+ type TRLCExportResult struct

+ ModelRSL string

+ PackageName string

+ RequirementsTRLC string

+ func GenerateTRLCRequirements(requirements model.RequirementsDocument, options TRLCExportOptions) (TRLCExportResult, error)

+ func GenerateTRLCRequirementsFromFile(requirementsPath string, options TRLCExportOptions) (TRLCExportResult, error)

+ type ThreatModelExportOptions struct

+ Format ThreatModelFormat

+ type ThreatModelExportResult struct

+ Diagnostics []validate.Diagnostic

+ JSON string

+ func GenerateThreatModelExport(bundle model.Bundle, options ThreatModelExportOptions) (ThreatModelExportResult, error)

+ func GenerateThreatModelExportFromFile(architecturePath string, options ThreatModelExportOptions) (ThreatModelExportResult, error)

+ type ThreatModelFormat string

+ const ThreatModelFormatOpenOTM

+ const ThreatModelFormatThreatDragonV2

+ type TraceCodeRef struct

+ Line int

+ Path string

+ Symbol string

+ type TraceDelegation struct

+ Subsystem string

+ Target string

+ TargetRequirement string

+ type TraceMatrix struct

+ DanglingLinks []DanglingLink

+ Model string

+ Orphans []string

+ Requirements []TraceRow

+ Summary TraceSummary

+ func BuildTraceMatrixFromFiles(modelPath, requirementsPath, codeRoot string) (TraceMatrix, []validate.Diagnostic, error)

+ func (m TraceMatrix) CSV() []byte

+ type TraceRow struct

+ Code []TraceCodeRef

+ DelegatedTo *TraceDelegation

+ ID string

+ Status string

+ Text string

+ Units []string

+ Verifications []string

+ type TraceSummary struct

+ DanglingLinks int

+ Delegated int

+ Implemented int

+ Orphan int

+ Requirements int

+ Verified int

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL