solution

Documentation

Index

• Constants
• type ActionSummary
• type ManagementActionType
• type ManagementActions
  • func (m ManagementActions) Len() int
  • func (m ManagementActions) Less(i, j int) bool
  • func (m ManagementActions) Swap(i, j int)
• type Solution
  • func NewSolution(id string) *Solution
  • func (s Solution) ActionsAsStrings() []string
  • func (s Solution) FileNameSafeId() string
  • func (s *Solution) MatchErrors(other *Solution) *compositeErrors.CompositeError
  • func (s *Solution) PlanningUnitHeading() string
  • func (s *Solution) Summarise() *Summary
• type SolutionBuilder
  • func (sb *SolutionBuilder) Build() *Solution
  • func (sb *SolutionBuilder) ForModel(model model.Model) *SolutionBuilder
  • func (sb *SolutionBuilder) WithId(id string) *SolutionBuilder
• type Summary
  • func (s *Summary) Noting(note string) *Summary
  • func (s *Summary) WithId(id string) *Summary
  • func (s *Summary) WithSortOrder(sortIndex uint64) *Summary
• type VariableSetSummary
• type VariableSummary

Constants

const DefaultPlanningUnitHeading = "PlanningUnit"

const ModelSuppliedPlanningUnitName = "ModelSuppliedPlanningUnitName"

Types

type ActionSummary

type ActionSummary string

type ManagementActionType

type ManagementActionType string

type ManagementActions

type ManagementActions []ManagementActionType

func (ManagementActions) Len

func (m ManagementActions) Len() int

func (ManagementActions) Less

func (m ManagementActions) Less(i, j int) bool

func (ManagementActions) Swap

func (m ManagementActions) Swap(i, j int)

type Solution

type Solution struct {
	Id                        string
	DecisionVariables         variable.EncodeableDecisionVariables
	PlanningUnits             planningunit.Ids              `json:"-"`
	ManagementActions         map[ManagementActionType]bool `json:"-"`
	ActiveManagementActions   map[planningunit.Id]ManagementActions
	InactiveManagementActions map[planningunit.Id]ManagementActions `json:"-"`

	EncodedActions string `json:"-"`
	attributes.ContainedAttributes
}

func NewSolution

func NewSolution(id string) *Solution

func (Solution) ActionsAsStrings

func (s Solution) ActionsAsStrings() []string

func (Solution) FileNameSafeId

func (s Solution) FileNameSafeId() string

func (*Solution) MatchErrors

func (s *Solution) MatchErrors(other *Solution) *compositeErrors.CompositeError

func (*Solution) PlanningUnitHeading

func (s *Solution) PlanningUnitHeading() string

func (*Solution) Summarise

func (s *Solution) Summarise() *Summary

type SolutionBuilder

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

func (*SolutionBuilder) Build

func (sb *SolutionBuilder) Build() *Solution

func (*SolutionBuilder) ForModel

func (sb *SolutionBuilder) ForModel(model model.Model) *SolutionBuilder

func (*SolutionBuilder) WithId

func (sb *SolutionBuilder) WithId(id string) *SolutionBuilder

type Summary

type Summary struct {
	SortIndex uint64 `json:"-"`
	Id        string
	Variables VariableSetSummary
	Actions   ActionSummary
	Note      string
}

func (*Summary) Noting

func (s *Summary) Noting(note string) *Summary

func (*Summary) WithId

func (s *Summary) WithId(id string) *Summary

func (*Summary) WithSortOrder

func (s *Summary) WithSortOrder(sortIndex uint64) *Summary

type VariableSetSummary

type VariableSetSummary []VariableSummary

type VariableSummary

type VariableSummary struct {
	Name  string
	Value float64
}