UA Bundle SDK .NET  2.3.1.334
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events Groups Pages
UnifiedAutomation.UaServer.TwoStateDiscreteModel Class Reference

Inherits UnifiedAutomation.UaServer.DiscreteItemModel.

Public Member Functions

 TwoStateDiscreteModel ()
 Initializes a new instance of the TwoStateDiscreteModel class. More...
 
 TwoStateDiscreteModel (TwoStateDiscreteModel template)
 Initializes a new instance of the TwoStateDiscreteModel class. More...
 
- Public Member Functions inherited from UnifiedAutomation.UaServer.DiscreteItemModel
 DiscreteItemModel ()
 Initializes a new instance of the DiscreteItemModel class. More...
 
 DiscreteItemModel (DiscreteItemModel template)
 Initializes a new instance of the DiscreteItemModel class. More...
 
- Public Member Functions inherited from UnifiedAutomation.UaServer.DataItemModel
 DataItemModel ()
 Initializes a new instance of the DataItemModel class. More...
 
 DataItemModel (DataItemModel template)
 Initializes a new instance of the DataItemModel class. More...
 
- Public Member Functions inherited from UnifiedAutomation.UaServer.BaseDataVariableModel
 BaseDataVariableModel ()
 Initializes a new instance of the BaseDataVariableModel class. More...
 
 BaseDataVariableModel (BaseDataVariableModel template)
 Initializes a new instance of the BaseDataVariableModel class. More...
 
- Public Member Functions inherited from UnifiedAutomation.UaServer.BaseVariableModel
 BaseVariableModel ()
 Initializes a new instance of the BaseVariableModel class. More...
 
 BaseVariableModel (BaseVariableModel template)
 Initializes a new instance of the BaseVariableModel class. More...
 
- Public Member Functions inherited from UnifiedAutomation.UaServer.ModelControllerBase
virtual ModelHandle GetModelHandle (StringTable namespaceUris, object instance)
 Gets the metadata handle. More...
 
virtual DataValue GetValue (IMapperContext context, ModelMapping mapping)
 Gets the value associated with the mapping. More...
 
virtual bool SetValue (IMapperContext context, ModelMapping mapping, DataValue value)
 Sets the value associated with the mapping. More...
 

Properties

new bool Value [get, set]
 Gets or sets the value. More...
 
LocalizedText FalseState [get, set]
 Gets or sets the FalseState More...
 
LocalizedText TrueState [get, set]
 Gets or sets the TrueState More...
 

Detailed Description

This VariableType defines the general characteristics of a DiscreteItem that can have two states. The value of the DiscreteItem is delivered as boolean but the TrueState and FalseState properties defined by the TwoStateDiscreteType provides display strings for the two possible states.

TrueState contains a string to be associated with this DataItem when it is TRUE. This is typically used for a contact when it is in the closed (non-zero) state. for example:"RUN","CLOSE","ENABLE","SAFE", etc.

FalseState contains a string to be associated with this DataItem when it is FALSE. This is typically used for a contact when it is in the open (zero) state. for example:"STOP","OPEN","DISABLE","UNSAFE", etc.

If the item contains an array then this lookup table shall apply to all elements in the array.

The StatusCode delivered with the value also contains an informational bit called SemanticsChanged. Servers that implement Data Access shall set this Bit in notifications if any of the FalseState or TrueState (changes can cause misinterpretation by users or (scripting) programs) Properties are changed. Clients that use any of these Properties should re-read them before they process the data value.

In addition a server can send SemanticChangeEvents if the value of the Property EnumStrings is changed. To indicate this capability, the SemanticChange flag must be set in the AccessLevel and UserAccessLevel attributes of this variable.

Constructor & Destructor Documentation

UnifiedAutomation.UaServer.TwoStateDiscreteModel.TwoStateDiscreteModel ( )
inline

Initializes a new instance of the TwoStateDiscreteModel class.

UnifiedAutomation.UaServer.TwoStateDiscreteModel.TwoStateDiscreteModel ( TwoStateDiscreteModel  template)
inline

Initializes a new instance of the TwoStateDiscreteModel class.

Parameters
templateThe template.

Property Documentation

LocalizedText UnifiedAutomation.UaServer.TwoStateDiscreteModel.FalseState
getset

Gets or sets the FalseState

FalseState contains a string to be associated with this DataItem when it is FALSE. This is typically used for a contact when it is in the open (zero) state. for example:"STOP","OPEN","DISABLE","UNSAFE", etc.

LocalizedText UnifiedAutomation.UaServer.TwoStateDiscreteModel.TrueState
getset

Gets or sets the TrueState

TrueState contains a string to be associated with this DataItem when it is TRUE. This is typically used for a contact when it is in the closed (non-zero) state. for example:"RUN","CLOSE","ENABLE","SAFE", etc.

new bool UnifiedAutomation.UaServer.TwoStateDiscreteModel.Value
getset

Gets or sets the value.


The documentation for this class was generated from the following file: