Documentation ¶
Index ¶
- type BaseObject
- func (n *BaseObject) AddConnection(connection *rxlib.Connection)
- func (n *BaseObject) AddData(key string, data any)
- func (n *BaseObject) AddOptions(opts *rxlib.Options)
- func (n *BaseObject) AddRuntime(runtimeObjects map[string]rxlib.Object)
- func (n *BaseObject) AddSchema()
- func (n *BaseObject) AddServices()
- func (n *BaseObject) AddSettings(settings *rxlib.Settings)
- func (n *BaseObject) AddToObjectToRuntime(object rxlib.Object) rxlib.Object
- func (n *BaseObject) BuildSchema(schema *schema.Generated)
- func (n *BaseObject) BusChannel(inputID string) (chan *rxlib.Message, bool)
- func (n *BaseObject) Delete()
- func (n *BaseObject) GetAllInputValues() []*rxlib.Port
- func (n *BaseObject) GetAllObjectValues() []*rxlib.ObjectValue
- func (n *BaseObject) GetAllOutputValues() []*rxlib.Port
- func (n *BaseObject) GetAllPortValues() []*rxlib.Port
- func (n *BaseObject) GetApplicationUse() string
- func (n *BaseObject) GetChildObject(uuid string) rxlib.Object
- func (n *BaseObject) GetChildObjects() []rxlib.Object
- func (n *BaseObject) GetChildsByType(objectID string) []rxlib.Object
- func (n *BaseObject) GetConnections() []*rxlib.Connection
- func (n *BaseObject) GetData() map[string]any
- func (n *BaseObject) GetDataByKey(key string, out interface{}) error
- func (n *BaseObject) GetDetails() *rxlib.Details
- func (n *BaseObject) GetID() string
- func (n *BaseObject) GetInput(id string) *rxlib.Port
- func (n *BaseObject) GetInputs() []*rxlib.Port
- func (n *BaseObject) GetMeta() *rxlib.Meta
- func (n *BaseObject) GetObjectName() string
- func (n *BaseObject) GetOptions() *rxlib.Options
- func (n *BaseObject) GetOutputs() []*rxlib.Port
- func (n *BaseObject) GetParentUUID() string
- func (n *BaseObject) GetPluginName() string
- func (n *BaseObject) GetPortValue(portID string) (*rxlib.Port, error)
- func (n *BaseObject) GetPortValuesChildObject(uuid string) []*rxlib.Port
- func (n *BaseObject) GetRuntimeObjects() map[string]rxlib.Object
- func (n *BaseObject) GetSchema() *schema.Generated
- func (n *BaseObject) GetSettings() *rxlib.Settings
- func (n *BaseObject) GetUUID() string
- func (n *BaseObject) HotFix() bool
- func (n *BaseObject) Loaded() bool
- func (n *BaseObject) MessageBus() map[string]chan *rxlib.Message
- func (n *BaseObject) New(objectUUID, name string, bus *rxlib.EventBus, settings *rxlib.Settings) rxlib.Object
- func (n *BaseObject) NewInputPort(id, name string, dataType rxlib.PortDataType)
- func (n *BaseObject) NewOutputPort(id, name string, dataType rxlib.PortDataType)
- func (n *BaseObject) NewPort(port *rxlib.Port)
- func (n *BaseObject) NotLoaded() bool
- func (n *BaseObject) PublishMessage(port *rxlib.Port, setLastValue ...bool)
- func (n *BaseObject) RegisterChildObject(child rxlib.Object)
- func (n *BaseObject) RemoveObjectFromRuntime()
- func (n *BaseObject) SetDetails(details *rxlib.Details)
- func (n *BaseObject) SetHotFix()
- func (n *BaseObject) SetInputValue(id string, value interface{})
- func (n *BaseObject) SetLastValue(port *rxlib.Port)
- func (n *BaseObject) SetLastValueChildObject(uuid string, port *rxlib.Port)
- func (n *BaseObject) SetLoaded(set bool)
- func (n *BaseObject) Start()
- func (n *BaseObject) SupportsServices() bool
- func (n *BaseObject) UpdateConnections(connections []*rxlib.Connection)
- func (n *BaseObject) UpdateSettings(settings *rxlib.Settings)
- type BaseObjectInterface
- type Info
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type BaseObject ¶ added in v0.0.6
type BaseObject struct { rxlib.Object EventBus *rxlib.EventBus ID string UUID string Name string Inputs []*rxlib.Port Outputs []*rxlib.Port LastValue map[string]*rxlib.Port Bus map[string]chan *rxlib.Message Connections []*rxlib.Connection PublishOnTopic bool // if its set to true we will publish its parent info as a topic eg; myFolder/bacnetPoint // contains filtered or unexported fields }
func NewBaseObject ¶ added in v0.0.6
func NewBaseObject(n *Info, bus *rxlib.EventBus) *BaseObject
NewBaseObject creates a new BaseObject with the given ID, name, EventBus, and Flow.
func (*BaseObject) AddConnection ¶ added in v0.0.6
func (n *BaseObject) AddConnection(connection *rxlib.Connection)
func (*BaseObject) AddData ¶ added in v0.0.6
func (n *BaseObject) AddData(key string, data any)
func (*BaseObject) AddOptions ¶ added in v0.0.6
func (n *BaseObject) AddOptions(opts *rxlib.Options)
func (*BaseObject) AddRuntime ¶ added in v0.0.6
func (n *BaseObject) AddRuntime(runtimeObjects map[string]rxlib.Object)
func (*BaseObject) AddSchema ¶ added in v0.0.6
func (n *BaseObject) AddSchema()
func (*BaseObject) AddServices ¶ added in v0.0.6
func (n *BaseObject) AddServices()
func (*BaseObject) AddSettings ¶ added in v0.0.6
func (n *BaseObject) AddSettings(settings *rxlib.Settings)
func (*BaseObject) AddToObjectToRuntime ¶ added in v0.0.6
func (n *BaseObject) AddToObjectToRuntime(object rxlib.Object) rxlib.Object
func (*BaseObject) BuildSchema ¶ added in v0.0.6
func (n *BaseObject) BuildSchema(schema *schema.Generated)
func (*BaseObject) BusChannel ¶ added in v0.0.6
func (n *BaseObject) BusChannel(inputID string) (chan *rxlib.Message, bool)
func (*BaseObject) Delete ¶ added in v0.0.6
func (n *BaseObject) Delete()
func (*BaseObject) GetAllInputValues ¶ added in v0.0.6
func (n *BaseObject) GetAllInputValues() []*rxlib.Port
func (*BaseObject) GetAllObjectValues ¶ added in v0.0.6
func (n *BaseObject) GetAllObjectValues() []*rxlib.ObjectValue
func (*BaseObject) GetAllOutputValues ¶ added in v0.0.6
func (n *BaseObject) GetAllOutputValues() []*rxlib.Port
func (*BaseObject) GetAllPortValues ¶ added in v0.0.6
func (n *BaseObject) GetAllPortValues() []*rxlib.Port
func (*BaseObject) GetApplicationUse ¶ added in v0.0.6
func (n *BaseObject) GetApplicationUse() string
func (*BaseObject) GetChildObject ¶ added in v0.0.6
func (n *BaseObject) GetChildObject(uuid string) rxlib.Object
GetChildObject returns a child object by its UUID
func (*BaseObject) GetChildObjects ¶ added in v0.0.6
func (n *BaseObject) GetChildObjects() []rxlib.Object
GetChildObjects returns a slice of child objects
func (*BaseObject) GetChildsByType ¶ added in v0.0.6
func (n *BaseObject) GetChildsByType(objectID string) []rxlib.Object
func (*BaseObject) GetConnections ¶ added in v0.0.6
func (n *BaseObject) GetConnections() []*rxlib.Connection
func (*BaseObject) GetData ¶ added in v0.0.6
func (n *BaseObject) GetData() map[string]any
func (*BaseObject) GetDataByKey ¶ added in v0.0.6
func (n *BaseObject) GetDataByKey(key string, out interface{}) error
func (*BaseObject) GetDetails ¶ added in v0.0.6
func (n *BaseObject) GetDetails() *rxlib.Details
func (*BaseObject) GetID ¶ added in v0.0.6
func (n *BaseObject) GetID() string
func (*BaseObject) GetInputs ¶ added in v0.0.6
func (n *BaseObject) GetInputs() []*rxlib.Port
func (*BaseObject) GetMeta ¶ added in v0.0.6
func (n *BaseObject) GetMeta() *rxlib.Meta
func (*BaseObject) GetObjectName ¶ added in v0.0.6
func (n *BaseObject) GetObjectName() string
func (*BaseObject) GetOptions ¶ added in v0.0.6
func (n *BaseObject) GetOptions() *rxlib.Options
func (*BaseObject) GetOutputs ¶ added in v0.0.6
func (n *BaseObject) GetOutputs() []*rxlib.Port
func (*BaseObject) GetParentUUID ¶ added in v0.0.6
func (n *BaseObject) GetParentUUID() string
func (*BaseObject) GetPluginName ¶ added in v0.0.6
func (n *BaseObject) GetPluginName() string
func (*BaseObject) GetPortValue ¶ added in v0.0.6
func (n *BaseObject) GetPortValue(portID string) (*rxlib.Port, error)
func (*BaseObject) GetPortValuesChildObject ¶ added in v0.0.6
func (n *BaseObject) GetPortValuesChildObject(uuid string) []*rxlib.Port
GetPortValuesChildObject returns the port values of a specific child object
func (*BaseObject) GetRuntimeObjects ¶ added in v0.0.6
func (n *BaseObject) GetRuntimeObjects() map[string]rxlib.Object
func (*BaseObject) GetSchema ¶ added in v0.0.6
func (n *BaseObject) GetSchema() *schema.Generated
func (*BaseObject) GetSettings ¶ added in v0.0.6
func (n *BaseObject) GetSettings() *rxlib.Settings
func (*BaseObject) GetUUID ¶ added in v0.0.6
func (n *BaseObject) GetUUID() string
func (*BaseObject) HotFix ¶ added in v0.0.6
func (n *BaseObject) HotFix() bool
func (*BaseObject) Loaded ¶ added in v0.0.6
func (n *BaseObject) Loaded() bool
func (*BaseObject) MessageBus ¶ added in v0.0.6
func (n *BaseObject) MessageBus() map[string]chan *rxlib.Message
func (*BaseObject) NewInputPort ¶ added in v0.0.6
func (n *BaseObject) NewInputPort(id, name string, dataType rxlib.PortDataType)
func (*BaseObject) NewOutputPort ¶ added in v0.0.6
func (n *BaseObject) NewOutputPort(id, name string, dataType rxlib.PortDataType)
func (*BaseObject) NewPort ¶ added in v0.0.6
func (n *BaseObject) NewPort(port *rxlib.Port)
func (*BaseObject) NotLoaded ¶ added in v0.0.6
func (n *BaseObject) NotLoaded() bool
func (*BaseObject) PublishMessage ¶ added in v0.0.6
func (n *BaseObject) PublishMessage(port *rxlib.Port, setLastValue ...bool)
func (*BaseObject) RegisterChildObject ¶ added in v0.0.6
func (n *BaseObject) RegisterChildObject(child rxlib.Object)
RegisterChildObject registers a object as a child
func (*BaseObject) RemoveObjectFromRuntime ¶ added in v0.0.6
func (n *BaseObject) RemoveObjectFromRuntime()
func (*BaseObject) SetDetails ¶ added in v0.0.6
func (n *BaseObject) SetDetails(details *rxlib.Details)
func (*BaseObject) SetHotFix ¶ added in v0.0.6
func (n *BaseObject) SetHotFix()
func (*BaseObject) SetInputValue ¶ added in v0.0.6
func (n *BaseObject) SetInputValue(id string, value interface{})
func (*BaseObject) SetLastValue ¶ added in v0.0.6
func (n *BaseObject) SetLastValue(port *rxlib.Port)
func (*BaseObject) SetLastValueChildObject ¶ added in v0.0.6
func (n *BaseObject) SetLastValueChildObject(uuid string, port *rxlib.Port)
func (*BaseObject) SetLoaded ¶ added in v0.0.6
func (n *BaseObject) SetLoaded(set bool)
func (*BaseObject) Start ¶ added in v0.0.6
func (n *BaseObject) Start()
func (*BaseObject) SupportsServices ¶ added in v0.0.6
func (n *BaseObject) SupportsServices() bool
func (*BaseObject) UpdateConnections ¶ added in v0.0.6
func (n *BaseObject) UpdateConnections(connections []*rxlib.Connection)
func (*BaseObject) UpdateSettings ¶ added in v0.0.6
func (n *BaseObject) UpdateSettings(settings *rxlib.Settings)
type BaseObjectInterface ¶ added in v0.0.6
type BaseObjectInterface interface { Start() Delete() SetHotFix() HotFix() bool SetLoaded(set bool) Loaded() bool NotLoaded() bool // object details/info GetUUID() string GetParentUUID() string GetPluginName() string GetApplicationUse() string GetID() string GetObjectName() string BusChannel(inputID string) (chan *rxlib.Message, bool) MessageBus() map[string]chan *rxlib.Message PublishMessage(port *rxlib.Port, setLastValue ...bool) // ports NewPort(port *rxlib.Port) // connections AddConnection(connection *rxlib.Connection) GetConnections() []*rxlib.Connection UpdateConnections(connections []*rxlib.Connection) // inputs GetInput(id string) *rxlib.Port GetInputs() []*rxlib.Port SetInputValue(id string, value interface{}) // ouputs GetOutputs() []*rxlib.Port // values GetAllObjectValues() []*rxlib.ObjectValue GetAllPortValues() []*rxlib.Port GetAllInputValues() []*rxlib.Port GetAllOutputValues() []*rxlib.Port SetLastValue(port *rxlib.Port) GetPortValue(portID string) (*rxlib.Port, error) // scheam GetSchema() *schema.Generated AddSchema() BuildSchema(schema *schema.Generated) // details SetDetails(details *rxlib.Details) GetDetails() *rxlib.Details // data AddData(key string, data any) GetDataByKey(key string, out interface{}) error // meta GetData() map[string]any GetMeta() *rxlib.Meta // settings AddSettings(settings *rxlib.Settings) GetSettings() *rxlib.Settings UpdateSettings(settings *rxlib.Settings) // runtime objects AddRuntime(runtimeObjects map[string]rxlib.Object) // gives each object access to every other object GetRuntimeObjects() map[string]rxlib.Object AddToObjectToRuntime(object rxlib.Object) rxlib.Object RemoveObjectFromRuntime() // child objects RegisterChildObject(child rxlib.Object) GetChildObjects() []rxlib.Object GetChildObject(uuid string) rxlib.Object GetChildsByType(objectID string) []rxlib.Object GetPortValuesChildObject(uuid string) []*rxlib.Port SetLastValueChildObject(uuid string, port *rxlib.Port) // options AddOptions(opts *rxlib.Options) GetOptions() *rxlib.Options // wants Services AddServices() SupportsServices() bool // contains filtered or unexported methods }
Source Files ¶
Click to show internal directories.
Click to hide internal directories.