Functions

atnGetActionList()

Gets a pointer to current action list. Pointer to will be to an array of AtnActionData_typ.

Direction Name Type Description
In namespace STRING Namespace to retrieve list of actions from
Return pActionList UDINT Pointer to active action list

atnSetActionList()

Set new container location for actions list. All currently registed actions will be migrated over the the new list. Container will be cleared before use. New container must be bigger than old container else an error will occur. The number of modules that can be registered at one time is equal to the number of elements in the actions list array.

Direction Name Type Description
In namespace STRING Namespace to set list of actions to
In pActions AtnActionData_typ* A pointer to an array of AtnActionData_typ
In size UDINT sizeof pActions container
Return status BOOL 0 if completed successfully

AtnRunAction

Run action FUB. Commands pDirector to start Action specified in action.

Direction Name Type Description
In execute BOOL Execute action on rising edge
In pDirector UDINT Pointer to director to handle action
In action STRING Name of action to be executed. Max length of ATN_ACTION_NAME_LEN
In pParameter UDINT Pointer location of paremeters that should be passed to action
In parameterSize UDINT Size of paremeter location
Out busy BOOL Action call is busy
Out done BOOL Action call is done
Out active BOOL Action call is active
Out aborted BOOL Action call was aborted
Out error BOOL Action call error

atnRunAction()

Run action function. Commands pDirector to start Action passed into action argument.

Direction Name Type Description
In pDirector Atn_typ* Pointer to director who should handle action
In action STRING Name of action to be executed. Max length of ATN_ACTION_NAME_LEN
In pParameters UDINT Pointer to parameters to be passed to action behaviors. 0 if no parameters should be passed
In parameterSize UDINT Size of parameters being passed to action behaviors
Out pStatus AtnApiStatus_typ* Pointer to status type to be populated with info about action. Optional
Return callStatus USINT Returns a 0 when successful

atnCyclic()

Cyclic function for Directors.

Direction Name Type Description
In pDirector Atn_typ* Pointer to director
Return callStatus USINT Returns a 0 when successful

atnRegisterActionPV()

Register Module by name to Action name. Non global PVs will need to start with the task name then variable name seperated by a colon. See VarTools for more information on finding PVs by name.

Direction Name Type Description
In namespace STRING Namespace to register action to
In name STRING Name of action for module to be registered as
In actionPv STRING Name of PV to be used as action
In parameterPv STRING Name of PV to be used for parameters
Return callStatus USINT Returns a 0 when successful

atnRegisterActionPVLocal()

Register Module by name to Action name. Task name will not need to be included in PV names as they are will be searched for in local task. This fn will not find global variables.

Direction Name Type Description
In namespace STRING Namespace to register action to
In name STRING Name of action for module to be registered as
In actionPv STRING Name of PV without task name to be used as action
In parameterPv STRING Name of PV to be used for parameters
Return callStatus USINT Returns a 0 when successful

atnRegisterAction()

Register Module by address with Action name.

Direction Name Type Description
In namespace STRING Namespace to register action to
In name STRING Name of action for module to be registered as
In pAction UDINT Pointer module of atnAPI_typ*
In pParameter UDINT Pointer location of paremeters that should be passed to action
In parameterSize UDINT Size of paremeter location
Return callStatus USINT Returns a 0 when successful
Made by Loupe