Build 1.01.318.0
[This is preliminary documentation and is subject to change.]
The BaseObjectState type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
| BaseObjectState |
Initializes the instance with its defalt attribute values.
|
Methods
| Name | Description | |
|---|---|---|
| AddChild |
Adds a child to the node.
(Inherited from NodeState.) | |
| AddNotifier |
Adds a notifier relationship to the node.
(Inherited from NodeState.) | |
| AddProperty<(Of <<'(T>)>>) |
Creates a property and adds it to the node.
(Inherited from NodeState.) | |
| AddReference |
Adds a reference.
(Inherited from NodeState.) | |
| AssignNodeIds |
Recursively assigns NodeIds to the node and its children.
(Inherited from NodeState.) | |
| ClearChangeMasks |
Clears the change masks.
(Inherited from NodeState.) | |
| Clone |
Makes a copy of the node and all children.
(Inherited from NodeState.) | |
| ConditionRefresh |
Returns the last event produced for any conditions belonging to the node or its chilren.
(Inherited from NodeState.) | |
| Construct |
Constructs an instance of a node.
| |
| Create(ISystemContext, NodeState) |
Create an instance by copying another node.
(Inherited from NodeState.) | |
| Create(ISystemContext, NodeId, QualifiedName, LocalizedText, Boolean) |
Creates a node with default values and assigns new node ids to it and all children.
(Inherited from NodeState.) | |
| CreateBrowser |
Creates a browser for the entity references.
(Inherited from NodeState.) | |
| CreateChild |
Finds or creates the child with the specified browse name.
(Inherited from NodeState.) | |
| Delete |
Deletes an instance and its children (calls OnStateChange callback for each node).
(Inherited from NodeState.) | |
| Dispose()()()() |
Frees any unmanaged resources.
(Inherited from NodeState.) | |
| Dispose(Boolean) |
An overrideable version of the Dispose.
(Inherited from NodeState.) | |
| Equals | (Inherited from Object.) | |
| Export(ISystemContext, Node) |
Exports a copt of the node to a node table.
(Overrides BaseInstanceState..::..Export(ISystemContext, Node).) | |
| Export(ISystemContext, NodeTable) |
Exports a copy of the node to a node table.
(Inherited from NodeState.) | |
| Finalize |
The finializer implementation.
(Inherited from NodeState.) | |
| FindChild(ISystemContext, QualifiedName) |
Finds the child with the specified browse name
(Inherited from NodeState.) | |
| FindChild(ISystemContext, IList<(Of <<'(QualifiedName>)>>), Int32) |
Finds the child with the specified browse path.
(Inherited from NodeState.) | |
| FindChild(ISystemContext, QualifiedName, Boolean, BaseInstanceState) |
Finds the child with the specified browse name.
(Inherited from NodeState.) | |
| FindChildBySymbolicName |
Finds the child by a path constructed from the symbolic names.
(Inherited from NodeState.) | |
| FindMethod |
Returns the method with the specified NodeId or MethodDeclarationId.
(Inherited from NodeState.) | |
| GetAttributesToSave |
Returns a mask which indicates which attributes have non-default value.
(Overrides BaseInstanceState..::..GetAttributesToSave(ISystemContext).) | |
| GetAttributeValue | (Inherited from BaseInstanceState.) | |
| GetChildren |
Populates a list with the children that belong to the node.
(Inherited from NodeState.) | |
| GetDefaultTypeDefinitionId |
Returns the id of the default type definition node for the instance.
(Overrides BaseInstanceState..::..GetDefaultTypeDefinitionId(NamespaceTable).) | |
| GetDisplayPath()()()() |
Gets a display path for the node.
(Inherited from BaseInstanceState.) | |
| GetDisplayPath(Int32, Char) |
Gets a display path for the node.
(Inherited from BaseInstanceState.) | |
| GetHashCode |
Serves as a hash function for a particular type.
(Inherited from Object.) | |
| GetHierarchyReferences |
Populates a table with all references in the hierarchy.
(Inherited from NodeState.) | |
| GetHierarchyRoot |
Returns the root node if the node is part of an instance hierarchy.
(Inherited from NodeState.) | |
| GetInstanceHierarchy |
Populates a table with all nodes in the hierarchy.
(Inherited from NodeState.) | |
| GetReferences(ISystemContext, IList<(Of <<'(IReference>)>>)) |
Populates a list with the non-child related references that belong to the node.
(Inherited from NodeState.) | |
| GetReferences(ISystemContext, IList<(Of <<'(IReference>)>>), NodeId, Boolean) |
Returns any references with the specified reference type and direction.
(Inherited from NodeState.) | |
| GetType |
Gets the Type of the current instance.
(Inherited from Object.) | |
| Initialize(ISystemContext) |
Initializes the instance with the default values.
(Overrides NodeState..::..Initialize(ISystemContext).) | |
| Initialize(ISystemContext, NodeState) |
Initializes the instance from another instance.
(Overrides BaseInstanceState..::..Initialize(ISystemContext, NodeState).) | |
| Initialize(ISystemContext, String) |
Initializes the instance with the XML or bnary (array of bytes) representation contained in the string.
(Inherited from NodeState.) | |
| InitializeOptionalChildren |
When overridden in a derived class, initializes the any option children defined for the instance.
(Inherited from NodeState.) | |
| IsInView | (Inherited from BaseInstanceState.) | |
| IsRelatedTo | (Inherited from BaseInstanceState.) | |
| IsTypeOf | (Inherited from BaseInstanceState.) | |
| LoadAsBinary |
Loads the node from a binary stream.
(Inherited from NodeState.) | |
| LoadFromXml(ISystemContext, XmlDecoder) |
Initializes the node from XML in a stream.
(Inherited from NodeState.) | |
| LoadFromXml(ISystemContext, Stream) |
Initializes the node from XML in a stream.
(Inherited from NodeState.) | |
| LoadFromXml(ISystemContext, TextReader) |
Initializes the node from XML in a stream.
(Inherited from NodeState.) | |
| LoadFromXml(ISystemContext, XmlReader) |
Initializes the node from XML in a stream.
(Inherited from NodeState.) | |
| MemberwiseClone |
Creates a shallow copy of the current Object.
(Inherited from Object.) | |
| OnAfterCreate |
Called after a node is created.
(Inherited from NodeState.) | |
| OnAfterDelete |
Called after the object is deleted.
(Inherited from NodeState.) | |
| OnBeforeAssignNodeIds |
Called before the ids are assigned to the node and its children.
(Inherited from NodeState.) | |
| OnBeforeCreate |
Called before a node is created.
(Inherited from NodeState.) | |
| OnBeforeDelete |
Called before the node is deleted.
(Inherited from NodeState.) | |
| PopulateBrowser |
Populates the browser with references that meet the criteria.
(Inherited from BaseInstanceState.) | |
| ReadAttribute |
Reads the value of an attribute.
(Inherited from NodeState.) | |
| ReadAttributes |
Reads the values for a set of attributes.
(Inherited from NodeState.) | |
| ReadChildAttribute |
Reads the attribute of the child node.
(Inherited from NodeState.) | |
| ReadNonValueAttribute |
Reads the value for any non-value attribute.
(Overrides NodeState..::..ReadNonValueAttribute(ISystemContext, UInt32, Object%).) | |
| ReadValueAttribute |
When overridden in a derived class, iReads the value for the value attribute.
(Inherited from NodeState.) | |
| ReferenceExists |
Returns true if the reference exists.
(Inherited from NodeState.) | |
| RemoveChild |
Adds a child from the node.
(Inherited from NodeState.) | |
| RemoveNotifier |
Removes a notifier relationship from the node.
(Inherited from NodeState.) | |
| RemoveReference |
Removes a reference.
(Inherited from NodeState.) | |
| ReplaceChild |
Creates or replaces the child with the same browse name.
(Inherited from NodeState.) | |
| ReportEvent |
Sets the flag which indicates whether event are being monitored for the instance and its children.
(Inherited from BaseInstanceState.) | |
| Save(ISystemContext, XmlEncoder) |
Saves the attributes from the stream.
(Overrides BaseInstanceState..::..Save(ISystemContext, XmlEncoder).) | |
| Save(ISystemContext, BinaryEncoder, NodeState..::..AttributesToSave) |
Saves object in an binary stream.
(Overrides BaseInstanceState..::..Save(ISystemContext, BinaryEncoder, NodeState..::..AttributesToSave).) | |
| SaveAsBinary(ISystemContext, BinaryEncoder) |
Saves the object in the binary stream.
(Inherited from NodeState.) | |
| SaveAsBinary(ISystemContext, Stream) |
Saves the node in a binary stream.
(Inherited from NodeState.) | |
| SaveAsXml(ISystemContext, XmlEncoder) |
Saves the node as XML in a stream.
(Inherited from NodeState.) | |
| SaveAsXml(ISystemContext, Stream) |
Saves the node as XML in a stream.
(Inherited from NodeState.) | |
| SaveChildren(ISystemContext, BinaryEncoder) |
Saves the children in a binary stream.
(Inherited from NodeState.) | |
| SaveChildren(ISystemContext, XmlEncoder) |
Saves the children from the stream.
(Inherited from NodeState.) | |
| SaveReferences(ISystemContext, BinaryEncoder) |
Saves the reference table in a binary stream.
(Inherited from NodeState.) | |
| SaveReferences(ISystemContext, XmlEncoder) |
Saves a refernce table from an XML stream.
(Inherited from NodeState.) | |
| SetAreEventsMonitored |
Sets the flag which indicates whether event are being monitored for the instance and its children.
(Inherited from NodeState.) | |
| SetChildValue(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.) | |
| SetChildValue(ISystemContext, QualifiedName, Object, Boolean) |
Finds the child variable with the specified browse and assigns the value to it.
(Inherited from NodeState.) | |
| SetMinimumSamplingInterval |
Sets the minimum sampling interval for the node an all of its child variables..
(Inherited from BaseInstanceState.) | |
| SetStatusCode |
Recusively sets the status code and timestamp for the node and all child variables.
(Inherited from NodeState.) | |
| ToString()()()() |
Returns a string representation of the node.
(Inherited from NodeState.) | |
| ToString(String, IFormatProvider) |
Returns a string representation of the node.
(Inherited from NodeState.) | |
| Update(ISystemContext, XmlDecoder) |
Updates the attributes from the stream.
(Overrides BaseInstanceState..::..Update(ISystemContext, XmlDecoder).) | |
| Update(ISystemContext, SimpleAttributeOperandCollection, EventFieldList) |
Initializes the instance from an event notification.
(Inherited from BaseInstanceState.) | |
| Update(ISystemContext, BinaryDecoder, NodeState..::..AttributesToSave) |
Updates the specified context.
(Overrides BaseInstanceState..::..Update(ISystemContext, BinaryDecoder, NodeState..::..AttributesToSave).) | |
| UpdateChangeMasks |
Sets the specified bits in the change masks (ORs with the current bits).
(Inherited from NodeState.) | |
| UpdateChild(ISystemContext, BinaryDecoder) |
Reads attributes for the next child found in the stream.
(Inherited from NodeState.) | |
| UpdateChild(ISystemContext, XmlDecoder) |
Reads attributes for the next child found in the stream.
(Inherited from NodeState.) | |
| UpdateChildren(ISystemContext, BinaryDecoder) |
Loads the children from a binary stream.
(Inherited from NodeState.) | |
| UpdateChildren(ISystemContext, XmlDecoder) |
Reads attributes for the children from the stream.
(Inherited from NodeState.) | |
| UpdateReferences(ISystemContext, BinaryDecoder) |
Loads the reference table from a binary stream.
(Inherited from NodeState.) | |
| UpdateReferences(ISystemContext, XmlDecoder) |
Loads any additional references from the stream.
(Inherited from NodeState.) | |
| UpdateReferenceTargets |
Recursively updates the targets of references.
(Inherited from NodeState.) | |
| UpdateValues |
Updates the node with the values from an event notification.
(Inherited from NodeState.) | |
| Validate |
Verifies that the node represents a valid node.
(Inherited from NodeState.) | |
| WriteAttribute |
Writes the specified attribute value.
(Inherited from NodeState.) | |
| WriteChildAttribute |
Writes the value of the child attribute.
(Inherited from NodeState.) | |
| WriteNonValueAttribute |
Write the value for any non-value attribute.
(Overrides NodeState..::..WriteNonValueAttribute(ISystemContext, UInt32, Object).) | |
| WriteValueAttribute |
Write the value for the value attribute.
(Inherited from NodeState.) |
Fields
| Name | Description | |
|---|---|---|
| OnConditionRefresh |
Raised when ClearChangeMasks is called and the ChangeMask is not None.
(Inherited from NodeState.) | |
| OnCreateBrowser |
Raised after the CreateBrowser method is called.
(Inherited from NodeState.) | |
| OnPopulateBrowser |
Raised after the PopulateBrowser method is called.
(Inherited from NodeState.) | |
| OnReadBrowseName |
Raised when the BrowseName attribute is read.
(Inherited from NodeState.) | |
| OnReadDescription |
Raised when the Description attribute is read.
(Inherited from NodeState.) | |
| OnReadDisplayName |
Raised when the DisplayName attribute is read.
(Inherited from NodeState.) | |
| OnReadEventNotifier |
Raised when the EventNotifier attribute is read.
| |
| OnReadNodeClass |
Raised when the NodeClass attribute is read.
(Inherited from NodeState.) | |
| OnReadNodeId |
Raised when the NodeId attribute is read.
(Inherited from NodeState.) | |
| OnReadUserWriteMask |
Raised when the UserWriteMask attribute is read.
(Inherited from NodeState.) | |
| OnReadWriteMask |
Raised when the WriteMask attribute is read.
(Inherited from NodeState.) | |
| OnReportEvent |
Raised when a node produces an event that needs to be reported.
(Inherited from NodeState.) | |
| OnStateChanged |
Raised when ClearChangeMasks is called and the ChangeMask is not None.
(Inherited from NodeState.) | |
| OnValidate |
Raised when the Validate method is called
(Inherited from NodeState.) | |
| OnWriteBrowseName |
Raised when the BrowseName attribute is written.
(Inherited from NodeState.) | |
| OnWriteDescription |
Raised when the Description attribute is written.
(Inherited from NodeState.) | |
| OnWriteDisplayName |
Raised when the DisplayName attribute is written.
(Inherited from NodeState.) | |
| OnWriteEventNotifier |
Raised when the EventNotifier attribute is written.
| |
| OnWriteNodeClass |
Raised when the NodeClass attribute is written.
(Inherited from NodeState.) | |
| OnWriteNodeId |
Raised when the NodeId attribute is written.
(Inherited from NodeState.) | |
| OnWriteUserWriteMask |
Raised when the UserWriteMask attribute is written.
(Inherited from NodeState.) | |
| OnWriteWriteMask |
Raised when the WriteMask attribute is written.
(Inherited from NodeState.) |
Properties
| Name | Description | |
|---|---|---|
| AreEventsMonitored |
True if events produced by the instance are being monitored.
(Inherited from NodeState.) | |
| BrowseName |
The browse name of the node.
(Inherited from NodeState.) | |
| ChangeMasks |
What has changed in the node since ClearChangeMasks(ISystemContext, Boolean) was last called.
(Inherited from NodeState.) | |
| Description |
The localized description for the node.
(Inherited from NodeState.) | |
| DisplayName |
The display name for the node.
(Inherited from NodeState.) | |
| EventNotifier |
The inverse name for the reference.
| |
| Handle |
An arbitrary handle associated with the node.
(Inherited from NodeState.) | |
| Initialized |
True if the node and its children have been initialized.
(Inherited from NodeState.) | |
| ModellingRuleId |
The modelling rule assigned to the instance.
(Inherited from BaseInstanceState.) | |
| NodeClass |
The class for the node.
(Inherited from NodeState.) | |
| NodeId |
The identifier for the node.
(Inherited from NodeState.) | |
| NumericId |
A numeric identifier for the instance that is unique within the parent.
(Inherited from BaseInstanceState.) | |
| Parent |
The parent node.
(Inherited from BaseInstanceState.) | |
| ReferenceTypeId |
The type of reference from the parent node to the instance.
(Inherited from BaseInstanceState.) | |
| SymbolicName |
A symbolic name for the node that is not expected to be globally unique.
(Inherited from NodeState.) | |
| TypeDefinitionId |
The identifier for the type definition node.
(Inherited from BaseInstanceState.) | |
| UserWriteMask |
Specifies which attributes are writeable for the current user.
(Inherited from NodeState.) | |
| ValidationRequired |
True if the node must be validated with the underlying system before use.
(Inherited from NodeState.) | |
| WriteMask |
Specifies which attributes are writeable.
(Inherited from NodeState.) |