com.prosysopc.ua.types.opcua.server
Class AlarmConditionTypeNode

java.lang.Object
  extended by com.prosysopc.ua.nodes.AbstractUaNode
      extended by com.prosysopc.ua.server.nodes.ServerNode
          extended by com.prosysopc.ua.server.nodes.BaseNode
              extended by com.prosysopc.ua.server.nodes.UaInstanceNode
                  extended by com.prosysopc.ua.server.nodes.UaObjectNode
                      extended by com.prosysopc.ua.server.nodes.AbstractGeneratedObjectNode
                          extended by com.prosysopc.ua.types.opcua.server.BaseObjectTypeNode
                              extended by com.prosysopc.ua.types.opcua.server.BaseEventTypeNodeBase
                                  extended by com.prosysopc.ua.types.opcua.server.BaseEventTypeNode
                                      extended by com.prosysopc.ua.types.opcua.server.ConditionTypeNodeBase
                                          extended by com.prosysopc.ua.types.opcua.server.ConditionTypeNode
                                              extended by com.prosysopc.ua.types.opcua.server.AcknowledgeableConditionTypeNodeBase
                                                  extended by com.prosysopc.ua.types.opcua.server.AcknowledgeableConditionTypeNode
                                                      extended by com.prosysopc.ua.types.opcua.server.AlarmConditionTypeNodeBase
                                                          extended by com.prosysopc.ua.types.opcua.server.AlarmConditionTypeNode
All Implemented Interfaces:
UaInstance, UaNode, UaObject, GeneratedNode, UaCallable, AcknowledgeableConditionType, AlarmConditionType, BaseEventType, BaseInstanceType, BaseObjectType, ConditionType
Direct Known Subclasses:
DiscreteAlarmTypeNodeBase, LimitAlarmTypeNodeBase

public class AlarmConditionTypeNode
extends AlarmConditionTypeNodeBase


Field Summary
 
Fields inherited from class com.prosysopc.ua.types.opcua.server.BaseEventTypeNode
lastEvent
 
Fields inherited from class com.prosysopc.ua.server.nodes.BaseNode
NODE_VERSION_PROPERTY_NAME
 
Fields inherited from class com.prosysopc.ua.server.nodes.ServerNode
eventListeners, INITIALIZATION_TIME, nodeManager, supportedAttributesMap
 
Fields inherited from interface com.prosysopc.ua.types.opcua.AlarmConditionType
ACTIVE_STATE, ENABLED_STATE, INPUT_NODE, MAX_TIME_SHELVED, SHELVING_STATE, SUPPRESSED_OR_SHELVED, SUPPRESSED_STATE
 
Fields inherited from interface com.prosysopc.ua.types.opcua.AcknowledgeableConditionType
ACKED_STATE, ACKNOWLEDGE, CONFIRM, CONFIRMED_STATE
 
Fields inherited from interface com.prosysopc.ua.types.opcua.ConditionType
ADD_COMMENT, BRANCH_ID, CLIENT_USER_ID, COMMENT, CONDITION_CLASS_ID, CONDITION_CLASS_NAME, CONDITION_NAME, DISABLE, ENABLE, LAST_SEVERITY, QUALITY, RETAIN
 
Fields inherited from interface com.prosysopc.ua.types.opcua.BaseEventType
EVENT_ID, EVENT_TYPE, LOCAL_TIME, MESSAGE, RECEIVE_TIME, SEVERITY, SOURCE_NAME, SOURCE_NODE, TIME
 
Constructor Summary
protected AlarmConditionTypeNode(NodeManagerUaNode nodeManager, org.opcfoundation.ua.builtintypes.NodeId nodeId, org.opcfoundation.ua.builtintypes.QualifiedName browseName, org.opcfoundation.ua.builtintypes.LocalizedText displayName)
          NodeBuilder uses this, you should not call this yourself.
 
Method Summary
 void afterCreate()
          This method is called after NodeBuilder has constructed the instance, it is called for every sub-node that also implement this interface
 UaVariable getInput()
          The InputNode of the alarm.
 org.opcfoundation.ua.builtintypes.NodeId getInputNode()
           
 boolean isActive()
           
 void setActive(boolean active)
          Call setActive(boolean, org.opcfoundation.ua.builtintypes.DateTime) with currentTime as transitionTime.
 void setActive(boolean active, org.opcfoundation.ua.builtintypes.DateTime activeTime)
          Define whether the condition is currently active or not.
 void setInput(UaVariable node)
          Define the InputNode of the Alarm.
 void setInputNode(org.opcfoundation.ua.builtintypes.NodeId inputNode)
          The InputNode of the Alarm.
 void setMaxTimeShelved(double maxTimeShelved)
          The optional Property MaxTimeShelved is used to set the maximum time that an Alarm Condition may be shelved.
 void setSuppressed(boolean suppressed)
          SuppressState is used internally by a Server to automatically suppress Alarms due to system specific reasons.
 void setSuppressedOrShelved(boolean suppressedOrShelved)
          The SuppressedState and the ShelvingState together result in the SuppressedOrShelved status of the Condition.
 
Methods inherited from class com.prosysopc.ua.types.opcua.server.AlarmConditionTypeNodeBase
callMethod, getActiveState, getActiveStateNode, getAlarmConditionTypeNodeInitializer, getEnabledState, getEnabledStateNode, getInputNodeNode, getMaxTimeShelved, getMaxTimeShelvedNode, getShelvingStateNode, getSuppressedOrShelvedNode, getSuppressedState, getSuppressedStateNode, isSuppressedOrShelved, setActiveState, setAlarmConditionTypeNodeInitializer, setEnabledState, setMaxTimeShelved, setSuppressedOrShelved, setSuppressedState
 
Methods inherited from class com.prosysopc.ua.types.opcua.server.AcknowledgeableConditionTypeNode
acknowledge, confirm, isAcked, isConfirmed, onAcknowledge, onConfirm, setAcked, setAcked, setConfirmed, setConfirmed
 
Methods inherited from class com.prosysopc.ua.types.opcua.server.AcknowledgeableConditionTypeNodeBase
acknowledge, confirm, getAckedState, getAckedStateNode, getAcknowledgeableConditionTypeNodeInitializer, getAcknowledgeMethodImplementation, getAcknowledgeNode, getConfirmedState, getConfirmedStateNode, getConfirmMethodImplementation, getConfirmNode, setAckedState, setAcknowledgeableConditionTypeNodeInitializer, setAcknowledgeMethodImplementation, setConfirmedState, setConfirmMethodImplementation
 
Methods inherited from class com.prosysopc.ua.types.opcua.server.ConditionTypeNode
addComment, checkEnabled, isEnabled, onAddComment, onDisable, onEnable, setEnabled, setEnabled, setQuality, setRetain, triggerEvent, triggerEvent
 
Methods inherited from class com.prosysopc.ua.types.opcua.server.ConditionTypeNodeBase
addComment, disable, enable, getAddCommentMethodImplementation, getAddCommentNode, getBranchId, getBranchIdNode, getClientUserId, getClientUserIdNode, getComment, getCommentNode, getConditionClassId, getConditionClassIdNode, getConditionClassName, getConditionClassNameNode, getConditionName, getConditionNameNode, getConditionTypeNodeInitializer, getDisableMethodImplementation, getDisableNode, getEnableMethodImplementation, getEnableNode, getLastSeverity, getLastSeverityNode, getQuality, getQualityNode, getRetainNode, isRetain, setAddCommentMethodImplementation, setBranchId, setClientUserId, setComment, setConditionClassId, setConditionClassName, setConditionName, setConditionTypeNodeInitializer, setDisableMethodImplementation, setEnableMethodImplementation, setLastSeverity, setLastSeverity, setRetain
 
Methods inherited from class com.prosysopc.ua.types.opcua.server.BaseEventTypeNode
afterAddReference, getLastEvent, getSource, getSourceName, getSourceNode, isDeleteOneShotEvents, isMonitoredForEvents, setDeleteOneShotEvents, setSeverity, setSeverity, setSource, setSourceName, triggerEvent
 
Methods inherited from class com.prosysopc.ua.types.opcua.server.BaseEventTypeNodeBase
getBaseEventTypeNodeInitializer, getEventId, getEventIdNode, getEventType, getEventTypeNode, getLocalTime, getLocalTimeNode, getMessage, getMessageNode, getReceiveTime, getReceiveTimeNode, getSeverity, getSeverityNode, getSourceNameNode, getSourceNodeNode, getTime, getTimeNode, setBaseEventTypeNodeInitializer, setEventId, setEventType, setLocalTime, setMessage, setReceiveTime, setSourceNode, setTime
 
Methods inherited from class com.prosysopc.ua.types.opcua.server.BaseObjectTypeNode
isCacheMethodIds, setCacheMethodIds
 
Methods inherited from class com.prosysopc.ua.server.nodes.AbstractGeneratedObjectNode
afterCreateInitIfExists, afterCreateSetValueIfExists, callAfterCreateIfExists, getDefaultTypeDefinition, getQualifiedName, isComponentMatch
 
Methods inherited from class com.prosysopc.ua.server.nodes.UaObjectNode
addCallListener, callMethod, deleteIfNodeExists, getAttributes, getAttributes, getEventNotifier, getIcon, getNodeClass, initSupportedAttributes, readAttributeValue, removeCallListener, setAttributes, setEventNotifier, setIcon, toString, writeAttributeValue
 
Methods inherited from class com.prosysopc.ua.server.nodes.UaInstanceNode
addModellingRule, beforeAddReference, getTypeDefinition, getTypeDefinitionId, hasTypeDefinition, registerOverridePlainMethod, setTypeDefinition, setTypeDefinitionId, setTypeDefinitionId, supportsTypeDefinitionNode
 
Methods inherited from class com.prosysopc.ua.server.nodes.BaseNode
addPlainProperty, addPlainVariable, assertTypeSupport, assertTypeSupport, createNodeId, createNodeId, createReflectiveInstanceProperty, createReflectiveInstanceProperty, deleteReference, deleteReference, doAddProperty, getAttributes, getBrowseName, getComponent, getComponents, getDescription, getDescription, getDisplayName, getDisplayName, getMethod, getNodeVersion, getNodeVersionValue, getProperties, getProperty, getPropertyValue, getReferencesAsList, getStandardBrowseName, getStandardDisplayText, getUserWriteMask, getWriteMask, hasProperty, hasReference, hasUserWriteAccess, hasWriteAccess, incNodeVersion, initNodeVersion, isChildOfType, readAttribute, readAttribute, registerCallbackProperty, registerPlainInstanceProperty, registerPlainInstanceProperty, registerPlainProperty, registerPlainProperty, registerPlainVariable, registerPlainVariable, registerReflectiveInstanceProperty, registerReflectiveInstanceVariable, registerReflectiveProperty, registerReflectiveVariable, removeProperty, setAccessLevelRecursively, setAccessLevelRecursively, setAttribute, setBrowseName, setDescription, setDisplayName, setNodeVersionValue, setPropertyValue, setUserWriteMask, setWriteMask, writeAttribute
 
Methods inherited from class com.prosysopc.ua.server.nodes.ServerNode
addComponent, addDataChangeListener, addEventListener, addNewReference, addNewReference, addOrganizes, addProperties, addProperty, addReference, addReference, addReference, addReference, addReference, addReference, afterDeleteReference, dataChange, deleteReference, deleteReference, deleteReferences, doDeleteReference, equals, findPlaceholders, fireDataChange, fireEvent, fireEventInParents, getAddressSpace, getDefaultBrowseName, getNodeId, getNodeManager, getReference, getReferenceList, getReferences, getSupportedAttributes, getTargetNodes, hashCode, isAddNotifierReferencesToServerObject, isFalseOrNull, isMandatory, isMonitoredForEvents, isTrueOrNull, isType, referenceTypeInherits, removeComponent, removeDataChangeListener, removeEventListener, setAddNotifierReferencesToServerObject, setReferences, supportsAttribute, translateBrowsePathToNodeIds, validateHasEventSourceChain, validateHasEventSourceChain
 
Methods inherited from class com.prosysopc.ua.nodes.AbstractUaNode
getForwardReferences, getInverseReferences, getReferences, getReferences, referenceTypeInherits
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.prosysopc.ua.types.opcua.AcknowledgeableConditionType
acknowledge, confirm, getAckedState, getAckedStateNode, getAcknowledgeNode, getConfirmedState, getConfirmedStateNode, getConfirmNode, setAckedState, setConfirmedState
 
Methods inherited from interface com.prosysopc.ua.types.opcua.ConditionType
addComment, disable, enable, getAddCommentNode, getBranchId, getBranchIdNode, getClientUserId, getClientUserIdNode, getComment, getCommentNode, getConditionClassId, getConditionClassIdNode, getConditionClassName, getConditionClassNameNode, getConditionName, getConditionNameNode, getDisableNode, getEnableNode, getLastSeverity, getLastSeverityNode, getQuality, getQualityNode, getRetainNode, isRetain, setBranchId, setClientUserId, setComment, setConditionClassId, setConditionClassName, setConditionName, setLastSeverity, setQuality, setRetain
 
Methods inherited from interface com.prosysopc.ua.types.opcua.BaseEventType
getEventId, getEventIdNode, getEventType, getEventTypeNode, getLocalTime, getLocalTimeNode, getMessage, getMessageNode, getReceiveTime, getReceiveTimeNode, getSeverity, getSeverityNode, getSourceName, getSourceNameNode, getSourceNode, getSourceNodeNode, getTime, getTimeNode, setEventId, setEventType, setLocalTime, setMessage, setReceiveTime, setSeverity, setSourceName, setSourceNode, setTime
 
Methods inherited from interface com.prosysopc.ua.types.opcua.BaseInstanceType
getQualifiedName
 
Methods inherited from interface com.prosysopc.ua.nodes.UaObject
callMethod, getEventNotifier, getIcon, setEventNotifier, setIcon
 
Methods inherited from interface com.prosysopc.ua.nodes.UaInstance
getTypeDefinition, getTypeDefinitionId, setTypeDefinition, setTypeDefinitionId, setTypeDefinitionId
 
Methods inherited from interface com.prosysopc.ua.nodes.UaNode
addComponent, addProperty, addReference, addReference, addReference, deleteReference, deleteReference, deleteReference, deleteReference, getAddressSpace, getAttributes, getBrowseName, getComponent, getComponents, getDescription, getDisplayName, getForwardReferences, getInverseReferences, getMethod, getNodeClass, getNodeId, getNodeVersion, getProperties, getProperty, getReference, getReferences, getReferences, getSupportedAttributes, getUserWriteMask, getWriteMask, hasUserWriteAccess, hasWriteAccess, readAttribute, readAttribute, removeComponent, removeProperty, setAttribute, setAttributes, setBrowseName, setDescription, setDisplayName, setReferences, setUserWriteMask, setWriteMask, supportsAttribute, writeAttribute
 

Constructor Detail

AlarmConditionTypeNode

protected AlarmConditionTypeNode(NodeManagerUaNode nodeManager,
                                 org.opcfoundation.ua.builtintypes.NodeId nodeId,
                                 org.opcfoundation.ua.builtintypes.QualifiedName browseName,
                                 org.opcfoundation.ua.builtintypes.LocalizedText displayName)
NodeBuilder uses this, you should not call this yourself. If you do call it, you need to create the structure of the Node yourself

Method Detail

afterCreate

public void afterCreate()
Description copied from interface: GeneratedNode
This method is called after NodeBuilder has constructed the instance, it is called for every sub-node that also implement this interface

Specified by:
afterCreate in interface GeneratedNode
Overrides:
afterCreate in class AlarmConditionTypeNodeBase

getInput

public UaVariable getInput()
The InputNode of the alarm. The InputNode is the node that contains the measurement, which is used to calculate the alarm.

Returns:
the input

getInputNode

public org.opcfoundation.ua.builtintypes.NodeId getInputNode()
Specified by:
getInputNode in interface AlarmConditionType
Overrides:
getInputNode in class AlarmConditionTypeNodeBase
Returns:
the inputNode
See Also:
setInputNode(NodeId)

isActive

public boolean isActive()
Returns:

setActive

public void setActive(boolean active)
Call setActive(boolean, org.opcfoundation.ua.builtintypes.DateTime) with currentTime as transitionTime.

Parameters:
active -

setActive

public void setActive(boolean active,
                      org.opcfoundation.ua.builtintypes.DateTime activeTime)
Define whether the condition is currently active or not.

When the condition is active, the condition situation that it represents, exists. When active returns to false, the situation goes back to normal.

Parameters:
active - the active value to set
activeTime - the transition time to the specified active state

setInput

public void setInput(UaVariable node)
Define the InputNode of the Alarm. The InputNode is the node that contains the measurement, which is used to calculate the alarm.

Instead of Input, the InputNode property may be used.

Parameters:
node - a variable node
See Also:
setInputNode(org.opcfoundation.ua.builtintypes.NodeId)

setInputNode

public void setInputNode(org.opcfoundation.ua.builtintypes.NodeId inputNode)
The InputNode of the Alarm. The InputNode is the node that contains the measurement, which is used to calculate the alarm.

If this Variable is not in the AddressSpace, a Null NodeId shall be provided.

Instead of InputNode, the Input property may be used.

Specified by:
setInputNode in interface AlarmConditionType
Overrides:
setInputNode in class AlarmConditionTypeNodeBase
Parameters:
inputNode - the inputNode to set
See Also:
setInput(com.prosysopc.ua.nodes.UaVariable)

setMaxTimeShelved

public void setMaxTimeShelved(double maxTimeShelved)
The optional Property MaxTimeShelved is used to set the maximum time that an Alarm Condition may be shelved. The value is expressed as duration. Systems can use this Property to prevent permanent Shelving of an Alarm. NOTE! Since the Property is Optional, if the node is not present, this method does nothing.

Parameters:
maxTimeShelved - the maxTimeShelved to set

setSuppressed

public void setSuppressed(boolean suppressed)
SuppressState is used internally by a Server to automatically suppress Alarms due to system specific reasons. For example a system may be configured to suppress Alarms that are associated with machinery that is shutdown, such as a low level Alarm for a tank that is currently not in use. NOTE! since the SuppressedStateNode is Optional, this method does nothing if it does not exist.

Parameters:
suppressed - the suppressed value to set

setSuppressedOrShelved

public void setSuppressedOrShelved(boolean suppressedOrShelved)
The SuppressedState and the ShelvingState together result in the SuppressedOrShelved status of the Condition. When an Alarm is in one of the states, the SuppressedOrShelved property will be set TRUE and this Alarm is then typically not displayed by the Client. State transitions associated with the Alarm do occur, but they are not typically displayed by the Clients as long as the Alarm remains in either the suppressed or shelved state.

Parameters:
suppressedOrShelved - the suppressedOrShelved value to set


Copyright © 2018. All rights reserved.