reporting

package
v0.7.3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 7, 2025 License: GPL-3.0 Imports: 13 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type EventSummary added in v0.7.0

type EventSummary struct {
	Time    float64
	Event   string
	Details string // Optional additional details
}

EventSummary provides a concise summary of a flight event.

type MotionMetrics added in v0.7.0

type MotionMetrics struct {
	MaxAltitude      float64
	MaxVelocity      float64
	MaxAccelerationY float64
	MaxGForce        float64
	ApogeeTimeSec    float64
	FlightTimeSec    float64
	GroundHitVel     float64
}

MotionMetrics holds summary statistics related to motion.

type MotorSummaryData added in v0.7.0

type MotorSummaryData struct {
	BurnTime      float64
	PeakThrust    float64
	AverageThrust float64
	TotalImpulse  float64
}

MotorSummaryData holds summary statistics for motor performance.

type ParachuteSummaryData added in v0.7.0

type ParachuteSummaryData struct {
	DeploymentTime float64
	DescentRate    float64
}

ParachuteSummaryData holds summary statistics for parachute performance.

type PhaseSummaryData added in v0.7.0

type PhaseSummaryData struct {
	ApogeeTimeSec float64
	MaxAltitudeM  float64
}

PhaseSummaryData holds summary statistics for flight phases.

type PlotInfo added in v0.7.0

type PlotInfo struct {
	Title    string
	Filename string // Relative path to the plot image in the assets directory
	Type     string // e.g., "altitude_vs_time", "velocity_vs_time"
}

PlotInfo stores information about a generated plot.

type RecoverySystemData added in v0.7.0

type RecoverySystemData struct {
	Type        string
	Deployment  float64
	DescentRate float64
}

RecoverySystemData holds data for a recovery system.

type ReportData

type ReportData struct {
	RecordID         string
	Version          string
	RocketName       string
	MotorName        string
	LiftoffMassKg    float64
	ConfigSummary    *config.Engine // Summary of simulation engine configuration used
	Summary          ReportSummary
	Plots            map[string]string
	MotionMetrics    *MotionMetrics
	MotorSummary     MotorSummaryData
	ParachuteSummary ParachuteSummaryData
	PhaseSummary     PhaseSummaryData
	AllEvents        []EventSummary
	Stages           []StageData
	RecoverySystems  []RecoverySystemData
	MotionData       []*plotSimRecord
	MotionHeaders    []string
	EventsData       [][]string
	Log              *logf.Logger `json:"-"` // Exclude logger from JSON
	ReportTitle      string
	GenerationDate   string
}

ReportData holds all data required to generate a report.

func LoadSimulationData

func LoadSimulationData(recordID string, rm *storage.RecordManager, reportSpecificDir string, appCfg *config.Config) (*ReportData, error)

LoadSimulationData orchestrates loading all necessary data for a report.

type ReportSummary added in v0.7.0

type ReportSummary struct {
	MotionMetrics    MotionMetrics
	MotorSummary     MotorSummaryData
	ParachuteSummary ParachuteSummaryData
	PhaseSummary     PhaseSummaryData
	EventsTimeline   []EventSummary // e.g., liftoff, burnout, apogee, parachute deploy

}

ReportSummary aggregates all summary statistics for the report.

type StageData added in v0.7.0

type StageData struct {
	Name        string
	MassKg      float64
	BurnTimeSec float64
}

StageData holds data for a single stage of the rocket.

Jump to

Keyboard shortcuts

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