.NET Based OPC UA Client/Server SDK
3.3.0.530
|
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, DummyArgument dummy=null) | |||
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, DummyArgument dummy=null) | |||
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, DummyArgument dummy=null) | |||
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... | |||
StatusCode | GetStatusCode (string propertyName) | ||
Retrieve the status code for the given property. If no status code was explicitly set, StatusCodes.Good will be returned.
| |||
void | SetStatusCode (string propertyName, StatusCode statusCode) | ||
Sets the status code of the given property. More... | |||
Additional Inherited Members | |
Public Attributes inherited from UnifiedAutomation.UaServer.ModelControllerBase | |
bool | HasStatusCodes => m_statusCodes != null && m_statusCodes.Count > 0 |
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 Member Functions inherited from UnifiedAutomation.UaServer.ModelControllerBase | |
void | RaisePropertyChangedEvent ([CallerMemberName] string propertyName=null) |
Raises an property change event. More... | |
void | RaisePropertyChangeRequestedEvent< T > (T value, [CallerMemberName] string propertyName=null) |
Called when the value of a property is supposed to be changed. More... | |
bool | SetField< T > (ref T field, T value, [CallerMemberName] string propertyName=null) |
Sets the backing field to the new value, and triggers a property change event, if the value has changed. 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... | |
IRolePermissions | RolePermissions [get, set] |
AccessRestrictionType | AccessRestriction [get, set] |
uint | NextFileHandle [get, set] |
Gets or sets the next file handle to assign. More... | |
DateTime | LastModifiedTime [get, set] |
Gets or sets the LastModifiedTime More... | |
uint | MaxByteStringLength [get, set] |
Gets or sets the MaxByteStringLength 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... | |
Properties inherited from UnifiedAutomation.UaServer.INotifyStatusCodeInfo | |
bool | HasStatusCodes [get] |
true if no property has an explicit set status code. Hence when all status codes are implicit StatusCodes.Good. More... | |
Events inherited from UnifiedAutomation.UaServer.FileModel | |
EventHandler< OpenFileEventArgs > | OpenRequested |
Occurs when the file is opened. More... | |
EventHandler< CloseFileEventArgs > | CloseRequested |
Occurs when the file is closed. More... | |
Events inherited from UnifiedAutomation.UaServer.ModelControllerBase | |
PropertyChangedEventHandler | PropertyChanged |
Occurs when a property value changes. More... | |
EventHandler < PropertyChangeRequestedEventArgs > | PropertyChangeRequested |
The event is emitted just before the value will be changed, and gives the observer the opportunity to reject or adjust (e.g. clamp) the property change by setting the PropertyChangeRequestedEventArgs.StatusCode and PropertyChangeRequestedEventArgs.Value properties. More... | |
EventHandler < StatusCodeChangedEventArgs > | StatusCodeChanged |
Events inherited from UnifiedAutomation.UaServer.INotifyPropertyChangeRequested | |
EventHandler < PropertyChangeRequestedEventArgs > | PropertyChangeRequested |
The property change request event. More... | |
Events inherited from UnifiedAutomation.UaServer.INotifyStatusCodeInfo | |
EventHandler < StatusCodeChangedEventArgs > | StatusCodeChanged |
Occurs if the status code of a property was changed. More... | |
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.
UnifiedAutomation.UaServer.AddressSpaceFileModel.AddressSpaceFileModel | ( | ) |
Initializes a new instance of the AddressSpaceFileModel class.
UnifiedAutomation.UaServer.AddressSpaceFileModel.AddressSpaceFileModel | ( | AddressSpaceFileModel | template, |
DummyArgument | dummy = null |
||
) |
Initializes a new instance of the AddressSpaceFileModel class.
template | The template. |
dummy | Dummy argument to enable writing own constructors that are called by the generated code. |
|
virtual |
Dispatches the method.
context | The context. |
methodHandle | The method handle. |
inputArguments | The input arguments. |
inputArgumentResults | The input argument results. |
outputArguments | The output arguments. |
Reimplemented from UnifiedAutomation.UaServer.FileModel.
override CallMethodEventHandler UnifiedAutomation.UaServer.AddressSpaceFileModel.GetMethodDispatcher | ( | RequestContext | context, |
NodeId | objectId, | ||
NodeId | methodId | ||
) |
Gets the method dispatcher.
context | The context. |
objectId | The object id. |
methodId | The method id. |
Implements UnifiedAutomation.UaServer.IMethodDispatcher.