params

README

params

Package params is a thread-safe map data structure used as a key-value store for all nodes in cy's node tree.

Documentation

Overview

Code generated by gen.go; DO NOT EDIT.

Index

• Constants
• type DefaultParam
  • func DefaultParams() []DefaultParam
• type Parameters
  • func New() *Parameters
  • func (p *Parameters) Animate() bool
  • func (p *Parameters) Animations() []string
  • func (p *Parameters) DataDirectory() string
  • func (p *Parameters) DefaultFrame() string
  • func (p *Parameters) DefaultShell() string
  • func (p *Parameters) Get(key string) (value interface{}, ok bool)
  • func (p *Parameters) NewChild() *Parameters
  • func (p *Parameters) Set(key string, value interface{}) error
  • func (p *Parameters) SetAnimate(value bool)
  • func (p *Parameters) SetAnimations(value []string)
  • func (p *Parameters) SetDataDirectory(value string)
  • func (p *Parameters) SetDefaultFrame(value string)
  • func (p *Parameters) SetDefaultShell(value string)
  • func (p *Parameters) SetParent(parent *Parameters)
  • func (p *Parameters) SetSkipInput(value bool)
  • func (p *Parameters) SkipInput() bool

Constants

const (
	ParamAnimate       = "animate"
	ParamAnimations    = "animations"
	ParamDataDirectory = "data-directory"
	ParamDefaultFrame  = "default-frame"
	ParamDefaultShell  = "default-shell"
	ParamSkipInput     = "---skip-input"
)

Types

type DefaultParam

type DefaultParam struct {
	Name      string
	Docstring string
	Default   interface{}
}

func DefaultParams

func DefaultParams() []DefaultParam

type Parameters

type Parameters struct {
	deadlock.RWMutex
	// contains filtered or unexported fields
}

func New

func New() *Parameters

func (*Parameters) Animate

func (p *Parameters) Animate() bool

func (*Parameters) Animations

func (p *Parameters) Animations() []string

func (*Parameters) DataDirectory

func (p *Parameters) DataDirectory() string

func (*Parameters) DefaultFrame

func (p *Parameters) DefaultFrame() string

func (*Parameters) DefaultShell

func (p *Parameters) DefaultShell() string

func (*Parameters) Get

func (p *Parameters) Get(key string) (value interface{}, ok bool)

func (*Parameters) NewChild

func (p *Parameters) NewChild() *Parameters

func (*Parameters) Set

func (p *Parameters) Set(key string, value interface{}) error

func (*Parameters) SetAnimate

func (p *Parameters) SetAnimate(value bool)

func (*Parameters) SetAnimations

func (p *Parameters) SetAnimations(value []string)

func (*Parameters) SetDataDirectory

func (p *Parameters) SetDataDirectory(value string)

func (*Parameters) SetDefaultFrame

func (p *Parameters) SetDefaultFrame(value string)

func (*Parameters) SetDefaultShell

func (p *Parameters) SetDefaultShell(value string)

func (*Parameters) SetParent

func (p *Parameters) SetParent(parent *Parameters)

func (*Parameters) SetSkipInput

func (p *Parameters) SetSkipInput(value bool)

func (*Parameters) SkipInput

func (p *Parameters) SkipInput() bool