CamBuilder.Init (METH) ¶ METHOD PUBLIC FINAL Init Initializes the |SMC_CamBuilder| to start with a new cam. All previously added cam segments will be removed and errors cleared.
CamBuilder.IsErrorPending (METH) ¶ METHOD IsErrorPending : BOOL Returns whether an error is pending. This can happen if appending a cam segment fails. InOut: Scope Name Type Return IsErrorPending BOOL Output errorID SMC_ERROR
CamBuilder.Write (METH) ¶ METHOD FINAL Write : SMC_ERROR Writes the cam segments of this cam builder to camRef . Please note, that camRef needs to be initialized before calling this method by calling InitCamRef . InOut: Scope Name Type Return Write SMC_ERROR Inout camRef MC_CAM_REF
Constructors ¶ Bound (Function) BoundImplicit (Function) Line (Function) Poly5 (Function) Poly5_Coeffs (Function) Poly7 (Function) Poly7_Coeffs (Function)
IAlarmHandler2 (ITF) ¶ INTERFACE IAlarmHandler2 EXTENDS IAlarmHandler This is an extension of the IAlarmHandler interface, that provides access to the alarms, that are currently active. Methods: GetActiveAlarms GetAlarmsFromStorage GetCountAlarmsFromStorage RegisterClient UnregisterClient AcknowledgeAll , inherited from IAlarmHandler AcknowledgeAllOfGroup , inherited from IAlarmHandler AcknowledgeOneOfGroup , inherited from IAlarmHandler RaiseEvent , inherited from IAlarmHandler Structure: GetActiveAlarms (Method) GetAlarmsFromStorage (Method) GetCountAlarmsFromStorage (Method) RegisterClient (Method) UnregisterClient (Method)
IAlarmHandler2.GetActiveAlarms (METH) ¶ METHOD GetActiveAlarms : UDINT Returns the alarms, that are currently active, according to given filter criteria of the IAlarmManagerClient instance. The return value indicates, whether the processing was successful or not: * ERR_OK: Output parameters of method are valid, client was found * ERR_NO_OBJECT: Client was not found, has been not yet added to the vector * ERR_NOTINITIALIZED: No client has been registered at the alarm manager InOut: Scope Name Type Comment Return GetActiveAlarms UDINT Input itfAlarmManagerClient IAlarmManagerClient The IAlarmManagerClient instance Output parritfActiveAlarms POINTER TO ARRAY [0..0] OF IAlarm Points to an array of IAlarm instances, that are the alarms, that fit the filter criteria and that are currently active. iCountActiveAlarms INT The effective size of the array above
IAlarmHandler2.GetAlarmsFromStorage (METH) ¶ METHOD GetAlarmsFromStorage : UDINT Reads alarms from the alarm storage using the filter criteria of the passed IAlarmManagerClient instance. The result will be stored in the array the IAlarmManagerClient instance passed in the call of method RegisterClient. The return value indicates, whether the processing was successful or not: * ERR_OK: Alarms from storage have been read successfully * ERR_NO_OBJECT: Client was not found, has been not yet registered at the alarm manager * ERR_NOTINITIALIZED: No client has been registered at the alarm manager * ERR_NO_ALARM_STORAGE: No access to the alarm storage possible, because no array for storing alarms from storage has been passed during registering the client InOut: Scope Name Type Comment Return GetAlarmsFromStorage UDINT Input itfAlarmManagerClient IAlarmManagerClient The IAlarmManagerClient instance iSkipRows INT The number of rows (beginning at the row with the row ID), that have to skipped. This parameter is used to consider the vertical scrolling. After skipping the rows, the row ID parameter contains the row ID of the new start row. In case of scrolling down, this parameter is positive, in case of scrolling up, this parameter has a negative value. If not scrolled this parameter is 0. Inout bRowIDValid BOOL A flag indicating, whether the row ID parameter contains a valid row ID. For the 1st query this flag should be FALSE in order to signal, that the query is performed the 1st time and therefore the cursor has to be set at the beginning of the result set. diRowID DINT The row ID of the row, where the search has to start. This parameter will also be modified by the function using the parameter Output iCountRows INT Returns the effective number of rows, that have been read
IAlarmHandler2.GetCountAlarmsFromStorage (METH) ¶ METHOD GetCountAlarmsFromStorage : DINT This method counts all the alarms in the alarm storage, that are currently stored and fit the passed filter criteria the IAlarmManagerClient instance uses. The return value is the count. InOut: Scope Name Type Comment Return GetCountAlarmsFromStorage DINT Input itfAlarmManagerClient IAlarmManagerClient The IAlarmManagerClient instance Output udiResult UDINT Indicates, whether the processing was successful or not: ERR_OK: Alarms from storage have been read and counted successfully ERR_NO_OBJECT: Client was not found, has been not yet registered at the alarm manager ERR_NOTINITIALIZED: No client has been registered at the alarm manager
IAlarmHandlerRemoteMonitor.GetProxyAlarmClassesDescription (METH) ¶ METHOD GetProxyAlarmClassesDescription : BOOL Gets the alarms classes description handled by proxy It returns TRUE if the proxy is present InOut: Scope Name Type Comment Return GetProxyAlarmClassesDescription BOOL Input sName STRING Proxy name pClDesc POINTER TO ARRAY [0..0] OF ProxyStructMonitorAlarmClassDesc Where to store the classes descriptions iSize INT The size of above array in term of entries Output iClCnt INT The real number of entries written
IAlarmHandlerRemoteMonitor.GetProxyAlarmGroupsDescription (METH) ¶ METHOD GetProxyAlarmGroupsDescription : BOOL Gets the alarms groups description handled by proxy It returns TRUE if the proxy is present InOut: Scope Name Type Comment Return GetProxyAlarmGroupsDescription BOOL Input sName STRING Proxy name pGrpDesc POINTER TO ARRAY [0..0] OF ProxyStructMonitorAlarmGroupDesc Where to store the groups descriptions iSize INT The size of above array in term of entries Output iGrpCnt INT The real number of entries written