Class ShelvingStateMachine

Hierarchy

StateMachine
- ShelvingStateMachine

Implements

UAObject
StateMachine

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new ShelvingStateMachine(options: any): ShelvingStateMachine

Inherited from UAAcknowledgeableConditionBase.constructor
- Defined in packages/node-opcua-address-space/src/ua_object.ts:34
Parameters
- options: any
Returns ShelvingStateMachine

Properties

_currentStateNode

_currentStateNode: State | null

_duration

_duration: number

_sheveldTime

_sheveldTime: Date

_timer

_timer: Timer | null

_unshelvedTime

_unshelvedTime: Date

currentState

currentState: UAVariablePublic

property: currentState

Readonly eventNotifier

eventNotifier: number

Readonly nodeClass

nodeClass: Object = NodeClass.Object

Optional nodeVersion

nodeVersion: UAVariableT<string, String>

NodeVersion (Optional) String The NodeVersion Property is used to indicate the version of a Node. The NodeVersion Property is updated each time a Reference is added or deleted to the Node the Property belongs to. Attribute value changes do not cause the NodeVersion to change. Clients may read the NodeVersion Property or subscribe to it to determine when the structure of a Node has changed.

oneShotShelve

oneShotShelve: UAMethod

Readonly symbolicName

symbolicName: string

timedShelve

timedShelve: UAMethod

unshelve

unshelve: UAMethod

unshelveTime

unshelveTime: UAVariable

Accessors

currentStateNode

get currentStateNode(): State | null
set currentStateNode(value: State | null): void

Inherited from StateMachine.currentStateNode
- Defined in packages/node-opcua-address-space/src/state_machine/finite_state_machine.ts:259
property

currentStateNode

Returns State | null
Inherited from StateMachine.currentStateNode
- Defined in packages/node-opcua-address-space/src/state_machine/finite_state_machine.ts:267
property

currentStateNode

Parameters
- value: State | null
Returns void

hasMethods

get hasMethods(): boolean

Inherited from UAAcknowledgeableConditionBase.hasMethods
- Defined in packages/node-opcua-address-space/src/ua_object.ts:77
returns true if the object has some opcua methods

Returns boolean

initialState

get initialState(): UAObject

Inherited from ShelvingStateMachine.initialState
- Defined in packages/node-opcua-address-space/src/state_machine/finite_state_machine.ts:146
return the node InitialStateType

property

initialState

Returns UAObject

states

get states(): any[]

Inherited from ShelvingStateMachine.states
- Defined in packages/node-opcua-address-space/src/state_machine/finite_state_machine.ts:102
Returns any[]

transitions

get transitions(): Transition[]

Inherited from ShelvingStateMachine.transitions
- Defined in packages/node-opcua-address-space/src/state_machine/finite_state_machine.ts:138
Returns Transition[]

typeDefinitionObj

get typeDefinitionObj(): UAObjectTypePublic

Inherited from UAAcknowledgeableConditionBase.typeDefinitionObj
- Defined in packages/node-opcua-address-space/src/ua_object.ts:32
Returns UAObjectTypePublic

Methods

_bubble_up_event

_bubble_up_event(eventData: any): void

Inherited from UAAcknowledgeableConditionBase._bubble_up_event
- Defined in packages/node-opcua-address-space/src/ua_object.ts:136
Parameters
- eventData: any
Returns void

_conditionRefresh

_conditionRefresh(_cache?: any): void

Inherited from UAAcknowledgeableConditionBase._conditionRefresh
- Defined in packages/node-opcua-address-space/src/ua_object.ts:182
Parameters
- Optional _cache: any
Returns void

clone

clone(options: any, optionalFilter?: any, extraInfo?: any): UAObject

Inherited from UAAcknowledgeableConditionBase.clone
- Defined in packages/node-opcua-address-space/src/ua_object.ts:60
Parameters
- options: any
- Optional optionalFilter: any
- Optional extraInfo: any
Returns UAObject

findTransitionNode

findTransitionNode(fromStateNode: NodeId | State | string | null, toStateNode: NodeId | State | string | null, predicate?: TransitionSelector): Transition | null

Inherited from ShelvingStateMachine.findTransitionNode
- Defined in packages/node-opcua-address-space/src/state_machine/finite_state_machine.ts:210
Parameters
- fromStateNode: NodeId | State | string | null
- toStateNode: NodeId | State | string | null
- Optional predicate: TransitionSelector
Returns Transition | null

getCurrentState

getCurrentState(): string | null

Inherited from ShelvingStateMachine.getCurrentState
- Defined in packages/node-opcua-address-space/src/state_machine/finite_state_machine.ts:273
Returns string | null

getMethodByName

getMethodByName(methodName: string): UAMethodPublic | null

Inherited from UAAcknowledgeableConditionBase.getMethodByName
- Defined in packages/node-opcua-address-space/src/ua_object.ts:81
Parameters
- methodName: string
Returns UAMethodPublic | null

getMethods

getMethods(): UAMethodPublic[]

Inherited from UAAcknowledgeableConditionBase.getMethods
- Defined in packages/node-opcua-address-space/src/ua_object.ts:85
Returns UAMethodPublic[]

getStateByName

getStateByName(name: string): State | null

Inherited from ShelvingStateMachine.getStateByName
- Defined in packages/node-opcua-address-space/src/state_machine/finite_state_machine.ts:111
method

getStateByName

Parameters
- name: string
  
  the name of the state to get
Returns State | null

the state with the given name

getStates

getStates(): UAObject[]

Inherited from ShelvingStateMachine.getStates
- Defined in packages/node-opcua-address-space/src/state_machine/finite_state_machine.ts:73
Returns UAObject[]

getTransitions

getTransitions(): Transition[]

Inherited from ShelvingStateMachine.getTransitions
- Defined in packages/node-opcua-address-space/src/state_machine/finite_state_machine.ts:120
Returns Transition[]

isValidTransition

isValidTransition(toStateNode: State | string, predicate?: TransitionSelector): boolean

Inherited from ShelvingStateMachine.isValidTransition
- Defined in packages/node-opcua-address-space/src/state_machine/finite_state_machine.ts:188
method

isValidTransition

Parameters
- toStateNode: State | string
- Optional predicate: TransitionSelector
Returns boolean

raiseEvent

raiseEvent(eventType: EventTypeLike | BaseNode, data: RaiseEventData): void

Inherited from UAAcknowledgeableConditionBase.raiseEvent
- Defined in packages/node-opcua-address-space/src/ua_object.ts:92
Raise a transient Event

Parameters
- eventType: EventTypeLike | BaseNode
- data: RaiseEventData
Returns void

readAttribute

readAttribute(context: SessionContext, attributeId: AttributeIds): DataValue

Inherited from UAAcknowledgeableConditionBase.readAttribute
- Defined in packages/node-opcua-address-space/src/ua_object.ts:43
Parameters
- context: SessionContext
- attributeId: AttributeIds
Returns DataValue

setState

setState(toStateNode: string | State | null, predicate?: TransitionSelector): void

Inherited from ShelvingStateMachine.setState
- Defined in packages/node-opcua-address-space/src/state_machine/finite_state_machine.ts:285
method

setState

Parameters
- toStateNode: string | State | null
- Optional predicate: TransitionSelector
Returns void

toString

toString(): string

Inherited from UAAcknowledgeableConditionBase.toString
- Defined in packages/node-opcua-address-space/src/ua_object.ts:186
Returns string

Static promote

promote(object: UAObject): ShelvingStateMachine

- Defined in packages/node-opcua-address-space/src/alarms_and_conditions/shelving_state_machine.ts:35
Parameters
- object: UAObject
Returns ShelvingStateMachine

Class ShelvingStateMachine

Hierarchy

Implements

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

options: any

Returns ShelvingStateMachine

Properties

_currentStateNode

_duration

_sheveldTime

_timer

_unshelvedTime

currentState

Readonly eventNotifier

Readonly nodeClass

Optional nodeVersion

oneShotShelve

Readonly symbolicName

timedShelve

unshelve

unshelveTime

Accessors

currentStateNode

Returns State | null

Parameters

value: State | null

Returns void

hasMethods

Returns boolean

initialState

Returns UAObject

states

Returns any[]

transitions

Returns Transition[]

typeDefinitionObj

Returns UAObjectTypePublic

Methods

_bubble_up_event

Parameters

eventData: any

Returns void

_conditionRefresh

Parameters

Optional _cache: any

Returns void

clone

Parameters

options: any

Optional optionalFilter: any

Optional extraInfo: any

Returns UAObject

findTransitionNode

Parameters

fromStateNode: NodeId | State | string | null

toStateNode: NodeId | State | string | null

Optional predicate: TransitionSelector

Returns Transition | null

getCurrentState

Returns string | null

getMethodByName

Parameters

methodName: string

Returns UAMethodPublic | null

getMethods

Returns UAMethodPublic[]

getStateByName

Parameters

name: string

Returns State | null

getStates

Returns UAObject[]

getTransitions

Returns Transition[]