Open Core Interface - MLPI
MLPI-MotionLogicProgrammingInterface(mlpiCore)  1.26.2
mlpiParameterLib.h File Reference
Include dependency graph for mlpiParameterLib.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

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

Functions

MLPIRESULT mlpiParameterReadName (const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, WCHAR16 *name, const ULONG numElements)
 
MLPIRESULT mlpiParameterReadAttribute (const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, ULONG *attribute)
 
MLPIRESULT mlpiParameterReadUnit (const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, WCHAR16 *unit, const ULONG numElements)
 
MLPIRESULT mlpiParameterReadMinimumChar (const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, CHAR *data)
 
MLPIRESULT mlpiParameterReadMinimumUchar (const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, UCHAR *data)
 
MLPIRESULT mlpiParameterReadMinimumShort (const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, SHORT *data)
 
MLPIRESULT mlpiParameterReadMinimumUshort (const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, USHORT *data)
 
MLPIRESULT mlpiParameterReadMinimumLong (const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, LONG *data)
 
MLPIRESULT mlpiParameterReadMinimumUlong (const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, ULONG *data)
 
MLPIRESULT mlpiParameterReadMinimumLlong (const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, LLONG *data)
 
MLPIRESULT mlpiParameterReadMinimumUllong (const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, ULLONG *data)
 
MLPIRESULT mlpiParameterReadMinimumFloat (const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, FLOAT *data)
 
MLPIRESULT mlpiParameterReadMinimumDouble (const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, DOUBLE *data)
 
MLPIRESULT mlpiParameterReadMinimumString (const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, WCHAR16 *data, const ULONG numElements, ULONG *numElementsRet)
 
MLPIRESULT mlpiParameterReadMaximumChar (const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, CHAR *data)
 
MLPIRESULT mlpiParameterReadMaximumUchar (const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, UCHAR *data)
 
MLPIRESULT mlpiParameterReadMaximumShort (const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, SHORT *data)
 
MLPIRESULT mlpiParameterReadMaximumUshort (const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, USHORT *data)
 
MLPIRESULT mlpiParameterReadMaximumLong (const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, LONG *data)
 
MLPIRESULT mlpiParameterReadMaximumUlong (const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, ULONG *data)
 
MLPIRESULT mlpiParameterReadMaximumLlong (const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, LLONG *data)
 
MLPIRESULT mlpiParameterReadMaximumUllong (const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, ULLONG *data)
 
MLPIRESULT mlpiParameterReadMaximumFloat (const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, FLOAT *data)
 
MLPIRESULT mlpiParameterReadMaximumDouble (const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, DOUBLE *data)
 
MLPIRESULT mlpiParameterReadMaximumString (const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, WCHAR16 *data, const ULONG numElements, ULONG *numElementsRet)
 
MLPIRESULT mlpiParameterReadDataShort (const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, SHORT *data)
 
MLPIRESULT mlpiParameterReadDataUshort (const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, USHORT *data)
 
MLPIRESULT mlpiParameterReadDataLong (const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, LONG *data)
 
MLPIRESULT mlpiParameterReadDataUlong (const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, ULONG *data)
 
MLPIRESULT mlpiParameterReadDataLlong (const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, LLONG *data)
 
MLPIRESULT mlpiParameterReadDataUllong (const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, ULLONG *data)
 
MLPIRESULT mlpiParameterReadDataFloat (const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, FLOAT *data)
 
MLPIRESULT mlpiParameterReadDataDouble (const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, DOUBLE *data)
 
MLPIRESULT mlpiParameterReadDataString (const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, WCHAR16 *data, const ULONG numElements, ULONG *numElementsRet)
 
MLPIRESULT mlpiParameterReadDataArrayVoid (const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, void *data, const ULONG dataSize, ULONG *dataSizeRet)
 
MLPIRESULT mlpiParameterReadDataArrayChar (const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, CHAR *data, const ULONG numElements, ULONG *numElementsRet)
 
MLPIRESULT mlpiParameterReadDataArrayUchar (const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, UCHAR *data, const ULONG numElements, ULONG *numElementsRet)
 
MLPIRESULT mlpiParameterReadDataArrayShort (const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, SHORT *data, const ULONG numElements, ULONG *numElementsRet)
 
MLPIRESULT mlpiParameterReadDataArrayUshort (const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, USHORT *data, const ULONG numElements, ULONG *numElementsRet)
 
MLPIRESULT mlpiParameterReadDataArrayLong (const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, LONG *data, const ULONG numElements, ULONG *numElementsRet)
 
MLPIRESULT mlpiParameterReadDataArrayUlong (const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, ULONG *data, const ULONG numElements, ULONG *numElementsRet)
 
MLPIRESULT mlpiParameterReadDataArrayLlong (const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, LLONG *data, const ULONG numElements, ULONG *numElementsRet)
 
MLPIRESULT mlpiParameterReadDataArrayUllong (const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, ULLONG *data, const ULONG numElements, ULONG *numElementsRet)
 
MLPIRESULT mlpiParameterReadDataArrayFloat (const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, FLOAT *data, const ULONG numElements, ULONG *numElementsRet)
 
MLPIRESULT mlpiParameterReadDataArrayDouble (const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, DOUBLE *data, const ULONG numElements, ULONG *numElementsRet)
 
MLPIRESULT mlpiParameterWriteDataShort (const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, const SHORT data)
 
MLPIRESULT mlpiParameterWriteDataUshort (const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, const USHORT data)
 
MLPIRESULT mlpiParameterWriteDataLong (const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, const LONG data)
 
MLPIRESULT mlpiParameterWriteDataUlong (const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, const ULONG data)
 
MLPIRESULT mlpiParameterWriteDataLlong (const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, const LLONG data)
 
MLPIRESULT mlpiParameterWriteDataUllong (const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, const ULLONG data)
 
MLPIRESULT mlpiParameterWriteDataFloat (const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, const FLOAT data)
 
MLPIRESULT mlpiParameterWriteDataDouble (const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, const DOUBLE data)
 
MLPIRESULT mlpiParameterWriteDataString (const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, const WCHAR16 *data)
 
MLPIRESULT mlpiParameterWriteDataArrayVoid (const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, const void *data, const ULONG dataSize)
 
MLPIRESULT mlpiParameterWriteDataArrayChar (const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, const CHAR *data, const ULONG numElements)
 
MLPIRESULT mlpiParameterWriteDataArrayUchar (const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, const UCHAR *data, const ULONG numElements)
 
MLPIRESULT mlpiParameterWriteDataArrayShort (const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, const SHORT *data, const ULONG numElements)
 
MLPIRESULT mlpiParameterWriteDataArrayUshort (const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, const USHORT *data, const ULONG numElements)
 
MLPIRESULT mlpiParameterWriteDataArrayLong (const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, const LONG *data, const ULONG numElements)
 
MLPIRESULT mlpiParameterWriteDataArrayUlong (const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, const ULONG *data, const ULONG numElements)
 
MLPIRESULT mlpiParameterWriteDataArrayLlong (const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, const LLONG *data, const ULONG numElements)
 
MLPIRESULT mlpiParameterWriteDataArrayUllong (const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, const ULLONG *data, const ULONG numElements)
 
MLPIRESULT mlpiParameterWriteDataArrayFloat (const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, const FLOAT *data, const ULONG numElements)
 
MLPIRESULT mlpiParameterWriteDataArrayDouble (const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, const DOUBLE *data, const ULONG numElements)
 
MLPIRESULT mlpiParameterReadDefaultShort (const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, SHORT *data)
 
MLPIRESULT mlpiParameterReadDefaultUshort (const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, USHORT *data)
 
MLPIRESULT mlpiParameterReadDefaultLong (const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, LONG *data)
 
MLPIRESULT mlpiParameterReadDefaultUlong (const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, ULONG *data)
 
MLPIRESULT mlpiParameterReadDefaultLlong (const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, LLONG *data)
 
MLPIRESULT mlpiParameterReadDefaultUllong (const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, ULLONG *data)
 
MLPIRESULT mlpiParameterReadDefaultFloat (const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, FLOAT *data)
 
MLPIRESULT mlpiParameterReadDefaultDouble (const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, DOUBLE *data)
 
MLPIRESULT mlpiParameterReadDefaultString (const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, WCHAR16 *data, const ULONG numElements, ULONG *numElementsRet)
 
MLPIRESULT mlpiParameterReadDataStatus (const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, BOOL8 *status)
 
MLPIRESULT mlpiParameterCommand (const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn)
 
MLPIRESULT mlpiParameterReadCommandStatus (const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, USHORT *status)
 
MLPIRESULT mlpiParameterReadListLength (const MLPIHANDLE connection, const ULLONG address, const ULLONG sidn, ULONG *numElements, ULONG *numMaxElements, ULONG *elementSize)
 
MLPIRESULT mlpiParameterImportFile (const MLPIHANDLE connection, const WCHAR16 *path, MlpiSidnError *errorList, const ULONG numElements, ULONG *numElementsRet, const WCHAR16 *mapping)
 
MLPIRESULT mlpiParameterExportFile (const MLPIHANDLE connection, const WCHAR16 *path, const WCHAR16 *exportPattern, MlpiSidnError *errorList, const ULONG numElements, ULONG *numElementsRet)
 
MLPIRESULT mlpiParameterReadEverything (const MLPIHANDLE connection, MlpiReadEverything *readEverything, const ULONG numElements, UCHAR *data, const ULONG dataSize)
 
MLPIRESULT mlpiParameterExportFileStartProcess (const MLPIHANDLE connection, const WCHAR16 *path, const WCHAR16 *exportPattern, PROCESSHANDLE *process)
 
MLPIRESULT mlpiParameterImportFileStartProcess (const MLPIHANDLE connection, const WCHAR16 *path, const WCHAR16 *mapping, PROCESSHANDLE *process)
 
MLPIRESULT mlpiParameterImportExportStatus (const MLPIHANDLE connection, const PROCESSHANDLE process, MlpiParamProcessStatus *status, ULONG *currentCount, ULONG *expectedCount, ULONG *errorsCount, MlpiSidnError *errorList, ULONG numElements)
 
MLPIRESULT mlpiParameterImportExportGetInfo (const MLPIHANDLE connection, const PROCESSHANDLE process, WCHAR16 *pattern, ULONG numElementsPattern, WCHAR16 *file, ULONG numElementsFile)
 
MLPIRESULT mlpiParameterImportExportAbort (const MLPIHANDLE connection, const PROCESSHANDLE process)
 
MLPIRESULT mlpiParameterWriteAccessSetup (const MLPIHANDLE connection, MlpiParamWriteAccess *writeAccess, const ULONG numElements, PROCESSHANDLE *process)
 
MLPIRESULT mlpiParameterWriteAccessStatus (const MLPIHANDLE connection, const PROCESSHANDLE process, const BOOL8 waitForWriteAccess, const ULONG timeout, MlpiParamWriteAccess *writeAccess, const ULONG numElements, ULONG *numElementsRet)
 
MLPIRESULT mlpiParameterWriteAccessAbort (const MLPIHANDLE connection, const PROCESSHANDLE process)
 

Detailed Description

Author
DC-IA/EAM1 (SK, JR)
Version
1.26.2
Date
2013

Definition in file mlpiParameterLib.h.