Book Creator
 Add this page to your book
Book Creator
 Remove this page from your book  

 Manage book (0 page(s))
 Help

OpcFileNode Class

Namespace: Opc.UaFx
Assemblies: Opc.UaFx.Advanced.dll

Defines a file node.

C# 

[OpcNodeType(11575)]
public class OpcFileNode : OpcObjectNode, IOpcNode, IOpcNodeInfo


Inheritance Object › OpcNode › OpcInstanceNode › OpcObjectNode › OpcFileNode


Attributes OpcNodeTypeAttribute


Implements IOpcNode, IOpcNodeInfo

Remarks

The file node uses the type definition FileType.

Constructors

Name Description
OpcFileNode(FileState) Initializes a new instance of the OpcFileNode class using the content as the instance to wrap.
OpcFileNode(FileState, OpcNodeModel) Initializes a new instance of the OpcFileNode class using the content as the instance to wrap.
OpcFileNode(IOpcNode, OpcName, FileInfo) Initializes a new instance of the OpcFileNode class accessible by the name specified with the file to represent defined by fileInfo as a child node of the parent node given.
OpcFileNode(IOpcNode, OpcName, IOpcFileInfo) Initializes a new instance of the OpcFileNode class accessible by the name specified with the file to represent defined by fileInfo as a child node of the parent node given.
OpcFileNode(IOpcNode, OpcName, OpcNodeId, FileInfo) Initializes a new instance of the OpcFileNode class accessible by the name and id specified with the file information defined by fileInfo as a child node of the parent node given.
OpcFileNode(IOpcNode, OpcName, OpcNodeId, IOpcFileInfo) Initializes a new instance of the OpcFileNode class accessible by the name and id specified with the file information defined by fileInfo as a child node of the parent node given.
OpcFileNode(IOpcNode, OpcName, OpcNodeId, String) Initializes a new instance of the OpcFileNode class accessible by the name and id specified with the file information defined by filePath as a child node of the parent node given.
OpcFileNode(IOpcNode, OpcName, String) Initializes a new instance of the OpcFileNode class accessible by the name specified with the file to represent defined by filePath as a child node of the parent node given.
OpcFileNode(OpcName, FileInfo) Initializes a new instance of the OpcFileNode class accessible by the name specified with the file to represent given by fileInfo.
OpcFileNode(OpcName, IOpcFileInfo) Initializes a new instance of the OpcFileNode class accessible by the name specified with the file to represent given by fileInfo.
OpcFileNode(OpcName, OpcNodeId, FileInfo) Initializes a new instance of the OpcFileNode class accessible by the name and id specified with the file to represent given by fileInfo.
OpcFileNode(OpcName, OpcNodeId, IOpcFileInfo) Initializes a new instance of the OpcFileNode class accessible by the name and id specified with the file to represent given by fileInfo.
OpcFileNode(OpcName, OpcNodeId, String) Initializes a new instance of the OpcFileNode class accessible by the name and id specified with the file to represent given by filePath.
OpcFileNode(OpcName, String) Initializes a new instance of the OpcFileNode class accessible by the name specified with the file to represent given by filePath.
OpcFileNode(OpcNodeModel, IOpcNode, OpcName, IOpcFileInfo) Initializes a new instance of the OpcFileNode class accessible by the name specified with the file to represent defined by fileInfo as a child node of the parent node given.
OpcFileNode(OpcNodeModel, IOpcNode, OpcName, OpcNodeId, IOpcFileInfo) Initializes a new instance of the OpcFileNode class accessible by the name and id specified with the file information defined by fileInfo as a child node of the parent node given.
OpcFileNode(OpcNodeModel, OpcName, IOpcFileInfo) Initializes a new instance of the OpcFileNode class accessible by the name specified with the file to represent given by fileInfo.
OpcFileNode(OpcNodeModel, OpcName, OpcNodeId, IOpcFileInfo) Initializes a new instance of the OpcFileNode class accessible by the name and id specified with the file to represent given by fileInfo.

Events

Name Description
AfterAdded Occurs after the node has been added to the address space.
(Inherited from OpcNode)
AfterApplyChanges Occurs after one or more changes on the node has been notified.
(Inherited from OpcNode)
BeforeAdded Occurs before the node is added to the address space.
(Inherited from OpcNode)
BeforeApplyChanges Occurs before one or more changes on the node are notified.
(Inherited from OpcNode)
ChangesUnhandled Occurs when changes applied with ApplyChanges(OpcContext) are not monitored or discarded by all monitored items.
(Inherited from OpcNode)

Properties

Name Description
CanUserWrite Gets or sets a value indicating whether by default a user can access the file represented for writing taking user access rights into account.
CanUserWriteNode Gets the OpcPropertyNode´1 of the CanUserWrite property.
CanWrite Gets or sets a value indicating whether the file is writable. It does not take any user access rights into account, i.e. although the file is writable this may be restricted to a certain user / user group.
CanWriteNode Gets the OpcPropertyNode´1 of the CanWrite property.
Category Gets the NodeCategoryOpcAttribute which identifies the kind of node and is therefore used to classify the node regarding its use and purpose.
(Inherited from OpcNode)
CloseNode Gets the OpcFileCloseMethodNode used to handle 'Close' method calls to close the file represented.
DefaultReferenceTypeId Gets the default identifier which identifies the type that defines the underlying node reference within this OpcInstanceNode is referenced by its parent node.
(Inherited from OpcInstanceNode)
DefaultReferenceTypeId Gets the default identifier which identifies the type that defines the underlying node reference within this OpcInstanceNode is referenced by its parent node.
(Inherited from OpcObjectNode)
DefaultTypeDefinitionId Gets the default identifier which identifies the node that defines the underlying node type from that this OpcInstanceNode has been created.
DefaultTypeDefinitionId Gets the default identifier which identifies the node that defines the underlying node type from that this OpcInstanceNode has been created.
(Inherited from OpcInstanceNode)
DefaultTypeDefinitionId Gets the default identifier which identifies the node that defines the underlying node type from that this OpcInstanceNode has been created.
(Inherited from OpcObjectNode)
Description Gets or sets the value of the optional DescriptionOpcAttribute which shall explain the meaning of the node.
(Inherited from OpcNode)
Descriptions Gets the OpcNodeGlobalization instance used to control the localization and other globalization related tasks for the Description attribute of the current node.
(Inherited from OpcNode)
DisplayName Gets or sets the value of the DisplayNameOpcAttribute which defines the localizable name of the node.
(Inherited from OpcNode)
DisplayNames Gets the OpcNodeGlobalization instance used to control the localization and other globalization related tasks for the DisplayName attribute of the current node.
(Inherited from OpcNode)
File Gets the IOpcFileInfo used to access the file represented.
FileInfo Gets the FileInfo of the file represented.
GetPositionNode Gets the OpcFileGetPositionMethodNode used to handle 'GetPosition' method calls to query the position in the file represented.
HasPendingChanges Gets a value indiciating whether there exists any pending change on the node.
(Inherited from OpcNode)
Id Gets the value of the NodeIdOpcAttribute which unambiguously identifies the node.
(Inherited from OpcNode)
MimeType Gets the media type of the file.
MimeTypeNode Gets the OpcPropertyNode´1 of the MimeType property.
Model Gets the OpcNodeModel which has been used to model this OpcNode regarding its whole representation in the address space.
(Inherited from OpcNode)
ModellingRuleId Gets or sets the identifier which defines how the OpcInstanceNode is used for instantiation.
(Inherited from OpcInstanceNode)
Name Gets or sets the value of the BrowseNameOpcAttribute which defines the non-localizable human-readable name used when browsing the address space.
(Inherited from OpcNode)
Namespace (Inherited from OpcNode)
OpenCount Gets the number of currently valid file handles on the file.
OpenCountNode Gets the OpcPropertyNode´1 of the OpenCount property.
OpenNode Gets the OpcFileOpenMethodNode used to handle 'Open' method calls to open the file represented.
Parent Gets the parent node of the node.
(Inherited from OpcNode)
Parent Gets the parent node of the node.
(Inherited from OpcInstanceNode)
PendingChanges Gets a value indicating the most recent changes performed on the node since their last notification.
(Inherited from OpcNode)
QueryEventsCallback Gets or sets a callback used to query any event information which belongs to the node.
(Inherited from OpcNode)
ReadDescriptionCallback (Inherited from OpcNode)
ReadDisplayNameCallback (Inherited from OpcNode)
ReadNode Gets the OpcFileReadMethodNode used to handle 'Read' method calls to read data from the file represented.
ReadUserWriteAccessCallback (Inherited from OpcNode)
ReadWriteAccessCallback (Inherited from OpcNode)
ReferenceType Gets a value which defines a pre-defined used ReferenceTypeId as one of the members defined by the OpcReferenceType enumeration to simplify querying standard reference types.
(Inherited from OpcInstanceNode)
ReferenceTypeId Gets or sets the identifier which identifies the node that defines the semantic of the reference between a source and a target node and generally reflects an operation between the two, such as “A contains B”.
(Inherited from OpcInstanceNode)
SetPositionNode Gets the OpcFileSetPositionMethodNode used to handle 'SetPosition' method calls to update the position in the file represented.
Size Gets the size of the file in bytes.
SizeNode Gets the OpcPropertyNode´1 of the Size property.
SymbolicName (Inherited from OpcNode)
Tag Gets or sets the object that contains additional user data about the node.
(Inherited from OpcNode)
TypeDefinitionId Gets or sets the identifier which identifies the node that defines the underlying node type from that this OpcInstanceNode has been created.
(Inherited from OpcInstanceNode)
UserWriteAccess Gets or sets the value of the optional UserWriteAccessOpcAttribute which exposes the possibilities of a client to write the attributes of the node taking user access rights into account.
(Inherited from OpcNode)
WriteAccess Gets or sets the value of the optional WriteAccessOpcAttribute which exposes the posibilities of a client to write the attributes of the node.
(Inherited from OpcNode)
WriteDescriptionCallback (Inherited from OpcNode)
WriteDisplayNameCallback (Inherited from OpcNode)
WriteNode Gets the OpcFileWriteMethodNode used to handle 'Write' method calls to write data to the file represented.
WriteUserWriteAccessCallback (Inherited from OpcNode)
WriteWriteAccessCallback (Inherited from OpcNode)

Methods

Name Description
AddChild(OpcContext, OpcInstanceNode) (Inherited from OpcInstanceNode)
AddNotifier(OpcContext, IOpcNode) When implemented in a subtype, adds the node to the collection of notifiers (= event sources) of this node.
(Inherited from OpcNode)
AddNotifier(OpcContext, IOpcNode) Adds the node to the collection of notifiers (= event sources) of this node.
(Inherited from OpcObjectNode)
ApplyChanges(OpcContext) Notifies about changes performed on the node since the last notification and resets the pending changes to None.
(Inherited from OpcNode)
ApplyChanges(OpcContext, Boolean) Notifies about changes performed on the node (and optionally on its children) since the last notification and resets the pending changes to None.
(Inherited from OpcNode)
AttributeValue(OpcAttribute) Retrieves the value of the attribute specified.
(Inherited from OpcNode)
AttributeValue``1(OpcAttribute) Retrieves the value of the attribute specified.
(Inherited from OpcNode)
Child(OpcContext, OpcName) Retrieves the child node its Name property matches exactly the name specified.
(Inherited from OpcNode)
ChildModel(OpcName) (Inherited from OpcNode)
ChildModellingDirective(OpcName) (Inherited from OpcNode)
Children(OpcContext) Retrieves a sequence of all nodes organized as children of this node.
(Inherited from OpcNode)
Close(OpcContext, UInt32) Closes the file represented. When a client closes a file the handle becomes invalid.
DefineModel``1(OpcModellingRule, OpcNamePath) Defines a model rule for the model of the node type specified by T using the rule which is to be applied to the node known under the path passed.
(Inherited from OpcNode)
DefineModel``1(OpcModellingRule, OpcName) Defines a model rule for the model of the node type specified by T using the rule which is to be applied to the node known under the pathElements passed.
(Inherited from OpcNode)
GetNodeValue``1(OpcName) (Inherited from OpcInstanceNode)
GetNodeValue``1(String) (Inherited from OpcInstanceNode)
GetPosition(OpcContext, UInt32) GetPosition is used to provide the current position of the file handle.
GetType(OpcNodeId) Retrieves the Type which implementes the node type which is identified by the typeId specified.
(Inherited from OpcNode)
GetTypeInfo(OpcNodeId) Retrieves the OpcNodeTypeInfo which declares the node type which is identified by the typeId specified.
(Inherited from OpcNode)
GetTypeInfo(Type) Retrieves the OpcNodeTypeInfo which declares the node type implemented by the underlyingType specified.
(Inherited from OpcNode)
GetTypeInfo``1 Retrieves the OpcNodeTypeInfo which declares the node type implemented by the T specified.
(Inherited from OpcNode)
Implement(OpcContext) Performs node specific implementation tasks to finalize the node creation before it can be used for the first time.
(Inherited from OpcNode)
InitializeDefaults Initializes the default values used by the OpcFileNode.
InitializeDefaults Initializes the default values used by the node implementation represented / required.
(Inherited from OpcNode)
InitializeDefaults Initializes the default values used by the OpcInstanceNode.
(Inherited from OpcInstanceNode)
IsChangePending(OpcNodeChanges) (Inherited from OpcNode)
OnAfterAdded(OpcNodeAddedEventArgs) Raises the AfterAdded event using the event data specified.
(Inherited from OpcNode)
OnAfterApplyChanges(OpcNodeChangesEventArgs) Raises the AfterApplyChanges event using the event data specified.
(Inherited from OpcNode)
OnBeforeAdded(OpcNodeAddedEventArgs) Raises the BeforeAdded event using the event data specified.
(Inherited from OpcNode)
OnBeforeApplyChanges(OpcNodeChangesEventArgs) Raises the BeforeApplyChanges event using the event data specified.
(Inherited from OpcNode)
OnChangesUnhandled(OpcNodeChangesEventArgs) Raises the ChangesUnhandled event using the event data specified.
(Inherited from OpcNode)
Open(OpcContext, OpcFileMode) Opens the file represented. When a client opens a file it gets a file handle that is valid while the session is open. Clients shall use the Close Method to release the file handle when they do not need access to the file anymore. Clients can open the same file several times for read.
QueryEventsCore(OpcNodeContext, OpcEventCollection) (Inherited from OpcNode)
Read(OpcContext, UInt32, Int32) Read is used to read a part of the file starting from the current file position. The file position is advanced by the number of bytes read.
ReadAttributeValueCore``1(OpcReadAttributeValueContext, OpcAttributeValue) (Inherited from OpcNode)
ReadCanUserWrite(OpcReadPropertyValueContext, OpcPropertyValue) Reads the value of the CanUserWrite property.
ReadCanWrite(OpcReadPropertyValueContext, OpcPropertyValue) Reads the value of the CanWrite property.
References Retrieves a sequence of immutable references between this node and other nodes.
(Inherited from OpcNode)
RegisterType(Type) Registers the nodeType specified as the node object type to create in case there a node instance is to be created for the type node identified by the OpcNodeTypeAttribute defined on the nodeType specified.
(Inherited from OpcNode)
RegisterType(Type, OpcNodeId) Registers the nodeType specified as the node object type to create in case there a node instance is to be created for the type node identified by the nodeTypeId specified.
(Inherited from OpcNode)
RegisterType``1 Registers the type defined by T as the node object type to create in case there a node instance is to be created for the type definition identified by the OpcNodeTypeAttribute defined on the T specified.
(Inherited from OpcNode)
RegisterType``1(OpcNodeId) Registers the type defined by T as the node object type to create in case there a node instance is to be created for the type definition identified by the nodeTypeId specified.
(Inherited from OpcNode)
RegisterTypes(Assembly) Registers all non-abstract types in the assembly specified which defines the OpcNodeTypeAttribute.
(Inherited from OpcNode)
RegisterTypes(IEnumerable) Registers the nodeTypes specified as the node object type to create in case there a node instance is to be created for the type nodes identified by the OpcEventTypeAttribute used on one of the nodeTypes specified.
(Inherited from OpcNode)
RegisterTypes(Type, Type) Registers the nodeType and the further specified nodeTypes as the node object type to create in case there a node instance is to be created for the type node identified by the OpcNodeTypeAttribute used on the nodeType or on one of the nodeTypes specified.
(Inherited from OpcNode)
RemoveChild(OpcContext, OpcInstanceNode) (Inherited from OpcInstanceNode)
RemoveNotifier(OpcContext, IOpcNode) Removes the node from the collection of notifiers (= event sources) of this node.
(Inherited from OpcNode)
RemoveNotifier(OpcContext, IOpcNode) Removes the node from the collection of notifiers (= event sources) of this node.
(Inherited from OpcInstanceNode)
RemoveNotifier(OpcContext, IOpcNode) Removes the node from the collection of notifiers (= event sources) of this node.
(Inherited from OpcObjectNode)
ReportEvent(OpcContext, OpcEvent) Reports the eventData specified to all nodes this OpcNode is a notifier of.
(Inherited from OpcNode)
ResumeModelChangeEvents(Boolean) Resumes model change tracking and events for this OpcNode and optionally for all children.
(Inherited from OpcNode)
SetNodeValue``1(OpcName, 0) (Inherited from OpcInstanceNode)
SetNodeValue``1(String, 0) (Inherited from OpcInstanceNode)
SetPosition(OpcContext, UInt32, UInt64) SetPosition is used to set the current position of the file handle.
SuspendModelChangeEvents(Boolean) Temporarily suspends model change tracking and events for this OpcNode and optionally for all children.
(Inherited from OpcNode)
UnregisterType``1 Unregisters the previously registered (see RegisterType´´1) type defined by T as the Object type to not longer create for the type node identified by the OpcNodeTypeAttribute defined on the T specified.
(Inherited from OpcNode)
UnregisterType``1(OpcNodeId) Unregisters the previously registered (see RegisterType´´1(OpcNodeId)) type defined by T as the Object type to not longer create for the type node identified by the nodeTypeId specified.
(Inherited from OpcNode)
UnregisterTypes(Assembly) Unregisters all previously registered types (see RegisterTypes(Assembly)) in the assembly specified.
(Inherited from OpcNode)
UnregisterTypes(IEnumerable) Unregisters the previously registered (see RegisterTypes(IEnumerable)) nodeTypes specified.
(Inherited from OpcNode)
UnregisterTypes(Type, Type) Unregisters the previously registered nodeType and the further specified nodeTypes (see RegisterTypes(Type, Type)).
(Inherited from OpcNode)
UpdateChanges(OpcContext, OpcNodeChanges) Notifies about the changes on behalf of the node and removes pending changes which intersect with the changes specified.
(Inherited from OpcNode)
UpdateChanges(OpcContext, OpcNodeChanges, Boolean) Notifies about the changes on behalf of the node (and optionally on its children) and removes pending changes which intersect with the changes specified.
(Inherited from OpcNode)
Write(OpcContext, UInt32, ByteString) Write is used to write a part of the file starting from the current file position. The file position is advanced by the number of bytes written.
WriteAttributeValueCore``1(OpcWriteAttributeValueContext, OpcAttributeValue) (Inherited from OpcNode)