Structs, Types, ...

Collaboration diagram for Structs, Types, ...:

Macros
#define	MLPI_LOGIC_MAX_DIMENSION_OF_ARRAY   ( 3)
#define	MLPI_APPLICATION_MAX_LENGTH_OF_POU_NAME   ( 81)
#define	MLPI_APPLICATION_MAX_LENGTH_OF_TASK_NAME   (260)
#define	MLPI_APPLICATION_MAX_LENGTH_OF_INFO   (260)
#define	MLPI_APPLICATION_OP_STATE_NONE   (0x00000000)
#define	MLPI_APPLICATION_OP_STATE_PROGRAM_LOADED   (0x00000001)
#define	MLPI_APPLICATION_OP_STATE_DOWNLOAD   (0x00000002)
#define	MLPI_APPLICATION_OP_STATE_ONLINE_CHANGE   (0x00000004)
#define	MLPI_APPLICATION_OP_STATE_STORE_BOOTPROJECT   (0x00000008)
#define	MLPI_APPLICATION_OP_STATE_FORCE_ACTIVE   (0x00000010)
#define	MLPI_APPLICATION_OP_STATE_EXCEPTION   (0x00000020)
#define	MLPI_APPLICATION_OP_STATE_RUN_AFTER_DOWNLOAD   (0x00000040)
#define	MLPI_APPLICATION_OP_STATE_STORE_BOOTPROJECT_ONLY   (0x00000080)
#define	MLPI_APPLICATION_OP_STATE_EXIT   (0x00000100)
#define	MLPI_APPLICATION_OP_STATE_DELETE   (0x00000200)
#define	MLPI_APPLICATION_OP_STATE_RESET   (0x00000400)
#define	MLPI_APPLICATION_OP_STATE_RETAIN_MISMATCH   (0x00000800)
#define	MLPI_APPLICATION_OP_STATE_BOOTPROJECT_VALID   (0x00001000)
#define	MLPI_APPLICATION_OP_STATE_LOAD_BOOTPROJECT   (0x00002000)
#define	MLPI_APPLICATION_OP_STATE_FLOW_ACTIVE   (0x00004000)
#define	MLPI_APPLICATION_OP_STATE_RUN_IN_FLASH   (0x00008000)

Typedefs
typedef void(*	MLPIPOUFNCPTR) (void *)
typedef struct MlpiApplicationTaskInfo	MlpiApplicationTaskInfo
typedef struct MlpiApplicationInfo	MlpiApplicationInfo
typedef struct MlpiApplicationOpState	MlpiApplicationOpState
typedef struct MlpiLogicArrayRange	MlpiLogicArrayRange
typedef struct MlpiLogicSymbolInformation	MlpiLogicSymbolInformation
typedef struct MlpiLogicUserTypeInformation	MlpiLogicUserTypeInformation

Enumerations

Detailed Description

List of used types, enumerations, structures and more...

Macro Definition Documentation

#define MLPI_LOGIC_MAX_DIMENSION_OF_ARRAY   ( 3)

Maximum dimension of an array.

Definition at line 484 of file mlpiLogicLib.h.

#define MLPI_APPLICATION_MAX_LENGTH_OF_POU_NAME   ( 81)

Maximum length of name of a POU.

Definition at line 486 of file mlpiLogicLib.h.

#define MLPI_APPLICATION_MAX_LENGTH_OF_TASK_NAME   (260)

Maximum length of name of a task.

Definition at line 487 of file mlpiLogicLib.h.

#define MLPI_APPLICATION_MAX_LENGTH_OF_INFO   (260)

Maximum length of info element of application.

Definition at line 488 of file mlpiLogicLib.h.

#define MLPI_APPLICATION_OP_STATE_NONE   (0x00000000)

Operation states of an application: Unspecified state (init state)

Definition at line 490 of file mlpiLogicLib.h.

#define MLPI_APPLICATION_OP_STATE_PROGRAM_LOADED   (0x00000001)

Operation states of an application: Application is completely loaded.

Definition at line 491 of file mlpiLogicLib.h.

#define MLPI_APPLICATION_OP_STATE_DOWNLOAD   (0x00000002)

Operation states of an application: Application download in progress.

Definition at line 492 of file mlpiLogicLib.h.

#define MLPI_APPLICATION_OP_STATE_ONLINE_CHANGE   (0x00000004)

Operation states of an application: Application online-change in progress.

Definition at line 493 of file mlpiLogicLib.h.

#define MLPI_APPLICATION_OP_STATE_STORE_BOOTPROJECT   (0x00000008)

Operation states of an application: Store bootproject in progress.

Definition at line 494 of file mlpiLogicLib.h.

#define MLPI_APPLICATION_OP_STATE_FORCE_ACTIVE   (0x00000010)

Operation states of an application: Force values is active on the application.

Definition at line 495 of file mlpiLogicLib.h.

#define MLPI_APPLICATION_OP_STATE_EXCEPTION   (0x00000020)

Operation states of an application: Application is in exception state (an exception occurred in this application)

Definition at line 496 of file mlpiLogicLib.h.

#define MLPI_APPLICATION_OP_STATE_RUN_AFTER_DOWNLOAD   (0x00000040)

Operation states of an application: Download code at the end of download is in progress (initialization of the application)

Definition at line 497 of file mlpiLogicLib.h.

#define MLPI_APPLICATION_OP_STATE_STORE_BOOTPROJECT_ONLY   (0x00000080)

Operation states of an application: Only the boot project is stored at download.

Definition at line 498 of file mlpiLogicLib.h.

#define MLPI_APPLICATION_OP_STATE_EXIT   (0x00000100)

Operation states of an application: Application exit is still executed (application is no longer active)

Definition at line 499 of file mlpiLogicLib.h.

#define MLPI_APPLICATION_OP_STATE_DELETE   (0x00000200)

Operation states of an application: Application is deleted (object is available, but the content is deleted)

Definition at line 500 of file mlpiLogicLib.h.

#define MLPI_APPLICATION_OP_STATE_RESET   (0x00000400)

Operation states of an application: Application reset is in progress.

Definition at line 501 of file mlpiLogicLib.h.

#define MLPI_APPLICATION_OP_STATE_RETAIN_MISMATCH   (0x00000800)

Operation states of an application: Retain mismatch occurred during loading the boot project (retain data does not match the application)

Definition at line 502 of file mlpiLogicLib.h.

#define MLPI_APPLICATION_OP_STATE_BOOTPROJECT_VALID   (0x00001000)

Operation states of an application: Boot project available (boot project matched running application in RAM)

Definition at line 503 of file mlpiLogicLib.h.

#define MLPI_APPLICATION_OP_STATE_LOAD_BOOTPROJECT   (0x00002000)

Operation states of an application: Loading of the boot project in progress.

Definition at line 504 of file mlpiLogicLib.h.

#define MLPI_APPLICATION_OP_STATE_FLOW_ACTIVE   (0x00004000)

Operation states of an application: Flow control active.

Definition at line 505 of file mlpiLogicLib.h.

#define MLPI_APPLICATION_OP_STATE_RUN_IN_FLASH   (0x00008000)

Operation states of an application: Application is running in flash.

Definition at line 506 of file mlpiLogicLib.h.

Typedef Documentation

typedef void(* MLPIPOUFNCPTR) (void *)

MLPI POU function pointer 'void function(void*);'.

Definition at line 652 of file mlpiLogicLib.h.

MlpiApplicationTaskInfo

This structure defines the information about an IEC task using mlpiLogicGetTaskInfoOfApplication.

Elements of struct MlpiApplicationTaskInfo

Type	Element	Description.
WCHAR16[]	name	name of the IEC task.
ULONG	priority	priority of the IEC task.
BOOL8	watchdog	state of watchdog enabling.
ULONG	watchdogTime	watchdog time.
ULONG	cycleTime	cycletime of the IEC task.
ULONG	averageCycleTime	average cycletime of the IEC task.
ULONG	maxCycleTime	maximum cycletime of the IEC task.
ULONG	minCycleTime	minimum cycletime of the IEC task.
ULONG	cycleCount	actual cycleCount of the IEC task.

MlpiApplicationInfo

This structure defines the information about the application using mlpiLogicGetInfoOfApplication.

Elements of struct MlpiApplicationInfo

Type	Element	Description
WCHAR16[]	name	name of project.
WCHAR16[]	author	author of application.
WCHAR16[]	version	version of application (e.g. "1.0.0.0").
WCHAR16[]	description	description of application.
WCHAR16[]	profile	profile of application.
MlpiDateAndTime	dateTime	date and time of last modification (e.g. "2010-12-31 12:00:00") (UTC).

MlpiApplicationOpState

This structure defines the operation states of an application using mlpiLogicGetOperationStateOfApplication.

Elements of struct MlpiApplicationOpState

Type	Element	Description
BOOL8	none	Unspecified state (init state).
BOOL8	loaded	Application is completely loaded.
BOOL8	downloadActive	Application download in progress.
BOOL8	onlineChangeActive	Application online-change in progress.
BOOL8	storeBootprojectActive	Storing of bootproject in progress.
BOOL8	forceVariablesActive	Force values is active on the application.
BOOL8	exception	Application is in exception state (an exception occurred in this application).
BOOL8	initializeActive	Download code at the end of download is in progress (initialization of the application).
BOOL8	storeBootprojectOnlyActive	Only the bootproject is stored at download.
BOOL8	exitActive	Application exit is still executed (application is no longer active).
BOOL8	deleted	Application is deleted (object is available, but the content is deleted).
BOOL8	resetActive	Application reset is in progress.
BOOL8	retainMismatch	Retain mismatch occurred during loading of the boot project (retain data does not match the application).
BOOL8	bootprojectValid	Boot project available (boot project matched running application in RAM).
BOOL8	loadBootprojectActive	Loading of boot project in progress.
BOOL8	flowControlActive	Flow control active.
BOOL8	runInFlash	Application is running in flash.

MlpiLogicArrayRange

This structure defines the range of an array dimension.

Elements of struct MlpiLogicArrayRange

Type	Element	Description
ULONG	minimum	Minimum range value of array.
ULONG	maximum	Maximum range value of array.

MlpiLogicSymbolInformation

This structure defines the information about a symbol using mlpiLogicGetInformationOfSymbol.

Elements of struct MlpiLogicSymbolInformation

Type	Element	Description
MlpiLogicType	type	Type of symbol.
MlpiLogicType	subType	Type of symbol if 'type' equal MLPI_LOGIC_TYPE_ARRAY.
ULONG	dataSize	Size of symbol (bytes).
ULONG	numElements	Number of elements.
ULONG	dimension	Dimension of array if 'type' equal MLPI_LOGIC_TYPE_ARRAY.
MlpiLogicArrayRange	range	Range of a dimension of array if 'type' equal MLPI_LOGIC_TYPE_ARRAY.
MlpiLogicSymbolAccessRights	accessRights	Access rights to symbol.

MlpiLogicUserTypeInformation

This structure defines the information about a type of a symbol using mlpiLogicGetInformationOfUserType.

Elements of struct MlpiLogicSymbolInformation

Type	Element	Description
WCHAR16	name	Name of user type variable.
MlpiLogicSymbolInformation	info	Information about user type variable.

Enumeration Type Documentation

enum MlpiApplicationState

This enumeration defines the state of an application using mlpiLogicGetStateOfApplication.

Enumerator
MLPI_STATE_NONE	Invalid state of application.
MLPI_STATE_RUN	The application is in state RUN.
MLPI_STATE_STOP	The application is in state STOP.
MLPI_STATE_BP	The application is halted on breakpoint.
MLPI_STATE_SINGLE_CYCLE	The application runs for one single cycle.

Definition at line 513 of file mlpiLogicLib.h.

enum MlpiApplicationResetMode

This enumeration defines the different reset possibilities of an application using mlpiLogicResetApplication.

Enumerator
MLPI_RESET_WARM	Reset warm of application, all global data except retain data is reset to default.
MLPI_RESET_COLD	Reset cold of application, all global data and (!) retain data is reset to default.
MLPI_RESET_ORIGIN	Reset application back to origin, delete application, delete all application files (boot project, etc.), reset all global and retain data.

Definition at line 524 of file mlpiLogicLib.h.

enum MlpiApplicationEvent

This enumeration defines the event of an application using by mlpiLogicWaitForEventOfApplication.

Enumerator
MLPI_APPLICATIONEVENT_START_INIT	This event raises on begin of 'start application' sequence.
MLPI_APPLICATIONEVENT_START_DONE	This event raises on end of 'start application' sequence.
MLPI_APPLICATIONEVENT_STOP_INIT	This event raises on begin of 'stop application' sequence.
MLPI_APPLICATIONEVENT_STOP_DONE	This event raises on end of 'stop application' sequence.
MLPI_APPLICATIONEVENT_RESET_INIT	This event raises on begin of 'reset application' sequence.
MLPI_APPLICATIONEVENT_RESET_DONE	This event raises on end of 'reset application' sequence.
MLPI_APPLICATIONEVENT_ONLINE_CHANGE_INIT	This event raises on begin of 'online change application' sequence.
MLPI_APPLICATIONEVENT_ONLINE_CHANGE_DONE	This event raises on end of 'online change application' sequence.
MLPI_APPLICATIONEVENT_DOWNLOAD_INIT	This event raises on begin of 'download application' sequence.
MLPI_APPLICATIONEVENT_DOWNLOAD_DONE	This event raises on end of 'download application' sequence.
MLPI_APPLICATIONEVENT_DELETE_INIT	This event raises on begin of 'delete application' sequence.
MLPI_APPLICATIONEVENT_DELETE_DONE	This event raises on end of 'delete application' sequence.
MLPI_APPLICATIONEVENT_EXIT_INIT	This event raises on begin of 'exit application' sequence.
MLPI_APPLICATIONEVENT_EXIT_DONE	This event raises on end of 'exit application' sequence.
MLPI_APPLICATIONEVENT_EXCEPTION	This event raises on an exception of application.
MLPI_APPLICATIONEVENT_OP_STATE_CHANGE	This event raises on change of operation state of application ( ref@ MlpiApplicationOpState ).

Definition at line 533 of file mlpiLogicLib.h.

enum MlpiApplicationMemoryArea

This enumeration defines the memory areas 'Ix' (Input), 'Qx' (Output) and 'Mx' (Marker) of an application.

Enumerator
MLPI_MEMORY_AREA_INPUT	'Ix' input memory area (Input) of an application.
MLPI_MEMORY_AREA_OUTPUT	'Qx' output memory area (Output) of an application.
MLPI_MEMORY_AREA_MARKER	'Mx' marker memory area (Marker) of an application.

Definition at line 555 of file mlpiLogicLib.h.

enum MlpiLogicCapabilityOperation

This enumeration defines an operation which can be enabled or disabled by mlpiLogicSetCapabilityOfOperation. The current capability can be read by mlpiLogicGetCapabilityOfOperation . The capability will be set globally for all applications.

Enumerator
MLPI_LOGIC_CAP_OPERATION_STOP	Capability to execute the operation 'stop application'.
MLPI_LOGIC_CAP_OPERATION_RESET	Capability to execute the operation 'reset application'.
MLPI_LOGIC_CAP_OPERATION_DOWNLOAD	Capability to execute the operation 'download application'.
MLPI_LOGIC_CAP_OPERATION_ONLINE_CHANGE	Capability to execute the operation 'online change application'.
MLPI_LOGIC_CAP_OPERATION_SET_BREAKPOINT	Capability to execute the operation 'set breakpoint into an application'.
MLPI_LOGIC_CAP_OPERATION_WRITE_VARIABLE	Capability to execute the operation 'write variable of application'.
MLPI_LOGIC_CAP_OPERATION_FORCE_VARIABLE	Capability to execute the operation 'force variable of application'.

Definition at line 566 of file mlpiLogicLib.h.

enum MlpiLogicCapabilityOperationValue

This enumeration defines the possible capability to execute an operation.

Enumerator
MLPI_LOGIC_CAP_OPERATION_ENABLE	Enable capability to execute an operation (default).
MLPI_LOGIC_CAP_OPERATION_DISABLE	Disable capability to execute an operation.

Definition at line 579 of file mlpiLogicLib.h.

enum MlpiLogicSymbolAccessRights

This enumeration defines the access rights to a variable using mlpiLogicGetAccessRightsOfSymbol.

Enumerator
MLPI_ACCESS_RIGHTS_NONE	No access rights to the variable.
MLPI_ACCESS_RIGHTS_READ	Read access rights to the variable.
MLPI_ACCESS_RIGHTS_WRITE	Write access rights to the variable.
MLPI_ACCESS_RIGHTS_READWRITE	Read and write access rights to the variable.

Definition at line 587 of file mlpiLogicLib.h.

enum MlpiLogicType

This enumeration defines the different symbol types of the logic using mlpiLogicGetTypeOfSymbol.

Enumerator
MLPI_LOGIC_TYPE_BOOL	1 Byte (BOOL8)
MLPI_LOGIC_TYPE_BIT	Symbolic access unsupported (1 Bit)
MLPI_LOGIC_TYPE_BYTE	8 Bit binary (UCHAR)
MLPI_LOGIC_TYPE_WORD	16 Bit binary (USHORT)
MLPI_LOGIC_TYPE_DWORD	32 Bit binary (ULONG)
MLPI_LOGIC_TYPE_LWORD	64 Bit binary (ULLONG)
MLPI_LOGIC_TYPE_SINT	1 Byte signed short integer (CHAR)
MLPI_LOGIC_TYPE_INT	2 Byte signed integer (SHORT)
MLPI_LOGIC_TYPE_DINT	4 Byte signed double integer (LONG)
MLPI_LOGIC_TYPE_LINT	8 Byte signed long integer (LLONG)
MLPI_LOGIC_TYPE_USINT	1 Byte unsigned signed short integer (USHORT)
MLPI_LOGIC_TYPE_UINT	2 Byte unsigned signed integer (USHORT)
MLPI_LOGIC_TYPE_UDINT	4 Byte unsigned double integer (ULONG)
MLPI_LOGIC_TYPE_ULINT	8 Byte unsigned long integer (ULLONG)
MLPI_LOGIC_TYPE_REAL	4 Byte floating point IEC 559 - 4 Byte (FLOAT)
MLPI_LOGIC_TYPE_LREAL	8 Byte floating point IEC 559 - 8 Byte (DOUBLE)
MLPI_LOGIC_TYPE_STRING	1 Byte character strings (use WCHAR16 string)
MLPI_LOGIC_TYPE_WSTRING	2 Byte character strings (WCHAR16)
MLPI_LOGIC_TYPE_TIME	4 Byte, time is given in milliseconds (ULONG)
MLPI_LOGIC_TYPE_DATE	4 Byte, time is given in seconds beginning with January 1, 1970 at 12:00 a.m. (00:00 a.m.) (ULONG)
MLPI_LOGIC_TYPE_DATEANDTIME	4 Byte, time is given in seconds beginning with January 1, 1970 at 12:00 a.m. (00:00 a.m.) (ULONG)
MLPI_LOGIC_TYPE_TIMEOFDAY	4 Byte, time is given in milliseconds, time begins at 12:00 a.m. (00:00 a.m.) (ULONG)
MLPI_LOGIC_TYPE_POINTER	Symbolic access unsupported.
MLPI_LOGIC_TYPE_REFERENCE	Symbolic access unsupported.
MLPI_LOGIC_TYPE_SUBRANGE	Symbolic access unsupported.
MLPI_LOGIC_TYPE_ENUM	2 byte user type (SHORT)
MLPI_LOGIC_TYPE_ARRAY	Array (use element type, base types or VOID in case of complex type)
MLPI_LOGIC_TYPE_PARAMS	Symbolic access unsupported.
MLPI_LOGIC_TYPE_USERDEF	RAW data (VOID)
MLPI_LOGIC_TYPE_NONE	Symbolic access unsupported.
MLPI_LOGIC_TYPE_ANY	Symbolic access unsupported.
MLPI_LOGIC_TYPE_ANYBIT	Symbolic access unsupported.
MLPI_LOGIC_TYPE_ANYDATE	Symbolic access unsupported.
MLPI_LOGIC_TYPE_ANYINT	Symbolic access unsupported.
MLPI_LOGIC_TYPE_ANYNUM	Symbolic access unsupported.
MLPI_LOGIC_TYPE_ANYREAL	Symbolic access unsupported.
MLPI_LOGIC_TYPE_LAZY	Symbolic access unsupported.
MLPI_LOGIC_TYPE_LTIME	Symbolic access unsupported.
MLPI_LOGIC_TYPE_BITCONST	Symbolic access unsupported.
MLPI_LOGIC_TYPE_MAX_TYPE	Symbolic access unsupported.
MLPI_LOGIC_TYPE_UNSUPPORTED	Symbolic access unsupported.

Definition at line 597 of file mlpiLogicLib.h.