component

Documentation

Index

• func UpdateParamTypes(desc *Component) error
• type Component
  • func (a *Component) NewParams() (map[string]interface{}, error)
• type Description
• type ParamDesc

Functions

func UpdateParamTypes

func UpdateParamTypes(desc *Component) error

UpdateParamTypes updates types in description of a component based return values of the constructor.

Types

type Component

type Component struct {
	Name        string
	Stage       api.ElementStage
	Constructor func() interface{}
	Description Description
}

Component is an antha component / element.

func (*Component) NewParams

func (a *Component) NewParams() (map[string]interface{}, error)

NewParams returns new objects instances for each input and output parameter.

If a component has parameters:

Parameters (
  String string
  Number int
)
Data(...)
Inputs(...)
Outputs(...)

The result of NewParams will be:

map[string]interface{} {
  "String": new(string),
  "Number": new(int),
  ...
}

type Description

type Description struct {
	Desc   string
	Path   string
	Params []ParamDesc
}

Description is a description of a component.

type ParamDesc

type ParamDesc struct {
	Name string // Name of parameter
	Desc string // Description of parameter from doc string
	Kind string // Input, Output, Data or Parameter
	Type string // Full go type name
}

ParamDesc is a description of the parameters of a component.