CONTROL
- Introduction to CTRL
- CONTROL Classes
- Types of Control Functions
- Control graphics
- CONTROL Functions
  - Funtions A
    - abortFileTransfer()
      The function abortFileTransfer() aborts all file transfers of the stated manager.
    - abs()
      Returns the absolute value of a value.
    - access()
      Queries the access mode of the file or directory with the specified path name.
    - acGetRefACType()
      Returns a AC type name, if the leaf dpeName is referenced to an AC type, otherwise an empty string.
    - acos()
      Returns the arc cosine in the radian measure.
    - activateMode()
      Switches the module to normal operating mode.
    - addGlobal()
      Creates a variable and makes it into a control-wide variable.
    - addGroup()
      Adds a group of shapes or a layout to a panel.
    - addGroupPVSS()
      Adds a user group of an external authentication system to the WinCC OA user administration.
    - addShape()
      Adds a new shape into a panel.
    - addSymbol()
      Adds a panel reference in a panel or layout at a later time during run time. To suppress the Initialize scripts of the reference the function createSymbol() can be used instead.
    - addUserPVSS()
      Adds a user of an external authentication system to the WinCC OA user administration.
    - addUserToGroupPVSS()
      Adds a WinCC OA user to a user group in the WinCC OA user administration.
    - aes256Decrypt()
      The function allows to decrypt an encrypted information with the AES-256 algorithm.
    - aes256Encrypt()
      The function allows to encrypt the passed information with the AES-256 algorithm.
    - afterLogin()
      After successful login displays the required panel.
    - alertConnect()
      Registers the function work() for call with resulting alerts.
    - alertDisconnect()
      Unregisters the function work() from call when changes are made to the values.
    - alertGet()
      Queries only the last alert attributes of a data point.
    - alertGetPeriod()
      Reads the values of the specified alert attributes of the data point elements for which alerts were triggered.
    - alertSet()
      Allows data point attributes to be set in a similar way to dpSet().
    - alertSetTimed()
      Allows data point attributes to be set in a similar way to dpSet(). Additionally the timestamp can be set manually.
    - alertSetTimedWait()
      Allows data point attributes to be set in a similar way to dpSet(). Additionally the timestamp can be set manually.
    - alertSetWait()
      Allows data point attributes to be set in a similar way to alertSet()/dpSetWait().
    - animate()
      With the function animate() you can create animations.
    - animateWait()
      With the function animateWait() you can create animations and wait for them to finish.
    - asin()
      Returns the arc sine in the radian measure.
    - assignPtr()
      The function allows to assign a shared_ptr to a different shared_ptr..
    - atan()
      Returns the arc tangent in the radian measure.
    - atan2()
      Returns the arc tangent of the Cartesian coordinates y and x.
  - Funtions B
  - Funtions C
  - Funtions D
  - Functions E
  - Functions F
  - Functions G
  - Functions H
  - Functions I
  - Functions J
  - Functions K
  - Functions L
  - Functions M
  - Functions N
  - Functions O
  - Functions P
  - Functions Q
  - Functions R
  - Functions S
  - Functions T
  - Functions U
  - Functions V
  - Functions W
  - Functions X
  - Functions Y
  - Functions Z
- CTRL Debugger
  With the CTRL Debugger you can debug the programming language Control.
- CtrlExtension, basics
- CTRLPPCheck
  Save time and money with increased code quality in your projects

alertSetTimedWait()

Allows data point attributes to be set in a similar way to dpSet(). Additionally the timestamp can be set manually.

Synopsis

int alertSetTimedWait(time alerttime, time t1, int count1, string dp1, anytype value1[, time t2, ... ] );

Parameters


Parameter	Meaning
alerttime	Time which shall be used for the timestamp.
t1	Time of occurrence
count 1	Serial number
dp1	Data point name
value1	Value to be set

Return Value

Returns 0, in the event of a failure returns -1.

Errors

Errors can be retrieved with getLastError(). The return value is then the appropriate error code. An alert is issued in the event of non-existent data points, incorrect parameter transfers or spelling errors.

Description

Works in a similar way to dpSet(), with certain attributes being able to be set to an alert (to the value valueX). As alerts are not only identified by the associated data point dpX, but also by the time of their occurrence tX, this must also be transferred. It is also possible that several alarms are issued at the same time (for example: group alarm). Alarms of this kind are also assigned a serial number countX.

The parameter alerttime allows to specify the time used for the timestamp.

Unlike with the function alertSetTimed(), with alertSetTimedWait() the execution of the script is blocked and the program waits for an answer from the event manager.

The attributes and their constants which can be set using alertSet() are described in the chapter _alert_hdl.

Examples

main()
{
  string dpe = "System1:ExampleDP_Arg1.";
  int range;
  time alerttime;
  time acktime;
  atime At;

//get range of the alert
  dpGet(dpe+":_alert_hdl.._act_range", range);

//get time of the alert
  dpGet(dpe+":_online.._stime", alerttime);

//make time that shall be used for the acknowledge timestamp
  acktime = makeTime(2012, 12, 22, 12, 12, 12);

//make time to be of type "atime"
  At = makeATime(alerttime, 0, dpe);

//make sure acknowledging is needed
  if(range != 0)
  {

//single-acknowledge alert
    alertSetTimedWait(acktime, alerttime, getACount(At), dpe+":_alert_hdl."+range+"._ack_state",
    DPATTR_ACKTYPE_SINGLE);
  }
}

Assignment

Data point function

Availability

CTRL