plan

Documentation

Index

• type Board
  • func GetBoard(data []byte) (*Board, error)
  • func (b *Board) ASCIIDocTable() string
  • func (b *Board) AddFeature(label string) *Board
  • func (b *Board) AddField(FeatureLabel string, fieldLabel string) *Board
  • func (b *Board) AddLane(label string) *Board
  • func (b *Board) CountFeatures() int
  • func (b *Board) GetFeatureRef(id string) FeatureReference
  • func (b *Board) GetLane(index int) Lane
  • func (b *Board) GetLaneByLabel(label string) Lane
  • func (b *Board) Move(id string, laneLabel string) *Board
  • func (b *Board) MoveLane(position int) *Board
  • func (b *Board) RemoveFeature(id string)
  • func (b *Board) String() string
  • func (b *Board) Table() *strfmt.Table
  • func (b *Board) Write(w io.Writer) error
• type Feature
  • func GetFeature(data []byte) (Feature, error)
  • func (f *Feature) AddField(label string, value any)
  • func (f Feature) FileName(dir string) string
  • func (f *Feature) RemoveField(label string)
  • func (f Feature) String() string
  • func (f Feature) Write(w io.Writer) error
• type FeatureReference
  • func (r FeatureReference) Feature() Feature
• type Field
• type Lane

Types

type Board

type Board struct {
	Lanes           []Lane `yaml:"lanes"`
	ShowFeatureIDs  bool   `yaml:"-"`
	ShowLaneNumbers bool   `yaml:"-"`
}

func GetBoard

func GetBoard(data []byte) (*Board, error)

func (*Board) ASCIIDocTable

func (b *Board) ASCIIDocTable() string

func (*Board) AddFeature

func (b *Board) AddFeature(label string) *Board

func (*Board) AddField

func (b *Board) AddField(FeatureLabel string, fieldLabel string) *Board

func (*Board) AddLane

func (b *Board) AddLane(label string) *Board

func (*Board) CountFeatures

func (b *Board) CountFeatures() int

func (*Board) GetFeatureRef

func (b *Board) GetFeatureRef(id string) FeatureReference

func (*Board) GetLane

func (b *Board) GetLane(index int) Lane

func (*Board) GetLaneByLabel

func (b *Board) GetLaneByLabel(label string) Lane

func (*Board) Move

func (b *Board) Move(id string, laneLabel string) *Board

func (*Board) MoveLane

func (b *Board) MoveLane(position int) *Board

func (*Board) RemoveFeature

func (b *Board) RemoveFeature(id string)

func (*Board) String

func (b *Board) String() string

func (*Board) Table

func (b *Board) Table() *strfmt.Table

func (*Board) Write

func (b *Board) Write(w io.Writer) error

type Feature

type Feature struct {
	FeatureReference `yaml:"ref"`
	Fields           []Field
}

func GetFeature

func GetFeature(data []byte) (Feature, error)

func (*Feature) AddField

func (f *Feature) AddField(label string, value any)

func (Feature) FileName

func (f Feature) FileName(dir string) string

func (*Feature) RemoveField

func (f *Feature) RemoveField(label string)

func (Feature) String

func (f Feature) String() string

func (Feature) Write

func (f Feature) Write(w io.Writer) error

type FeatureReference

type FeatureReference struct {
	ID    string `yaml:"id"`
	Label string `yaml:"label"`
}

func (FeatureReference) Feature

func (r FeatureReference) Feature() Feature

type Field

type Field struct {
	Label string `yaml:"label"`
	Value any    `yaml:"value"`
}

type Lane

type Lane struct {
	Label    string             `yaml:"label"`
	Features []FeatureReference `yaml:"features"`
}