api

Documentation

Index

• Constants
• type ActionsArray
• type ModelAttribute
  • func (ma ModelAttribute) String() string
• type Mux
  • func (m *Mux) AddHandler(address string, handler rest.HandlerFunc)
  • func (m *Mux) Initialise() *Mux
  • func (m *Mux) SetScenario(scenarioFilePath string)
  • func (m *Mux) SetSolution(solutionFilePath string)
  • func (m *Mux) SetSolutionSummary(solutionSummaryFilePath string)
  • func (m *Mux) Shutdown()
  • func (m *Mux) WithCacheMaxAge(maxAgeInSeconds uint64) *Mux
  • func (m *Mux) WithMainThreadChannel(channel *threading.MainThreadChannel) *Mux
• type SolutionContainer
  • func NewSolutionContainer(solution *solution.Solution, summary string) SolutionContainer
• type SolutionPool
  • func NewSolutionPool(referenceModel *catchment.Model) SolutionPool
  • func (sp *SolutionPool) AddSolution(label SolutionPoolLabel, modelEncoding string, summary string)
  • func (sp *SolutionPool) HasSolution(label SolutionPoolLabel) bool
  • func (sp *SolutionPool) Size() int
  • func (sp *SolutionPool) Solution(label SolutionPoolLabel) *solution.Solution
  • func (sp *SolutionPool) Summary(label SolutionPoolLabel) string
• type SolutionPoolLabel

Constants

const (
	ActiveAction   = "Active"
	InactiveAction = "Inactive"
)

Types

type ActionsArray

type ActionsArray struct {
	ApplicableActions []string
}

type ModelAttribute

type ModelAttribute string

const (
	Encoding             ModelAttribute = "Encoding"
	ParetoFrontMember    ModelAttribute = "ParetoFrontMember"
	ValidAgainstScenario ModelAttribute = "ValidAgainstScenario"
	ValidationErrors     ModelAttribute = "ValidationErrors"
	Summary              ModelAttribute = "Summary"
)

func (ModelAttribute) String

func (ma ModelAttribute) String() string

type Mux

type Mux struct {
	serverApi.Mux

	attributes.ContainedAttributes
	// contains filtered or unexported fields
}

func (*Mux) AddHandler

func (m *Mux) AddHandler(address string, handler rest.HandlerFunc)

func (*Mux) Initialise

func (m *Mux) Initialise() *Mux

func (*Mux) SetScenario

func (m *Mux) SetScenario(scenarioFilePath string)

func (*Mux) SetSolution

func (m *Mux) SetSolution(solutionFilePath string)

func (*Mux) SetSolutionSummary

func (m *Mux) SetSolutionSummary(solutionSummaryFilePath string)

func (*Mux) Shutdown

func (m *Mux) Shutdown()

func (*Mux) WithCacheMaxAge

func (m *Mux) WithCacheMaxAge(maxAgeInSeconds uint64) *Mux

func (*Mux) WithMainThreadChannel

func (m *Mux) WithMainThreadChannel(channel *threading.MainThreadChannel) *Mux

type SolutionContainer

type SolutionContainer struct {
	Solution    *solution.Solution
	Summary     string
	LastUpdated time.Time
}

func NewSolutionContainer

func NewSolutionContainer(solution *solution.Solution, summary string) SolutionContainer

type SolutionPool

type SolutionPool struct {
	// contains filtered or unexported fields
}

func NewSolutionPool

func NewSolutionPool(referenceModel *catchment.Model) SolutionPool

func (*SolutionPool) AddSolution

func (sp *SolutionPool) AddSolution(label SolutionPoolLabel, modelEncoding string, summary string)

func (*SolutionPool) HasSolution

func (sp *SolutionPool) HasSolution(label SolutionPoolLabel) bool

func (*SolutionPool) Size

func (sp *SolutionPool) Size() int

func (*SolutionPool) Solution

func (sp *SolutionPool) Solution(label SolutionPoolLabel) *solution.Solution

func (*SolutionPool) Summary

func (sp *SolutionPool) Summary(label SolutionPoolLabel) string

type SolutionPoolLabel

type SolutionPoolLabel string

const (
	AsIs SolutionPoolLabel = "As-Is"
)