.NET Based OPC UA Client/Server SDK  3.1.0.500
UnifiedAutomation.UaServer.AddressSpaceFileModel Class Reference

This object type defines the file for a namespace provided by the OPC UA Server. More...

Inherits UnifiedAutomation.UaServer.FileModel, and UnifiedAutomation.UaServer.IMethodDispatcher.

Public Member Functions

 AddressSpaceFileModel ()
 Initializes a new instance of the AddressSpaceFileModel class. More...
 
 AddressSpaceFileModel (AddressSpaceFileModel template)
 Initializes a new instance of the AddressSpaceFileModel class. More...
 
override CallMethodEventHandler GetMethodDispatcher (RequestContext context, NodeId objectId, NodeId methodId)
 Gets the method dispatcher. More...
 
override StatusCode DispatchMethod (RequestContext context, MethodHandle methodHandle, IList< Variant > inputArguments, List< StatusCode > inputArgumentResults, List< Variant > outputArguments)
 Dispatches the method. More...
 
- Public Member Functions inherited from UnifiedAutomation.UaServer.FileModel
void Dispose ()
 Frees any unmanaged resources. More...
 
virtual StatusCode Open (RequestContext context, FileModel model, byte mode, out uint fileHandle)
 Used to open a file represented by an Object of FileType. More...
 
virtual StatusCode Close (RequestContext context, FileModel model, uint fileHandle)
 Closes a file represented by a FileType. More...
 
virtual StatusCode Read (RequestContext context, FileModel model, uint fileHandle, int length, out byte[] data)
 Reads a part of the file starting from the current file position. More...
 
virtual StatusCode Write (RequestContext context, FileModel model, uint fileHandle, byte[] data)
 Writes a part of the file starting from the current file position. More...
 
virtual StatusCode SetPosition (RequestContext context, FileModel model, uint fileHandle, ulong position)
 Used to set the current position of the FileHandle. More...
 
virtual StatusCode GetPosition (RequestContext context, FileModel model, uint fileHandle, out ulong position)
 Provides the current position of the FileHandle. More...
 
 FileModel ()
 Initializes a new instance of the FileModel class. More...
 
 FileModel (FileModel template)
 Initializes a new instance of the FileModel class. More...
 
- Public Member Functions inherited from UnifiedAutomation.UaServer.BaseObjectModel
 BaseObjectModel ()
 Initializes a new instance of the BaseObjectModel class. More...
 
 BaseObjectModel (BaseObjectModel template)
 Initializes a new instance of the BaseObjectModel 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...
 

Additional Inherited Members

- Protected Member Functions inherited from UnifiedAutomation.UaServer.FileModel
virtual void Dispose (bool disposing)
 An overrideable version of the Dispose. More...
 
virtual bool HasAccess (RequestContext context, UserAccessMask accessMasks)
 Determines whether the current context has specified access to the file. More...
 
void CleanupExpiredHandles ()
 Cleans up any expired handles. More...
 
StatusCode OpenStream (OpenFileHandle handle)
 Opens a stream for the file referenced by FileOnDisk. More...
 
OpenFileHandle FindHandle (RequestContext context, uint fileHandle)
 Finds the handle. More...
 
void SaveHandle (OpenFileHandle handle)
 Assigns a unique id to the handle and saves the handle. More...
 
void CloseHandle (OpenFileHandle handle)
 Closes the stream associated with the handle and sets the size of the File object. More...
 
- Protected Attributes inherited from UnifiedAutomation.UaServer.FileModel
object Lock = new object()
 An object used to synchronize access to the file object. More...
 
- Properties inherited from UnifiedAutomation.UaServer.FileModel
FileInfo FileOnDisk [get, set]
 Gets or sets the disk file which can be accessed via the file object. More...
 
int MaxFileSize [get, set]
 Gets or sets the maximum size of the file in bytes. More...
 
INodeAccessInfo NodeAccessInfo [get, set]
 Gets or sets the NodeAccessInfo to specify user access in Open method. More...
 
uint NextFileHandle [get, set]
 Gets or sets the next file handle to assign. More...
 
string MimeType [get, set]
 Contains the media type of the file based on RFC 2046. More...
 
ushort OpenCount [get, set]
 Indicates the number of currently valid file handles on the file. More...
 
ulong Size [get, set]
 Defines the size of the file in Bytes. More...
 
bool UserWritable [get, set]
 Indicates whether the file is writable, taking user access rights into account. More...
 
bool Writable [get, set]
 Indicates whether the file is writable. More...
 
IFileMethods FileMethods [get, set]
 Gets or sets the File methods. More...
 
- Properties inherited from UnifiedAutomation.UaServer.ModelControllerBase
ModelHandle ModelHandle [get, set]
 Gets or sets the metadata handle. More...
 
object UserData [get, set]
 Gets or sets the user data. More...
 
- Events inherited from UnifiedAutomation.UaServer.FileModel
EventHandler< OpenFileEventArgsOpenRequested
 Occurs when the file is opened. More...
 
EventHandler< CloseFileEventArgsCloseRequested
 Occurs when the file is closed. More...
 

Detailed Description

This object type defines the file for a namespace provided by the OPC UA Server.

It represents an XML address space file using the XML schema defined in Part 6 of the OPC UA Specification.

Servers might provide some vendor-specific mechanisms importing parts of an address space as subtype of this object type, for example by defining appropriate methods.

Constructor & Destructor Documentation

UnifiedAutomation.UaServer.AddressSpaceFileModel.AddressSpaceFileModel ( )
inline

Initializes a new instance of the AddressSpaceFileModel class.

UnifiedAutomation.UaServer.AddressSpaceFileModel.AddressSpaceFileModel ( AddressSpaceFileModel  template)
inline

Initializes a new instance of the AddressSpaceFileModel class.

Parameters
templateThe template.

Member Function Documentation

override StatusCode UnifiedAutomation.UaServer.AddressSpaceFileModel.DispatchMethod ( RequestContext  context,
MethodHandle  methodHandle,
IList< Variant inputArguments,
List< StatusCode inputArgumentResults,
List< Variant outputArguments 
)
inlinevirtual

Dispatches the method.

Parameters
contextThe context.
methodHandleThe method handle.
inputArgumentsThe input arguments.
inputArgumentResultsThe input argument results.
outputArgumentsThe output arguments.
Returns

Reimplemented from UnifiedAutomation.UaServer.FileModel.

override CallMethodEventHandler UnifiedAutomation.UaServer.AddressSpaceFileModel.GetMethodDispatcher ( RequestContext  context,
NodeId  objectId,
NodeId  methodId 
)
inline

Gets the method dispatcher.

Parameters
contextThe context.
objectIdThe object id.
methodIdThe method id.
Returns

Implements UnifiedAutomation.UaServer.IMethodDispatcher.


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