usecase

package
v0.7.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 21, 2024 License: MIT Imports: 8 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type UseCaseBase 

type UseCaseBase struct {
	LocalEntity spineapi.EntityLocalInterface

	UseCaseActor model.UseCaseActorType
	UseCaseName  model.UseCaseNameType

	EventCB api.EntityEventCallback
	// contains filtered or unexported fields
}

func NewUseCaseBase 

func NewUseCaseBase(
	localEntity spineapi.EntityLocalInterface,
	usecaseActor model.UseCaseActorType,
	usecaseName model.UseCaseNameType,
	useCaseVersion string,
	useCaseDocumentSubVersion string,
	useCaseScenarios []api.UseCaseScenario,
	eventCB api.EntityEventCallback,
	useCaseUpdateEvent api.EventType,
	validActorTypes []model.UseCaseActorType,
	validEntityTypes []model.EntityTypeType,
) *UseCaseBase

func (*UseCaseBase) AddUseCase 

func (u *UseCaseBase) AddUseCase()

func (*UseCaseBase) AvailableScenariosForEntity 

func (u *UseCaseBase) AvailableScenariosForEntity(entity spineapi.EntityRemoteInterface) []uint

return the currently available scenarios for the use case for a remote entity

func (*UseCaseBase) HandleEvent 

func (u *UseCaseBase) HandleEvent(payload spineapi.EventPayload)

handle SPINE events

func (*UseCaseBase) IsCompatibleEntityType 

func (u *UseCaseBase) IsCompatibleEntityType(entity spineapi.EntityRemoteInterface) bool

func (*UseCaseBase) IsScenarioAvailableAtEntity 

func (u *UseCaseBase) IsScenarioAvailableAtEntity(
	entity spineapi.EntityRemoteInterface,
	scenario uint,
) bool

check if the provided scenario are available at the remote entity

func (*UseCaseBase) RemoteEntitiesScenarios 

func (u *UseCaseBase) RemoteEntitiesScenarios() []api.RemoteEntityScenarios

return the current list of compatible remote entities and their scenarios

func (*UseCaseBase) RemoveUseCase 

func (u *UseCaseBase) RemoveUseCase()

func (*UseCaseBase) UpdateUseCaseAvailability 

func (u *UseCaseBase) UpdateUseCaseAvailability(available bool)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.