OPCDA.NET-UA
Server Class Members
See Also  Fields  Properties  Methods  Events Send Feedback
OpcDaNetUaOption.Net4 Assembly > UA_Wrapper Namespace : Server Class

Glossary Item Box

The following tables list the members exposed by Server.

Public Constructors

 NameDescription
Public ConstructorServer Constructor Constructs a wrapper instance for one UA server. The optional configuration settings are read from the application configuration file.  
Top

Public Fields

 NameDescription
Public FieldCertificateCredential  
Public FieldCertificateDomainMustMatch Determines if certificates with a non-matching domain are accepted.  
Public FieldcfgName Name of the application. this string is used to build: - the configuratuion file name xxx.Ua.Config.Xml - the endpoint definition file name xxx.Ua.Endpoints.Xml  
Public Fieldstatic (Shared in Visual Basic)onNotifyUntrustedCertificate handler that is called when the server certificate is untrusted  
Public FieldPreferredEndpoint Use this endpoint at connect if possible.  
Public FieldPreferSecureConnection Use the endpoint with highest security if true, otherwise the lowest priority.  
Public FieldproxyServer The object with the server access methods.  
Public FieldTraceMaskUserDefined Certificate for client authentication If defined then the certificate is used as the credential for session creation.  
Public Fieldstatic (Shared in Visual Basic)UaAppConfigFileAutoCreate If not null then an application configuration file is created unless it already exists. The defined name is used as the appliction name.  
Top

Public Properties

 NameDescription
Public PropertyDefNamespaceURIs NamespaceURIs that match the NodeIDs persisted in the client application. If the application doesn't set this property before the Connect then the URIs are tried to be loaded from the file app.url.XML in the same directory as the app.exe executable. url is the UA server URL without the xxx://  
Public PropertyTraceEvents  
Public PropertyTraceOutputs Trace output destination selection  
Top

Public Methods

 NameDescription
Public MethodBrowse3 Browse the current branch for branches and/or items.  
Public MethodBrowseChangePosition Change to the specified branch in virtual address space. This method is only called when virtual BrowseMode is selected.  
Public MethodBrowseOPCItemIDs Browse the current branch for branches or items.  
Public MethodCallUaMethodExecute a call of a UA Method.
The input arguments must specified according the method input parameter definition. in the order and data type  
Public MethodConnect The UA server connection is initiated with the optional credentials.  
Public MethodDisconnect Disconnect form the UA server  
Public MethodGetItemID Get the full item name of the specified name in the current branch.  
Public MethodGetItemPropertiesReturn a list of the current data values for the passed ID codes.
 
Public MethodGetLocaleID Get the current default LocalID. ( IOPCCommon::GetLocaleID )  
Public MethodGetNodeClass Returns the UA NodeClass enumerator value for each item.  
Public MethodGetPropertiesReturns the properties for a set of items. ( OPCDA V3, IOPCBrowse::GetProperties )
In the OPCDA.NET Professional Edition this method is available also for OPCDA V2 servers. With OPCDA V2 servers the method is emulated by calling the available OPCDA V2 item properties methods.

An OPCException is thrown if the OPC Server returns an error.  
Public MethodGetStatus Get the current status of the UA server, converted to the OPC DA defined states.  
Public MethodGetUaMethodDefinition Retrieve the argument definition for the method specified by the node identifier (item ID).  
Public MethodLookupItemIDs Return a list of ITEMIDs (if available) for each of the passed ID codes. These indicate the ITEMID which could be added to an OPCGroup and used for more efficient access to the data corresponding to the Item Properties.  
Public MethodQueryAvailableLocaleIDs Query the LocaleIDs supported by the OPC Server. ( IOPCCommon::QueryAvailableLocaleIDs ) If any error occurs a ThrowExceptionForHR is thrown.  
Public MethodQueryAvailableProperties Return a list of ID codes and descriptions for the available properties for this ITEMID. This list may differ for different ItemIDs. This list is expected to be relatively stable for a particular ItemID. That is, it could be affected from time to time by changes to the underlying system's configuration. ( IOPCItemProperties::QueryAvailableProperties )  
Public MethodReadReads a group of items with all the same maxAge
The purpose of this OPC V3 method is to provide an extremely easy way for simple applications to obtain OPC data. Programmers should be aware that in most servers, the design of the Group based OPC interfaces will provide much better performance than this method. In terms of performance, the user of this method should assume that it will behave as if he were to create a group, add the items, perform a single read or write and then delete the group.  
Public MethodSetClientName This method is not implemented in UA. In DA it's main use is for debugging purposes.  
Public MethodSetLocaleID Set the default LocaleId for this session. ( IOPCCommon::SetLocaleID )  
Public MethodWriteWrites a group of items.
The purpose of this OPC V3 method is to provide an extremely easy way for simple applications to write OPC data. Programmers should be aware that in most servers, the design of the Group based OPC interfaces will provide much better performance than this method. In terms of performance, the user of this method should assume that it will behave as if he were to create a group, add the items, perform a single Write or write and then delete the group.  
Top

Public Events

 NameDescription
Public EventonTrace  
Top

See Also

Copyright © 2020 Advosol Inc. All Rights Reserved.