simulations

type CreateSimulationInput struct {
	Name      string
	Owner     *string
	Creator   string
	Image     []string
	Private   bool
	StopOnEnd bool
	Extra     string
	Track     string
	Robots    string
}

type Error string

type GroupID string

type Kind uint

type Marsupial interface {
	// GetParent returns the marsupial parent robot.
	GetParent() Robot
	// GetChild returns the marsupial child robot.
	GetChild() Robot
}

type Robot interface {
	// GetName returns the robot's name. It's usually provided by the user.
	GetName() string
	// GetKind returns the robot's type. It's the robot config type.
	GetKind() string
	// GetImage returns the robot's image. It will be used as the robot brain.
	GetImage() string
	// IsEqual returns true if the given robot is the same robot.
	IsEqual(Robot) bool
}

type Service interface {
	Create(input CreateSimulationInput) (Simulation, error)

	// Get returns a simulation with the given GroupID.
	Get(groupID GroupID) (Simulation, error)

	// GetParent returns the child simulation's parent with the given GroupID.
	GetParent(groupID GroupID) (Simulation, error)

	// UpdateStatus updates the simulation status with the given groupID.
	UpdateStatus(groupID GroupID, status Status) error

	// UpdateScore updates the simulation score.
	UpdateScore(groupID GroupID, score *float64) error

	// Update updates the simulation matching the given groupID with the given simulation data.
	Update(groupID GroupID, simulation Simulation) error

	// GetRobots returns the robot list of the simulation with the given GroupID.
	GetRobots(groupID GroupID) ([]Robot, error)

	// MarkStopped marks a simulation identified with the given Group ID as stopped.
	MarkStopped(groupID GroupID) error

	// MarkCharged marks a simulation identified with the given Group ID as charged.
	MarkCharged(groupID GroupID) error

	// GetWebsocketToken returns a websocket token for a certain simulation with the given GroupID.
	GetWebsocketToken(groupID GroupID) (string, error)
}

type Simulation interface {
	// GetGroupID returns the current Simulation's group id.
	GetGroupID() GroupID

	// GetStatus returns the current Simulation's status.
	GetStatus() Status

	// HasStatus checks if the current Simulation has a given status.
	HasStatus(status Status) bool

	// SetStatus sets a given status to the Simulation.
	SetStatus(status Status)

	// GetKind returns the current simulation's kind.
	GetKind() Kind

	// IsKind checks if the current Simulation is of the given kind.
	IsKind(Kind) bool

	// GetError returns the current simulation's error. It returns nil if the simulation doesn't have an error.
	GetError() *Error

	// GetImage returns the simulation's docker image. This image is used as the solution image.
	GetImage() string

	// GetLaunchedAt returns the time and date the simulation was officially launched. This date can differ from the
	// time the simulation was requested due to the simulation having been held, or because it has been unable to
	// launch because of insufficient cloud resources.
	GetLaunchedAt() *time.Time

	// GetValidFor returns the amount of time that the simulation is considered valid.
	GetValidFor() time.Duration

	// IsProcessed returns true if the Simulation has been already processed.
	IsProcessed() bool

	// GetOwner returns the Simulation's owner.
	GetOwner() *string

	// GetCreator returns the Simulation's creator.
	GetCreator() string

	// GetPlatform returns the Simulation's platform.
	GetPlatform() *string

	// SetRate sets the given rate to this simulation.
	SetRate(rate calculator.Rate)

	// GetRate returns the rate at which this simulation should be charged.
	GetRate() calculator.Rate

	// GetStoppedAt returns the date and time when a simulation stopped from running.
	GetStoppedAt() *time.Time

	// GetCost applies the current rate to this simulation resulting in the amount of money that it should be charged.
	GetCost() (uint, calculator.Rate, error)

	// GetChargedAt returns the time and date this simulation was charged.
	GetChargedAt() *time.Time
}

type Statistics struct {
	// Started is true if the simulation was started.
	Started int `yaml:"was_started"`
	// SimulationTime is the duration in seconds of the simulation time.
	SimulationTime int `yaml:"sim_time_duration_sec"`
	// RealTime is the real duration in seconds of the simulation.
	RealTime int `yaml:"real_time_duration_sec"`
	// ModelCount is the amount of models used in the simulation.
	ModelCount int `yaml:"model_count"`
}

type Status string

type Summary struct {
	gorm.Model
	// GroupID identifies a simulation.
	GroupID *GroupID `json:"-" gorm:"not null;unique"`
	// Score is the simulation score.
	Score *float64 `json:"-"`
	// SimTimeDurationAvg is the average value of the simulation time duration.
	SimTimeDurationAvg float64 `json:"sim_time_duration_avg"`
	// SimTimeDurationStdDev is the standard deviation value of the simulation time duration. Only used by simulations.SimParent.
	SimTimeDurationStdDev float64 `json:"sim_time_duration_std_dev" gorm:"-"`
	// RealTimeDurationAvg is the average value of the real time duration.
	RealTimeDurationAvg float64 `json:"real_time_duration_avg"`
	// RealTimeDurationStdDev is the standard deviation value of the real time duration. Only used by simulations.SimParent.
	RealTimeDurationStdDev float64 `json:"real_time_duration_std_dev" gorm:"-"`
	// ModelCountAvg is the average value of the model count.
	ModelCountAvg float64 `json:"model_count_avg"`
	// ModelCountStdDev is the standard deviation value of the model count. Only used by simulations.SimParent.
	ModelCountStdDev float64 `json:"model_count_std_dev" gorm:"-"`
	// Sources stores the group ids of the children used to generate this summary. Only used by simulations.SimParent.
	Sources string `json:"-"`
	// RunData contains specific simulation run information. It should only be passed for single sims.
	RunData string `json:"-" gorm:"-"`
}