Service Members

<< 点击显示目录 >>

主页  PVI通信 > PVI帮助信息 > PVI Services > BR.AN.Namespace > BR.AN.PviServices > Service Class >

Service Members

BR.AN.PviServices .NET


Service overview

Public Instance Constructors

pubmethod Service

Overloaded. Initializes a new instance of the Service class.

Public Instance Properties

pubpropertyAddMembersToVariableCollection

Gets or sets wheter variable members should be add to the Variables Collections or not. This feature is set to OFF by default.

pubpropertyAddStructMembersToMembersToo

Get or set if the members of nested structures should be add to the root only, or if all members should get their child members too. When enabling this flag the performance may decrees when using deep nested structures and arrays of structures! By default the structure members will only be add to the root objects key map.

pubpropertyClientNames

Gets the list of Client names

pubpropertyCpus

Gets a collection of all configured cpu devices

pubpropertyEnhancedTransfer

Gets or sets if modules use the enhanced method for down or upload.

pubpropertyExtendedTypeInfoAutoUpdateForVariables

Gets if the extended Typ info for variables should be uploaded automatically or not. (ArrayDimensions, Enumerations, Derivation and Bit-String) This extended typ information is not aalways of interest therefore it is disabled by default. This is due to the fact that it takes longer to connect varibales if extended type info is available.

pubpropertyFullName

Gets the FullName of this instance

pubpropertyIsStatic

Gets or sets a bool flag for generating static (true) or dynamic (false) communication objects. Defaultvalue = false.

pubpropertyLanguage

Gets or sets the language of this service-instance.

pubpropertyLicenceInfo

Gets the PVI license info.

pubpropertyLoggerCollections

Gets the collection of global logger modules.

pubpropertyLoggerEntries

Gets the collection of logger entries if is TRUE.

pubpropertyLogicalObjects

Gets collection of all created PviServices object be low this instance.

pubpropertyLogicalObjectsUsage

Gets or sets the LogicalObjectUsage value.

pubpropertyMessageLimitation

Limit on user messages. Default: "LM=1" for W32 and W64 zero for CF. PVICOM applications basically do not need to change the default setting of this parameter. However, if an application is able to respond quickly to PVICOM user messages, then a higher limit value ("LM=100", "LM=1000") or turning off the limiting ("LM=0") can speed up user message execution. See the User Message Operations section for more information about this parameter.

pubpropertyPort

Gets or sets the port number for the remote connection.

pubpropertyProcessTimeout

Process timeout in seconds. Default: "PT=0". This timeout can be used to monitor the time between requests and responses. This parameter is only intended for PVICOM applications which carry out particular tasks. Standard application do not need to be monitored and should use the default setting (no timeout monitoring).

pubpropertyPVIAutoStart

Auto-Start (only for the local communication type). 1 ... PVI Manager is started (default). 0 ... PVI Manager is not started automatically and must be started already when the function is called.

pubpropertyPviPathName

Gets the PviPathName of this instance.

pubpropertyRetryTime

Retry time for PVICOM user messages is seconds. The default setting ("RetryTime=0") should normally be used for this parameter. See the User Message Operations section for more information about this parameter.

pubpropertyServer

Gets or sets the server IP address or server name for remote connection.

pubpropertySNMP

Gets the SNMP root object for browsing for MAC addresses and SNMP variables.

pubpropertyTimeout

Communication timeout for the client/server (application/PVI Manager) communication in seconds. The timeout also defines the time for the life sign monitor. An additional period is needed to detect a disruption in the client/server connection. To determine the total time where a communication disruption would be detected (at the latest), the timeout value specified here has to be doubled. If the timeout is 5, then an interruption in the connection can be detected in as early as 5 seconds and as late as 10 seconds. Connection interrupts are not recognized as such by the PVICOM interface if they occur within the timeout period. Data transfer simply continues once the connection is reestablished. Often used values are 3 - 10 seconds for local communication and 5 - 30 seconds for remote communication.

pubpropertyTrace

A Helper class for trace output to a file

pubpropertyUserTagEvents

Gets or sets wheter to enable user tag events or not (EV=u). DEFAULT = true!

pubpropertyVariables

Gets a collection of intern PviServices variable object.

pubpropertyWaitForParentConnection

Gets or sets the WaitForParentConnection property.

Public Instance Methods

pubmethodAttachPVIObjects

Reads the PVI object hierarchie down to the variables for all open INA2000 connections.

pubmethodConnect

Overloaded. Initializes this instance using an existing server with port number.

pubmethodDisconnect

Overloaded. Deinitialize this instance. This is a synchronuous function and can not be called within a CB function!!

pubmethodGetAssemblyVersions

Gets the file and productversion of the assembly this Service class is defined.

pubmethodGetErrorText

Gets the error Text for a specified error number.

pubmethodGetPVIVersionInfo

Call this method to retrive the version information of the the main PVI communication components including the Setup version. The result will be available as name to version pair. Includes the version number of the active PVI installation (the key is "§PVI Setup§"), The versions of the PVI communication librarie (the local one is marked with a starting "§LOCAL§ " and will always have the same version when NOOt using remote communication) and the version of the PVI Manager executable.

pubmethodLoadConfiguration

Overloaded. Loads an existing PlcService configuration stored in an xml file

pubmethodRefreshPviClientsList

Helper to update the list of clients.

pubmethodRemove

This method removes the instances references from the PviServices hierarchy.

pubmethodRemoveArchive

Helper to remove a logger archive from the global logger collection.

pubmethodSaveConfiguration

Overloaded. Saves the instance and all its child objects hierarchically structured in a xml-File. Use to restore the object hierarchie structure.

pubmethodUpdateLicenceInfo

Call this method to reread the license info. The info will be received in LicencInfoUpdated. But will not be available immediately after PVI is started. It takes up to a few seconds until the info is available.

Public Instance Events

pubeventLicencInfoUpdated

Will be called in response to Service.UpdateLicenceInfo.

pubeventPVIObjectsAttached

Event will be fired when PVI object hierarchy scanning has finished.

See Also

Service Class | BR.AN.PviServices Namespace


Generated from assembly BR.AN.PviServices [8.1.0.4]