Build 1.01.318.0

[This is preliminary documentation and is subject to change.]

The BaseVariableState type exposes the following members.

Constructors

  NameDescription
Public methodBaseVariableState
Initializes the instance with its defalt attribute values.

Methods

  NameDescription
Public methodAddChild
Adds a child to the node.
(Inherited from NodeState.)
Public methodAddNotifier
Adds a notifier relationship to the node.
(Inherited from NodeState.)
Public methodAddProperty<(Of <<'(T>)>>)
Creates a property and adds it to the node.
(Inherited from NodeState.)
Public methodAddReference
Adds a reference.
(Inherited from NodeState.)
Public methodStatic memberApplyIndexRangeAndDataEncoding
Applys the index range and the data encoding to the value.
Public methodAssignNodeIds
Recursively assigns NodeIds to the node and its children.
(Inherited from NodeState.)
Public methodStatic memberCheckTypeBeforeCast<(Of <<'(T>)>>)
Checks the data type of a value before casting it to the type T.
Public methodClearChangeMasks
Clears the change masks.
(Inherited from NodeState.)
Public methodClone
Makes a copy of the node and all children.
(Inherited from NodeState.)
Public methodConditionRefresh
Returns the last event produced for any conditions belonging to the node or its chilren.
(Inherited from NodeState.)
Public methodCreate(ISystemContext, NodeState)
Create an instance by copying another node.
(Inherited from NodeState.)
Public methodCreate(ISystemContext, NodeId, QualifiedName, LocalizedText, Boolean)
Creates a node with default values and assigns new node ids to it and all children.
(Inherited from NodeState.)
Public methodCreateBrowser
Creates a browser for the entity references.
(Inherited from NodeState.)
Public methodCreateChild
Finds or creates the child with the specified browse name.
(Inherited from NodeState.)
Public methodDelete
Deletes an instance and its children (calls OnStateChange callback for each node).
(Inherited from NodeState.)
Public methodDispose()()()()
Frees any unmanaged resources.
(Inherited from NodeState.)
Protected methodDispose(Boolean)
An overrideable version of the Dispose.
(Inherited from NodeState.)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected methodExport(ISystemContext, Node)
Exports a copy of the node to a node node provided the node type is compatible with VariableNode.
(Overrides BaseInstanceState..::..Export(ISystemContext, Node).)
Public methodExport(ISystemContext, NodeTable)
Exports a copy of the node to a node table.
(Inherited from NodeState.)
Protected methodExtractValueFromVariant(Object, Boolean)
If overridden returns the value or extracts the value from ExtensionObject, array of ExtensionObject, or array of Variant. If it is not valid returns its default value.
Public methodStatic memberExtractValueFromVariant<(Of <<'(T>)>>)(Object, Boolean)
If overridden returns the value or extracts the value from: ExtensionObjectarray of ExtensionObjectarray of Variant
Protected methodFinalize
The finializer implementation.
(Inherited from NodeState.)
Public methodFindChild(ISystemContext, QualifiedName)
Finds the child with the specified browse name
(Inherited from NodeState.)
Public methodFindChild(ISystemContext, IList<(Of <<'(QualifiedName>)>>), Int32)
Finds the child with the specified browse path.
(Inherited from NodeState.)
Protected methodFindChild(ISystemContext, QualifiedName, Boolean, BaseInstanceState)
Finds the child with the specified browse name.
(Inherited from NodeState.)
Public methodFindChildBySymbolicName
Finds the child by a path constructed from the symbolic names.
(Inherited from NodeState.)
Public methodFindMethod
Returns the method with the specified NodeId or MethodDeclarationId.
(Inherited from NodeState.)
Public methodGetAttributesToSave
Returns a mask which indicates which attributes have non-default value.
(Overrides BaseInstanceState..::..GetAttributesToSave(ISystemContext).)
Public methodGetAttributeValue
(Inherited from BaseInstanceState.)
Public methodGetChildren
Populates a list with the children that belong to the node.
(Inherited from NodeState.)
Protected methodGetDefaultDataTypeId
If overridden returns the id of the default data type node for the instance.
Protected methodGetDefaultTypeDefinitionId
If overridden returns the id of the default type definition node for the instance.
(Overrides BaseInstanceState..::..GetDefaultTypeDefinitionId(NamespaceTable).)
Protected methodGetDefaultValueRank
If overridden returns the id of the default value rank for the instance.
Public methodGetDisplayPath()()()()
Gets a display path for the node.
(Inherited from BaseInstanceState.)
Public methodGetDisplayPath(Int32, Char)
Gets a display path for the node.
(Inherited from BaseInstanceState.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetHierarchyReferences
Populates a table with all references in the hierarchy.
(Inherited from NodeState.)
Public methodGetHierarchyRoot
Returns the root node if the node is part of an instance hierarchy.
(Inherited from NodeState.)
Public methodGetInstanceHierarchy
Populates a table with all nodes in the hierarchy.
(Inherited from NodeState.)
Public methodGetReferences(ISystemContext, IList<(Of <<'(IReference>)>>))
Populates a list with the non-child related references that belong to the node.
(Inherited from NodeState.)
Public methodGetReferences(ISystemContext, IList<(Of <<'(IReference>)>>), NodeId, Boolean)
Returns any references with the specified reference type and direction.
(Inherited from NodeState.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodStatic memberGetValue<(Of <<'(T>)>>)(BaseDataVariableState<(Of <<'(T>)>>))
Returns the value after checking if the variable is null.
Public methodStatic memberGetValue<(Of <<'(T>)>>)(PropertyState<(Of <<'(T>)>>))
Returns the value after checking if the property is null.
Protected methodInitialize(ISystemContext)
When overridden in a derived class, iinitializes the instance with the default values.
(Inherited from NodeState.)
Protected methodInitialize(ISystemContext, NodeState)
Initializes the instance from another instance.
(Overrides BaseInstanceState..::..Initialize(ISystemContext, NodeState).)
Public methodInitialize(ISystemContext, String)
Initializes the instance with the XML or bnary (array of bytes) representation contained in the string.
(Inherited from NodeState.)
Protected methodInitializeOptionalChildren
When overridden in a derived class, initializes the any option children defined for the instance.
(Inherited from NodeState.)
Public methodIsInView
(Inherited from BaseInstanceState.)
Public methodIsRelatedTo
(Inherited from BaseInstanceState.)
Public methodIsTypeOf
(Inherited from BaseInstanceState.)
Public methodLoadAsBinary
Loads the node from a binary stream.
(Inherited from NodeState.)
Public methodLoadFromXml(ISystemContext, XmlDecoder)
Initializes the node from XML in a stream.
(Inherited from NodeState.)
Public methodLoadFromXml(ISystemContext, Stream)
Initializes the node from XML in a stream.
(Inherited from NodeState.)
Public methodLoadFromXml(ISystemContext, TextReader)
Initializes the node from XML in a stream.
(Inherited from NodeState.)
Public methodLoadFromXml(ISystemContext, XmlReader)
Initializes the node from XML in a stream.
(Inherited from NodeState.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodOnAfterCreate
Called after a node is created.
(Inherited from NodeState.)
Protected methodOnAfterDelete
Called after the object is deleted.
(Inherited from NodeState.)
Protected methodOnBeforeAssignNodeIds
Called before the ids are assigned to the node and its children.
(Inherited from NodeState.)
Protected methodOnBeforeCreate
Called before a node is created.
(Inherited from NodeState.)
Protected methodOnBeforeDelete
Called before the node is deleted.
(Inherited from NodeState.)
Protected methodPopulateBrowser
Populates the browser with references that meet the criteria.
(Inherited from BaseInstanceState.)
Public methodReadAttribute
Reads the value of an attribute.
(Inherited from NodeState.)
Public methodReadAttributes
Reads the values for a set of attributes.
(Inherited from NodeState.)
Public methodReadChildAttribute
Reads the attribute of the child node.
(Inherited from NodeState.)
Protected methodReadNonValueAttribute
Reads the value for any non-value attribute.
(Overrides NodeState..::..ReadNonValueAttribute(ISystemContext, UInt32, Object%).)
Protected methodReadValueAttribute
Reads the value for the value attribute.
(Overrides NodeState..::..ReadValueAttribute(ISystemContext, NumericRange, QualifiedName, Object%, DateTime%).)
Public methodReferenceExists
Returns true if the reference exists.
(Inherited from NodeState.)
Public methodRemoveChild
Adds a child from the node.
(Inherited from NodeState.)
Public methodRemoveNotifier
Removes a notifier relationship from the node.
(Inherited from NodeState.)
Public methodRemoveReference
Removes a reference.
(Inherited from NodeState.)
Public methodReplaceChild
Creates or replaces the child with the same browse name.
(Inherited from NodeState.)
Public methodReportEvent
Sets the flag which indicates whether event are being monitored for the instance and its children.
(Inherited from BaseInstanceState.)
Public methodSave(ISystemContext, XmlEncoder)
Saves the attributes from this instance to the encoder.
(Overrides BaseInstanceState..::..Save(ISystemContext, XmlEncoder).)
Public methodSave(ISystemContext, BinaryEncoder, NodeState..::..AttributesToSave)
Saves object in an binary stream.
(Overrides BaseInstanceState..::..Save(ISystemContext, BinaryEncoder, NodeState..::..AttributesToSave).)
Public methodSaveAsBinary(ISystemContext, BinaryEncoder)
Saves the object in the binary stream.
(Inherited from NodeState.)
Public methodSaveAsBinary(ISystemContext, Stream)
Saves the node in a binary stream.
(Inherited from NodeState.)
Public methodSaveAsXml(ISystemContext, XmlEncoder)
Saves the node as XML in a stream.
(Inherited from NodeState.)
Public methodSaveAsXml(ISystemContext, Stream)
Saves the node as XML in a stream.
(Inherited from NodeState.)
Public methodSaveChildren(ISystemContext, BinaryEncoder)
Saves the children in a binary stream.
(Inherited from NodeState.)
Public methodSaveChildren(ISystemContext, XmlEncoder)
Saves the children from the stream.
(Inherited from NodeState.)
Public methodSaveReferences(ISystemContext, BinaryEncoder)
Saves the reference table in a binary stream.
(Inherited from NodeState.)
Public methodSaveReferences(ISystemContext, XmlEncoder)
Saves a refernce table from an XML stream.
(Inherited from NodeState.)
Public methodSetAreEventsMonitored
Sets the flag which indicates whether event are being monitored for the instance and its children.
(Inherited from NodeState.)
Public methodSetChildValue(ISystemContext, QualifiedName, BaseInstanceState, Boolean)
Finds the child with the specified browse and assigns the values from any variables in the hierachy of the source.
(Inherited from NodeState.)
Public methodSetChildValue(ISystemContext, QualifiedName, Object, Boolean)
Finds the child variable with the specified browse and assigns the value to it.
(Inherited from NodeState.)
Public methodSetMinimumSamplingInterval
Sets the minimum sampling interval for the node an all of its child variables..
(Inherited from BaseInstanceState.)
Public methodSetStatusCode
Recusively sets the status code and timestamp for the node and all child variables.
(Overrides NodeState..::..SetStatusCode(ISystemContext, StatusCode, DateTime).)
Public methodToString()()()()
Returns a string representation of the node.
(Inherited from NodeState.)
Public methodToString(String, IFormatProvider)
Returns a string representation of the node.
(Inherited from NodeState.)
Public methodUpdate(ISystemContext, XmlDecoder)
Updates the attributes from the decoder.
(Overrides BaseInstanceState..::..Update(ISystemContext, XmlDecoder).)
Public methodUpdate(ISystemContext, SimpleAttributeOperandCollection, EventFieldList)
Initializes the instance from an event notification.
(Inherited from BaseInstanceState.)
Public methodUpdate(ISystemContext, BinaryDecoder, NodeState..::..AttributesToSave)
Updates the attributes of this instance from the decoder.
(Overrides BaseInstanceState..::..Update(ISystemContext, BinaryDecoder, NodeState..::..AttributesToSave).)
Public methodUpdateChangeMasks
Sets the specified bits in the change masks (ORs with the current bits).
(Inherited from NodeState.)
Protected methodUpdateChild(ISystemContext, BinaryDecoder)
Reads attributes for the next child found in the stream.
(Inherited from NodeState.)
Protected methodUpdateChild(ISystemContext, XmlDecoder)
Reads attributes for the next child found in the stream.
(Inherited from NodeState.)
Public methodUpdateChildren(ISystemContext, BinaryDecoder)
Loads the children from a binary stream.
(Inherited from NodeState.)
Public methodUpdateChildren(ISystemContext, XmlDecoder)
Reads attributes for the children from the stream.
(Inherited from NodeState.)
Public methodUpdateReferences(ISystemContext, BinaryDecoder)
Loads the reference table from a binary stream.
(Inherited from NodeState.)
Public methodUpdateReferences(ISystemContext, XmlDecoder)
Loads any additional references from the stream.
(Inherited from NodeState.)
Public methodUpdateReferenceTargets
Recursively updates the targets of references.
(Inherited from NodeState.)
Public methodUpdateValues
Updates the node with the values from an event notification.
(Inherited from NodeState.)
Public methodValidate
Verifies that the node represents a valid node.
(Inherited from NodeState.)
Public methodWriteAttribute
Writes the specified attribute value.
(Inherited from NodeState.)
Public methodWriteChildAttribute
Writes the value of the child attribute.
(Inherited from NodeState.)
Protected methodWriteNonValueAttribute
Write the value for any non-value attribute.
(Overrides NodeState..::..WriteNonValueAttribute(ISystemContext, UInt32, Object).)
Protected methodWriteValueAttribute
Write the value for the value attribute.
(Overrides NodeState..::..WriteValueAttribute(ISystemContext, NumericRange, Object, StatusCode, DateTime).)

Fields

  NameDescription
Public fieldOnConditionRefresh
Raised when ClearChangeMasks is called and the ChangeMask is not None.
(Inherited from NodeState.)
Public fieldOnCreateBrowser
Raised after the CreateBrowser method is called.
(Inherited from NodeState.)
Public fieldOnPopulateBrowser
Raised after the PopulateBrowser method is called.
(Inherited from NodeState.)
Public fieldOnReadAccessLevel
Raised when the AccessLevel attribute is read.
Public fieldOnReadArrayDimensions
Raised when the ArrayDimensions attribute is read.
Public fieldOnReadBrowseName
Raised when the BrowseName attribute is read.
(Inherited from NodeState.)
Public fieldOnReadDataType
Raised when the DataType attribute is read.
Public fieldOnReadDescription
Raised when the Description attribute is read.
(Inherited from NodeState.)
Public fieldOnReadDisplayName
Raised when the DisplayName attribute is read.
(Inherited from NodeState.)
Public fieldOnReadHistorizing
Raised when the Historizing attribute is read.
Public fieldOnReadMinimumSamplingInterval
Raised when the MinimumSamplingInterval attribute is read.
Public fieldOnReadNodeClass
Raised when the NodeClass attribute is read.
(Inherited from NodeState.)
Public fieldOnReadNodeId
Raised when the NodeId attribute is read.
(Inherited from NodeState.)
Public fieldOnReadUserAccessLevel
Raised when the UserAccessLevel attribute is read.
Public fieldOnReadUserWriteMask
Raised when the UserWriteMask attribute is read.
(Inherited from NodeState.)
Public fieldOnReadValue
Raised when the Value attribute is read.
Public fieldOnReadValueRank
Raised when the ValueRank attribute is read.
Public fieldOnReadWriteMask
Raised when the WriteMask attribute is read.
(Inherited from NodeState.)
Public fieldOnReportEvent
Raised when a node produces an event that needs to be reported.
(Inherited from NodeState.)
Public fieldOnSimpleReadValue
Raised when the Value attribute is read.
Public fieldOnSimpleWriteValue
Raised when the Value attribute is written.
Public fieldOnStateChanged
Raised when ClearChangeMasks is called and the ChangeMask is not None.
(Inherited from NodeState.)
Public fieldOnValidate
Raised when the Validate method is called
(Inherited from NodeState.)
Public fieldOnWriteAccessLevel
Raised when the AccessLevel attribute is written.
Public fieldOnWriteArrayDimensions
Raised when the ArrayDimensions attribute is written.
Public fieldOnWriteBrowseName
Raised when the BrowseName attribute is written.
(Inherited from NodeState.)
Public fieldOnWriteDataType
Raised when the DataType attribute is written.
Public fieldOnWriteDescription
Raised when the Description attribute is written.
(Inherited from NodeState.)
Public fieldOnWriteDisplayName
Raised when the DisplayName attribute is written.
(Inherited from NodeState.)
Public fieldOnWriteHistorizing
Raised when the Historizing attribute is written.
Public fieldOnWriteMinimumSamplingInterval
Raised when the MinimumSamplingInterval attribute is written.
Public fieldOnWriteNodeClass
Raised when the NodeClass attribute is written.
(Inherited from NodeState.)
Public fieldOnWriteNodeId
Raised when the NodeId attribute is written.
(Inherited from NodeState.)
Public fieldOnWriteUserAccessLevel
Raised when the UserAccessLevel attribute is written.
Public fieldOnWriteUserWriteMask
Raised when the UserWriteMask attribute is written.
(Inherited from NodeState.)
Public fieldOnWriteValue
Raised when the Value attribute is written.
Public fieldOnWriteValueRank
Raised when the ValueRank attribute is written.
Public fieldOnWriteWriteMask
Raised when the WriteMask attribute is written.
(Inherited from NodeState.)

Properties

  NameDescription
Public propertyAccessLevel
The type of access available for the variable.
Public propertyAreEventsMonitored
True if events produced by the instance are being monitored.
(Inherited from NodeState.)
Public propertyArrayDimensions
The number of dimensions for an array values with one or more fixed dimensions.
Public propertyBrowseName
The browse name of the node.
(Inherited from NodeState.)
Public propertyChangeMasks
What has changed in the node since ClearChangeMasks(ISystemContext, Boolean) was last called.
(Inherited from NodeState.)
Public propertyCopyPolicy
The behavoir to use when reading or writing all or part of the object.
Public propertyDataType
The data type for the variable value.
Public propertyDescription
The localized description for the node.
(Inherited from NodeState.)
Public propertyDisplayName
The display name for the node.
(Inherited from NodeState.)
Public propertyHandle
An arbitrary handle associated with the node.
(Inherited from NodeState.)
Public propertyHistorizing
Whether the server is archiving the value of the variable.
Public propertyInitialized
True if the node and its children have been initialized.
(Inherited from NodeState.)
Public propertyIsValueType
Whether the value can be set to null.
Public propertyMinimumSamplingInterval
The minimum sampling interval supported by the variable.
Public propertyModellingRuleId
The modelling rule assigned to the instance.
(Inherited from BaseInstanceState.)
Public propertyNodeClass
The class for the node.
(Inherited from NodeState.)
Public propertyNodeId
The identifier for the node.
(Inherited from NodeState.)
Public propertyNumericId
A numeric identifier for the instance that is unique within the parent.
(Inherited from BaseInstanceState.)
Public propertyParent
The parent node.
(Inherited from BaseInstanceState.)
Public propertyReferenceTypeId
The type of reference from the parent node to the instance.
(Inherited from BaseInstanceState.)
Public propertyStatusCode
The status code associated with the variable value.
Public propertySymbolicName
A symbolic name for the node that is not expected to be globally unique.
(Inherited from NodeState.)
Public propertyTimestamp
The timestamp associated with the variable value.
Public propertyTypeDefinitionId
The identifier for the type definition node.
(Inherited from BaseInstanceState.)
Public propertyUserAccessLevel
The type of access granted to the current user.
Public propertyUserWriteMask
Specifies which attributes are writeable for the current user.
(Inherited from NodeState.)
Public propertyValidationRequired
True if the node must be validated with the underlying system before use.
(Inherited from NodeState.)
Public propertyValue
The value of the variable.
Public propertyValueRank
The number of array dimensions permitted for the variable value.
Public propertyWrappedValue
The value of the variable as a Variant.
Public propertyWriteMask
Specifies which attributes are writeable.
(Inherited from NodeState.)

See Also