Structs, Types, ...

Collaboration diagram for Structs, Types, ...:

Macros
#define	MLPI_SIDN_TYPE_DRIVE_S   (0x0000000000ULL)
#define	MLPI_SIDN_TYPE_DRIVE_P   (0x0000008000ULL)
#define	MLPI_SIDN_TYPE_AXIS   (0x0100000000ULL)
#define	MLPI_SIDN_TYPE_CONTROL   (0x0200000000ULL)
#define	MLPI_SIDN_TYPE_KINEMATIC   (0x2B00000000ULL)
#define	MLPI_SIDN_TYPE_PROBE   (0x2D00000000ULL)
#define	MLPI_SIDN_TYPE_POSLIMSWITCH   (0x2E00000000ULL)
#define	MLPI_SIDN_TYPE_OSCILLOSCOPE   (0x2F00000000ULL)
#define	MLPI_SIDN_INSTANCE_MASK   (0xFF00000000000000ULL)
#define	MLPI_SIDN_TYPE_MASK   (0xFF00008000ULL)
#define	MLPI_SIDN_SET_MASK   (0x00007000)
#define	MLPI_SIDN_BLOCK_MASK   (0x00000FFF)
#define	MLPI_SIDN_SE_MASK   (0x00FF0000)
#define	MLPI_SIDN_SI_MASK   (0xFF000000)
#define	MLPI_ADDRESS_MODE_LOGICAL   (0x0000000000000000ULL)
#define	MLPI_ADDRESS_MODE_PHYSICAL   (0x0000000000000001ULL)
#define	MLPI_ADDRESS_MODE_TOPOLOGICAL   (0x0000000000000002ULL)
#define	MLPI_ADDRESS_MODE_LOGICAL_NATIVE   (0x0000000000000003ULL)
#define	MLPI_ADDRESS_SLAVE_MASK   (0x000000000000FFFFULL)
#define	MLPI_ADDRESS_MASTER_MASK   (0x00000000FFFF0000ULL)
#define	MLPI_ADDRESS_MODE_MASK   (0x000000FF00000000ULL)
#define	MLPI_SIDN(type, set, block, si, se)
#define	MLPI_SIDN_A(block)   (MLPI_SIDN(MLPI_SIDN_TYPE_AXIS, 0, block, 0, 0))
#define	MLPI_SIDN_C(block)   (MLPI_SIDN(MLPI_SIDN_TYPE_CONTROL, 0, block,0, 0))
#define	MLPI_SIDN_K(block)   (MLPI_SIDN(MLPI_SIDN_TYPE_KINEMATIC, 0, block, 0, 0))
#define	MLPI_SIDN_M(block)   (MLPI_SIDN(MLPI_SIDN_TYPE_PROBE, 0, block, 0, 0))
#define	MLPI_SIDN_N(block)   (MLPI_SIDN(MLPI_SIDN_TYPE_POSLIMSWITCH, 0, block, 0, 0))
#define	MLPI_SIDN_O(block)   (MLPI_SIDN(MLPI_SIDN_TYPE_OSCILLOSCOPE, 0, block, 0, 0))
#define	MLPI_SIDN_S(block)   (MLPI_SIDN(MLPI_SIDN_TYPE_DRIVE_S, 0, block, 0, 0))
#define	MLPI_SIDN_P(block)   (MLPI_SIDN(MLPI_SIDN_TYPE_DRIVE_P, 0, block, 0, 0))
#define	MLPI_SIDN_INST(sidn)    ( (UCHAR) ((sidn & MLPI_SIDN_INSTANCE_MASK ) >> 56 ) )
#define	MLPI_SIDN_TYPE(sidn)    ( (ULLONG) ((sidn & MLPI_SIDN_TYPE_MASK ) ) )
#define	MLPI_SIDN_SET(sidn)    ( (UCHAR) ((sidn & MLPI_SIDN_SET_MASK ) >> 12 ) )
#define	MLPI_SIDN_BLOCK(sidn)    ( (USHORT) ((sidn & MLPI_SIDN_BLOCK_MASK) ) )
#define	MLPI_SIDN_SI(sidn)    ( (UCHAR) ((sidn & MLPI_SIDN_SI_MASK ) >> 24 ) )
#define	MLPI_SIDN_SE(sidn)    ( (UCHAR) ((sidn & MLPI_SIDN_SE_MASK ) >> 16 ) )
#define	MLPI_ADDRESS(mode, master, slave)
#define	MLPI_PARAMETER_EIDN_MAX_LENGTH_OF_NAME   ( 60)
#define	MLPI_PARAMETER_EIDN_MAX_LENGTH_OF_UNIT   ( 12)
#define	MLPI_PARAMETER_EIDN_MAX_LENGTH_OF_DATA   (65532)

Typedefs
typedef struct MlpiSidnError	MlpiSidnError
typedef struct MlpiReadEverything	MlpiReadEverything
typedef struct MlpiParamProcessStatus	MlpiParamProcessStatus
typedef struct MlpiParamWriteAccess	MlpiParamWriteAccess

Enumerations

Detailed Description

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

Macro Definition Documentation

#define MLPI_SIDN_TYPE_DRIVE_S   (0x0000000000ULL)

This definition represents the valid type of an S parameter ident.

Definition at line 440 of file mlpiParameterLib.h.

#define MLPI_SIDN_TYPE_DRIVE_P   (0x0000008000ULL)

This definition represents the valid type of a P parameter ident.

Definition at line 443 of file mlpiParameterLib.h.

#define MLPI_SIDN_TYPE_AXIS   (0x0100000000ULL)

This definition represents the valid type of an A parameter ident.

Definition at line 446 of file mlpiParameterLib.h.

#define MLPI_SIDN_TYPE_CONTROL   (0x0200000000ULL)

This definition represents the valid type of a C parameter ident.

Definition at line 449 of file mlpiParameterLib.h.

#define MLPI_SIDN_TYPE_KINEMATIC   (0x2B00000000ULL)

This definition represents the valid type of a K parameter ident.

Definition at line 452 of file mlpiParameterLib.h.

#define MLPI_SIDN_TYPE_PROBE   (0x2D00000000ULL)

This definition represents the valid type of an M parameter ident.

Definition at line 455 of file mlpiParameterLib.h.

#define MLPI_SIDN_TYPE_POSLIMSWITCH   (0x2E00000000ULL)

This definition represents the valid type of an N parameter ident.

Definition at line 458 of file mlpiParameterLib.h.

#define MLPI_SIDN_TYPE_OSCILLOSCOPE   (0x2F00000000ULL)

This definition represents the valid type of an O parameter ident.

Definition at line 461 of file mlpiParameterLib.h.

#define MLPI_SIDN_INSTANCE_MASK   (0xFF00000000000000ULL)

This definition masks the instance address of a parameter ident.

Definition at line 464 of file mlpiParameterLib.h.

#define MLPI_SIDN_TYPE_MASK   (0xFF00008000ULL)

This definition masks the element type of a parameter ident.

Definition at line 467 of file mlpiParameterLib.h.

#define MLPI_SIDN_SET_MASK   (0x00007000)

This definition masks the element set of a parameter ident.

Definition at line 470 of file mlpiParameterLib.h.

#define MLPI_SIDN_BLOCK_MASK   (0x00000FFF)

This definition masks the element block of a parameter ident.

Definition at line 473 of file mlpiParameterLib.h.

#define MLPI_SIDN_SE_MASK   (0x00FF0000)

This definition masks the element SE of a parameter ident.

Definition at line 476 of file mlpiParameterLib.h.

#define MLPI_SIDN_SI_MASK   (0xFF000000)

This definition masks the element SI of a parameter ident.

Definition at line 479 of file mlpiParameterLib.h.

#define MLPI_ADDRESS_MODE_LOGICAL   (0x0000000000000000ULL)

Address the object by its logical address given in the lower 4 bytes.

Note

In case of using the logical addressing (MLPI_ADDRESS_MODE_LOGICAL) on S and P parameter access all values will be automatically converted to DOUBLE if decimal places unequal nil. In this case the regarding attribute will be also adapted to "data type / display format" "floating point number".
To switched of this feature please use the natvive logical addressing (MLPI_ADDRESS_MODE_LOGICAL_NATIVE) on S and P parameter access.

Definition at line 498 of file mlpiParameterLib.h.

#define MLPI_ADDRESS_MODE_PHYSICAL   (0x0000000000000001ULL)

Address the object by its physical address(sercos device address) given in the lower 4 bytes.

Definition at line 501 of file mlpiParameterLib.h.

#define MLPI_ADDRESS_MODE_TOPOLOGICAL   (0x0000000000000002ULL)

Address the object by its topological address(position in the ring) given in the lower 4 bytes.

Definition at line 504 of file mlpiParameterLib.h.

#define MLPI_ADDRESS_MODE_LOGICAL_NATIVE   (0x0000000000000003ULL)

Address the object by its logical address given in the lower 4 bytes, but don't convert value and attribute. Using this address mode within any other parameter access than S or P parameter will be handled like using the logical addressing mode MLPI_ADDRESS_MODE_LOGICAL.

Definition at line 509 of file mlpiParameterLib.h.

#define MLPI_ADDRESS_SLAVE_MASK   (0x000000000000FFFFULL)

This definition masks the slave address of an address ident.

Definition at line 513 of file mlpiParameterLib.h.

#define MLPI_ADDRESS_MASTER_MASK   (0x00000000FFFF0000ULL)

This definition masks the master address of an address ident.

Definition at line 516 of file mlpiParameterLib.h.

#define MLPI_ADDRESS_MODE_MASK   (0x000000FF00000000ULL)

This definition masks the address mode of an address ident.

Definition at line 519 of file mlpiParameterLib.h.

#define MLPI_SIDN	(		type,
			set,
			block,
			si,
			se
	)

Value:

( (ULLONG)  ( \
  (  ( ((ULLONG) type )      ) & MLPI_SIDN_TYPE_MASK  ) | \
  (  ( ((ULLONG) set  ) << 12) & MLPI_SIDN_SET_MASK   ) | \
  (  ( ((ULLONG) block)      ) & MLPI_SIDN_BLOCK_MASK ) | \
  (  ( ((ULLONG) si   ) << 24) & MLPI_SIDN_SI_MASK    ) | \
  (  ( ((ULLONG) se   ) << 16) & MLPI_SIDN_SE_MASK    ) ) )

This macro creates the 64-bit value of an EIDN like <TYPE-SET-BLOCK>.<SI>.<SE> using all elements of parameter ident number.

Parameters

type	Type of parameter such as A, C, ... . Use definitions MLPI_SIDN_TYPE_AXIS, MLPI_SIDN_TYPE_CONTROL, ... to set it.
set	Set of parameter (value: 0..7).
block	Block of parameter (value: 0..4095).
si	SI
se	SE

Returns

The 64-bit SIDN.

Definition at line 539 of file mlpiParameterLib.h.

#define MLPI_SIDN_A

(

block

)

(MLPI_SIDN(MLPI_SIDN_TYPE_AXIS, 0, block, 0, 0))

This easy-to-use macro creates the 64-bit value of an A parameter EIDN like <TYPE-SET-BLOCK>.<SI>.<SE> using the block value.

Parameters

block

Block of parameter (value: 0..4095).

Returns

The 64-bit SIDN.

Definition at line 550 of file mlpiParameterLib.h.

#define MLPI_SIDN_C

(

block

)

(MLPI_SIDN(MLPI_SIDN_TYPE_CONTROL, 0, block,0, 0))

This easy-to-use macro creates the 64-bit value of an C parameter EIDN like <TYPE-SET-BLOCK>.<SI>.<SE> using the block value.

Parameters

block

Block of parameter (value: 0..4095).

Returns

The 64-bit SIDN.

Definition at line 556 of file mlpiParameterLib.h.

#define MLPI_SIDN_K

(

block

)

(MLPI_SIDN(MLPI_SIDN_TYPE_KINEMATIC, 0, block, 0, 0))

This easy-to-use macro creates the 64-bit value of a K parameter EIDN like <TYPE-SET-BLOCK>.<SI>.<SE> using the block value.

Parameters

block

Block of parameter (value: 0..4095).

Returns

The 64-bit SIDN.

Definition at line 562 of file mlpiParameterLib.h.

#define MLPI_SIDN_M

(

block

)

(MLPI_SIDN(MLPI_SIDN_TYPE_PROBE, 0, block, 0, 0))

This easy-to-use macro creates the 64-bit value of an M parameter EIDN like <TYPE-SET-BLOCK>.<SI>.<SE> using the block value.

Parameters

block

Block of parameter (value: 0..4095).

Returns

The 64-bit SIDN.

Definition at line 568 of file mlpiParameterLib.h.

#define MLPI_SIDN_N

(

block

)

(MLPI_SIDN(MLPI_SIDN_TYPE_POSLIMSWITCH, 0, block, 0, 0))

This easy-to-use macro creates the 64-bit value of an N parameter EIDN like <TYPE-SET-BLOCK>.<SI>.<SE> using the block value.

Parameters

block

Block of parameter (value: 0..4095).

Returns

The 64-bit SIDN.

Definition at line 574 of file mlpiParameterLib.h.

#define MLPI_SIDN_O

(

block

)

(MLPI_SIDN(MLPI_SIDN_TYPE_OSCILLOSCOPE, 0, block, 0, 0))

This easy-to-use macro creates the 64-bit value of an O parameter EIDN like <TYPE-SET-BLOCK>.<SI>.<SE> using the block value.

Parameters

block

Block of parameter (value: 0..4095).

Returns

The 64-bit SIDN.

Definition at line 580 of file mlpiParameterLib.h.

#define MLPI_SIDN_S

(

block

)

(MLPI_SIDN(MLPI_SIDN_TYPE_DRIVE_S, 0, block, 0, 0))

This easy-to-use macro creates the 64-bit value of an S parameter EIDN like <TYPE-SET-BLOCK>.<SI>.<SE> using the block value.

Parameters

block

Block of parameter (value: 0..4095).

Returns

The 64-bit SIDN.

Definition at line 586 of file mlpiParameterLib.h.

#define MLPI_SIDN_P

(

block

)

(MLPI_SIDN(MLPI_SIDN_TYPE_DRIVE_P, 0, block, 0, 0))

This easy-to-use macro creates the 64-bit value of a P parameter EIDN like <TYPE-SET-BLOCK>.<SI>.<SE> using the block value.

Parameters

block

Block of parameter (value: 0..4095).

Returns

The 64-bit SIDN.

Definition at line 592 of file mlpiParameterLib.h.

#define MLPI_SIDN_INST

(

sidn

)

( (UCHAR) ((sidn & MLPI_SIDN_INSTANCE_MASK ) >> 56 ) )

This macro splits an EIDN address like <INSTANCE>:<TYPE-SET-BLOCK>.<SI>.<SE>

Parameters

sidn	64-bit parameter ident number

Returns

The 8-bit instance address.

Definition at line 597 of file mlpiParameterLib.h.

#define MLPI_SIDN_TYPE

(

sidn

)

( (ULLONG) ((sidn & MLPI_SIDN_TYPE_MASK ) ) )

This macro splits an EIDN type like <TYPE-SET-BLOCK>.<SI>.<SE>

Parameters

sidn	64-bit parameter ident number

Returns

The 64-bit type.

Definition at line 602 of file mlpiParameterLib.h.

#define MLPI_SIDN_SET

(

sidn

)

( (UCHAR) ((sidn & MLPI_SIDN_SET_MASK ) >> 12 ) )

This macro splits an EIDN set like <TYPE-SET-BLOCK>.<SI>.<SE>

Parameters

sidn	64-bit parameter ident number

Returns

The 8-bit set value.

Definition at line 607 of file mlpiParameterLib.h.

#define MLPI_SIDN_BLOCK

(

sidn

)

( (USHORT) ((sidn & MLPI_SIDN_BLOCK_MASK) ) )

This macro splits an EIDN block like <TYPE-SET-BLOCK>.<SI>.<SE>

Parameters

sidn	64-bit parameter ident number

Returns

The 16-bit block value.

Definition at line 612 of file mlpiParameterLib.h.

#define MLPI_SIDN_SI

(

sidn

)

( (UCHAR) ((sidn & MLPI_SIDN_SI_MASK ) >> 24 ) )

This macro splits an EIDN SI like <TYPE-SET-BLOCK>.<SI>.<SE>

Parameters

sidn	64-bit parameter ident number

Returns

The 8-bit SI value.

Definition at line 617 of file mlpiParameterLib.h.

#define MLPI_SIDN_SE

(

sidn

)

( (UCHAR) ((sidn & MLPI_SIDN_SE_MASK ) >> 16 ) )

This macro splits an EIDN SE like <TYPE-SET-BLOCK>.<SI>.<SE>

Parameters

sidn	64-bit parameter ident number

Returns

The 8-bit SE value.

Definition at line 622 of file mlpiParameterLib.h.

#define MLPI_ADDRESS	(		mode,
			master,
			slave
	)

Value:

( (ULLONG)            ( \
  (  ( ((ULLONG) mode   ) << 32 ) & MLPI_ADDRESS_MODE_MASK    ) | \
  (  ( ((ULLONG) master ) << 16 ) & MLPI_ADDRESS_MASTER_MASK  ) | \
  (  ( ((ULLONG) slave  )       ) & MLPI_ADDRESS_SLAVE_MASK   ) ) )

This macro creates the 64-bit address identifier.

Parameters

mode	Type of address (logical, physical, topological). The slave element of this address identifier is interpreted based on this selection. Use the definitions MLPI_ADDRESS_MODE_LOGICAL, MLPI_ADDRESS_MODE_PHYSICAL, MLPI_ADDRESS_MODE_TOPOLOGICAL or MLPI_ADDRESS_MODE_LOGICAL_NATIVE to set it.
master	Master address.
slave	Slave address.

Returns

The 64-bit address identifier.

Definition at line 636 of file mlpiParameterLib.h.

#define MLPI_PARAMETER_EIDN_MAX_LENGTH_OF_NAME   ( 60)

This definition represents the maximum number of characters of the sercos parameter element 'name'.

of sercos specification

Definition at line 651 of file mlpiParameterLib.h.

#define MLPI_PARAMETER_EIDN_MAX_LENGTH_OF_UNIT   ( 12)

This definition represents the maximum number of characters of the sercos parameter element 'unit'.

Definition at line 654 of file mlpiParameterLib.h.

#define MLPI_PARAMETER_EIDN_MAX_LENGTH_OF_DATA   (65532)

This definition represents the maximum number of bytes of the sercos parameter element 'data'.

Definition at line 657 of file mlpiParameterLib.h.

Typedef Documentation

MlpiSidnError

This structure defines the information returned in case an error occurred during parameter import or export.

Elements of struct MlpiSidnError

Type	Element	Description
ULLONG	parameterNumber	SIDN of parameter which has an error during import or export.
ULONG	errorCode	Error code of occurred error.

MlpiReadEverything

This structure defines the information returned using mlpiParameterReadEverything.

Elements of struct MlpiReadEverything

Type	Direction	Element	Description
ULLONG	[in]	address	Address identifying the object to access. Use macro MLPI_ADDRESS_x to generate an address field.
ULLONG	[in]	sidn	ID of parameter to be accessed. Use macro MLPI_SIDN_x to get the desired ID.
ULONG	[out]	validElements	Bitmask of elements, which are valid in this response invalid length elements are set to nil.
ULONG	[out]	dataStatus	Data status of the parameter (Parameter structure, sercos element 1).
ULONG	[out]	nameOffset	Offset in the buffer where the name of the parameter stands. The name is an null-terminated WCHAR16 string (Parameter structure, sercos element 2).
ULONG	[out]	attribute	Attribute of the parameter (Parameter structure, sercos element 3).
ULONG	[out]	unitOffset	Offset in the buffer where the unit of the parameter stands. The unit is an null-terminated WCHAR16 string (Parameter structure, sercos element 4).
ULONG	[out]	minOffset	Offset in the buffer where the minimum value of the parameter stands. (Parameter structure, sercos element 5).
ULONG	[out]	maxOffset	Offset in the buffer where the maximum value of the parameter stands. (Parameter structure, sercos element 6).
ULONG	[out]	dataLength	Length of minimum, maximum and data in octets. Length of one list element if parameter is a list.
ULONG	[out]	dataOffset	Offset in the buffer where the data value of the parameter stands (Parameter structure, sercos element 7)
ULONG	[out]	dataSize	Length of data in octets.
ULONG	[out]	maxDataSize	Maximum length of data in octets. Valid if parameter is a list.
MLPIRESULT	[out]	result	Return value indicating success (>=0) or error (<0).

MlpiParamProcessStatus

This structure defines the information about a parameter process status.

Elements of struct MlpiParamProcessStatus

Type	Element	Description
MlpiParameterProcessType	processType	Type of parameter process (import or export).
MlpiProcessState	processStatus	Status of process.
MLPIRESULT	processResult	Return value of asynchron function.

MlpiParamWriteAccess

This structure defines the information of an parameter used by function mlpiParameterWriteAccessSetup and mlpiParameterWriteAccessStatus.

Elements of struct MlpiParamWriteAccess

Type	Element	Description
ULLONG	address	Address identifying the object to access. Use macro MLPI_ADDRESS_x to generate an address field.
ULLONG	sidn	ID of parameter to be accessed. Use macro MLPI_SIDN_x to get the desired ID.

Enumeration Type Documentation

enum MlpiParameterProcessType

This enumeration defines the type of the parameter process.

Enumerator
MLPI_PARAMETER_PROCESSTYPE_IMPORT	Import.
MLPI_PARAMETER_PROCESSTYPE_EXPORT	Export.

Definition at line 667 of file mlpiParameterLib.h.

enum MlpiParameterCommandStatus

This enumeration defines the status of a command execution using mlpiParameterReadCommandStatus.

Enumerator
MLPI_PARAMETER_COMMAND_INACTIVE	Procedure command has been canceled and is inactive.
MLPI_PARAMETER_COMMAND_SET	Procedure command is set.
MLPI_PARAMETER_COMMAND_EXECUTED_CORRECTLY	Procedure command has been executed correctly.
MLPI_PARAMETER_COMMAND_INTERRUPTED	Procedure command execution is interrupted.
MLPI_PARAMETER_COMMAND_IN_PROGRESS	Procedure command is activated but not yet executed.
MLPI_PARAMETER_COMMAND_ERROR	Error, procedure command execution impossible.
MLPI_PARAMETER_COMMAND_STATUS_INVALID	Error, command status invalid.

Definition at line 675 of file mlpiParameterLib.h.