BR.AN.PviServices .NET

KW_DETECT_SYSLOGBOOK_NAME

The name of the system log book for SG4 targets ("$arlogsys").

Cpu Constructor

Initializes a new instance of the Cpu class.

Accu

Gets the state of the accu of the PLC

ApplicationMemory

Obsolete. Gets the ApplicationMemory type of the cpu. Return an empty String if the Cpu has no ApplicationMemory

ApplicationModuleFilter

Gets or sets the /AM (ApplicationModule) parameter for the communication to the PLC. If null the parameter will not be set at all. The communication instance will use the setting from "PviConfig.xml". null ... The application module name will not be used by PviServices. "::" ... The application module name can also be an empty string which is also called the "Default" application module. "*::" ... access to all application modules is allowed. "ApplicationModuleName::" ... the access is limited to application module "ApplicationModuleName" and to the empty application module name.

Battery

Gets the state of the battery of the PLC

BondInformationStruct

Gets the bond info received in BondInfoChanged.

BootMode

Gets the bootmode of this instance.

Connection

Gets the Connection object of this instance.

CpuUsage

Gets the percantage value (from 0 to 100) for the CPU usage. Can only be used for ANSL connections. Will return zero for INA2000 connections. Call UpdateCpuInfo to force a reread of the CPU info.

CurrentCyclicSystemUsage

Gets the performance of the cyclic CPU System. Value (0-100).

FullName

Gets the FullName of this instance.

HardwareInfo

Gets the Hardware info. Format is XML. Call ReadHardwareInfo if the string is empty.

HardwareInformationStruct

Gets the Hardware info. Call ReadHardwareInfo if null.

HardwareInfos

Gets the collection of hardware infos.

HasErrorLogBook

Gets if this CPU includes the oldstyle error logbook.

IODataPoints

A Collection of IODataPoints. Execute Method IODataPointCollection.Upload to get all IOs from the PLC.

IsConnected

Gets or sets the connection state of the PviServices object

IsSG4Target

Gets if it is an SG4 target.

Libraries

Gets the collection of the libraries.

LicenseStatusError

Returns the status error information extracted from the XML string .

LicenseStatusInfo

Returns the status information of PLC license as XML string

Loggers

Gets the collection fo logger modules.

Memories

Gets the actually uploaded memories of the device.

MemoryInfo

Gets the memory info. Format is XML. Call ReadMemoryInfo if the string is empty.

MemoryInformationStruct

Gets the memory info. Call ReadMemoryInfo if null.

Modules

Gets the actually uploaded modules of the device.

NodeNumber

Gets the nodenumber of the cpu.

ObjectsOnTarget

Gets the collection of objects listed on the target. This collection can only be used when using ANSL as communication protocol!

Profiler

Get the profiler.

PviPathName

Gets the PviPathName of this instance.

RedundancyCommMode

Gets or sets wheter to start a redundant communication to the PLC or not. If set to true the the PLC communication will be handled using cluster- primary- and secondary- Cpu connectrion settings. (/RED=1)

RedundancyInfo

Gets the redundancy info. Format is XML. Call ReadRedundancyInfo if the string is empty.

RedundancyInformationStruct

Gets the redundancy info. Call ReadRedundancyInfo if null.

ResponseTimeout

Gets or sets the Response timeout in milliseconds. This parameter is part of the connection object! So when changing the connection object the ResponseTimout will change too although the parameter is a member of the CPU object!! If you want to change the ResponseTimeout, you will have to set the device object before!! If a response to a sent frame is not received with this time, then the frame is transferred again. After the third retry, the connection is deemed cancelled. The time in which an interrupted connection is detected is a result of the Response Timeout * 4.

RuntimeVersion

Gets the operating-system version of this cpu-instance.

SavePath

Gets the SavePath property of the cpu.

State

Gets the state of this instance.

TaskClasses

Gets the actually uploaded taskclasses of the device.

Tasks

Gets the actually uploaded tasks of the device.

TcpDestinationSettings

Gets the destination parameters for a tcp connection. The object has to be connected and a call to ReadTCPDestinationSettings has to be used to retrieve the settings. The settings will be valid as soon as TCPDestinationSettingsRead has been fired.

TextModules

The collection of TextModules

Type

Gets the type of this cpu-instance.

Variables

Gets the actually uploaded global variables of the device.

BlinkDongle

Casues the dongle to start blinking.

ChangeConnection

Use this member function to change the connection of the CPU object. When the function has changed the connection the Event ConnectionChanged will be fired.

ClearMemory

Use this method to clear any of the PLC memory types. You can also use Clean Method of the Memory Class to do the same. PLC has to be in DIAGNOSTIC mode!!!

CompareRuntimeVersionTo

Call this method to see if the given version is

Connect

Overloaded. Creates a connection to the physical Cpu using the specified connection parameters set in the connectiono object properties. (see: Connection class)

DeleteModule

Delete the Module on the plc

Disconnect

Overloaded. Disconnects this instance from its device.

DisconnectChildObjects

Call this method to disonnect all child objects

FromXmlTextReader

Reads the configuration from xml configuration file and updates.

GetExistingLicense

Gets the list of licenses for the PLC project and OS

GetLicenseContext

Overloaded. Reads the ontext data for a specified serial number using the set box mask and the defined firm- codes.

GetLicenseStatus

Overloaded. Reads the license state.

GetListOfDongles

Gets the list of dongles for the PLC project and OS

GetRequiredLicenses

Gets the list of required licenses

GlobalForceOFF

Use this method to set the global Force mode to OFF

ReadApplicationInfo

Call this method to read the application/project info. The data will be provided as XML string in the event HardwareInfoRead.

ReadCommunicationLibraryVersions

Call this method to retrive the version information of the communication component DLLs. The result will be available as name to version pair.

ReadDateTime

Read the CpuTime from the plc

ReadHardwareInfo

Call this method to read the hardware info. The data will be provided as XML string in the event HardwareInfoRead.

ReadMemoryInfo

Call this method to read the memory info. The data will be provided as XML string in the event RedundancyInfoRead.

ReadRedundancyInfo

Call this method to read the redundancy info. The data will be provided as XML string in the event RedundancyInfoRead. This command is only valid for a redundancy SYSTEM.

ReadSavePath

Reads the SavePath property of the CPU object.

ReadTCPDestinationSettings

Call this method to get the destionation settings for an existing tcp connection.

ReadTOC

Reads the table of contens from the connected CPU. The responsedata will be available in the event .

Remove

This method removes the instances references from the PviServices hierarchy.

Restart

Restarts the Cpu on the Plc.

SwitchActiveCpu

Overloaded. Call this method to switch the active CPU of a redundancy PLC pair. This command is only valid for a redundancy SYSTEM.

SynchronizeRApplication

Call this method to switch the active CPU of a redundancy PLC pair. This command is only valid for a redundancy SYSTEM.

UpdateCpuInfo

Call this method to Update the CPU Info. The CPU info is up to date as soon as the connection to the PLC has been established. Will rasie the event CpuInfoUpdated and update the properties RuntimeVersion, NodeNumber, BootMode, State, Type, CpuUsage and Accu.

UpdateLicenseData

Updates the licence data on the PLC.

WriteDateTime

Write the Time on the plc

WriteSavePath

This method sets the SavePath property of the cpu.

ActiveCpuChanged

Occurs when the active CPU has change in an redundancy system.

ApplicationInfoRead

Occurs when the application info has been read.

ApplicationSynchronizeStarted

Occurs when the PLC has accepted the start of the application synchronizeation. The progress will be reported by ApplicationSyncing.

ApplicationSyncing

Occurs when the active CPU has change in an redundancy system. either app sync (Cmd="2") or active cpu switched (Cmd="1") or (CMD="16") for RedInfo changed events

BondInfoChanged

Occurs when the bond interface changes.

CpuInfoUpdated

Occurs when this instance CPU info has been updated.

DateTimeRead

Occurs when the cputime is read.

DateTimeWritten

Occurs when the cputime is written.

HardwareInfoRead

Occurs when the hardware info has been read.

LicenseChanged

Occurs when the license changes (e.g.: some on connects or disconnects a dongle).

LicenseStatusGot

Occurs when the cpu requests to the license state.

MemoryCleared

Occurs when the cpu requests to clear a memory type.

MemoryInfoRead

Occurs when the memory info has been read.

ModuleDeleted

Occurs when a module has been deleted by the CPU.

RedundancyInfoChanged

Occurs when the redundancy info has been read.

RedundancyInfoRead

Occurs when the redundancy info has been read.

Restarted

Occurs when the cpu is restarted.

SavePathRead

Occurs when SavePath is read.

SavePathWritten

Occurs when SavePath is written.

TCPDestinationSettingsRead

Occurs when the TCP settigs have been read.

TOCRead

Event will be fired after the TOC has been read from the PLC.