mlpiContainerLib.h

Go to the documentation of this file.

#ifndef __MLPICONTAINERLIB_H__
#define __MLPICONTAINERLIB_H__

// -----------------------------------------------------------------------
// MLPI - <mlpiContainerLib.h>
// -----------------------------------------------------------------------
// Copyright (c) 2013 Bosch Rexroth. All rights reserved.
// Redistribution and use in source and binary forms of this MLPI software
// (SW) provided to you, with or without modification, are permitted
// without prior approval provided that the following conditions are met:
//
// 1. Redistributions of source code of SW must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form of SW must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// 3. User recognizes and acknowledges that it acquires no right,
// title or interest in or to any of the names or trademarks used in
// connection with the SW ("names") by virtue of this License and waives
// any right to or interest in the names. User recognizes and acknowledges
// that names of companies or names or products of companies displayed
// in the documentation of SW to indicate the interoperability of products
// with the SW are the names of their respective owners. The use of such
// names in the documentation of SW does not imply any sponsorship,
// approval, or endorsement by such companies of this product.
//
// 4. Modified code versions, i.e. any addition to or deletion from
// the substance or structure of the original code of the SW running
// the MLPI must be plainly marked as such and must not be misrepresented
// as being original SW.
//
// 5. The SW may only be used in connection with a Bosch Rexroth product.
//
// THIS INFORMATION IS PROVIDED BY BOSCH REXROTH CORPORATION "AS IS"
// AND WITHOUT WARRANTY OF ANY KIND, EXPRESSED OR IMPLIED, INCLUDING
// (BUT NOTLIMITED TO) ANY IMPLIED WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR ANY PARTICULAR PURPOSE, OR NON-INFRINGEMENT. WHILE THE
// INFORMATION PROVIDED IS BELIEVED TO BE ACCURATE, IT MAY INCLUDE
// ERRORS OR INACCURACIES.
// SUBJECT TO COMPULSORY STATUTORY PROVISIONS OF THE GERMAN LAW AS
// THE APPLICABLE LAW FOR THIS LICENSE BOSCH REXROTH CORPORATION WILL
// NOT BE LIABLE FOR ANY DAMAGES OF ANY KIND ARISING FROM THE USE OF
// THE  SOFTWARE  DISTRIBUTED HEREUNDER, INCLUDING BUT NOT LIMITED TO
// DIRECT, INDIRECT, INCIDENTAL, PUNITIVE, AND CONSEQUENTIAL DAMAGES.
// -----------------------------------------------------------------------
//
//
// -----------------------------------------------------------------------










// -----------------------------------------------------------------------
// GLOBAL INCLUDES
// -----------------------------------------------------------------------
#include "mlpiGlobal.h"


// -----------------------------------------------------------------------
// GLOBAL CONSTANTS
// -----------------------------------------------------------------------
#define MLPI_CONTAINER_TAG_SEPARATOR                      MLPI_ADAPT_STRING(';')
#define MLPI_CONTAINER_ARG_SEPARATOR                      MLPI_ADAPT_STRING(',')

#define MLPI_CONTAINER_TAG_LOGICLIB_MEMORY_AREA           MLPI_ADAPT_STRING("LOGICLIB_MEMORY_AREA")
#define MLPI_CONTAINER_TAG_LOGICLIB_SYMBOL                MLPI_ADAPT_STRING("LOGICLIB_SYMBOL")
#define MLPI_CONTAINER_TAG_IOLIB_FIELBUS_IO               MLPI_ADAPT_STRING("IOLIB_FIELBUS_IO")     //<! Deprecated.
#define MLPI_CONTAINER_TAG_IOLIB_FIELDBUS_IO              MLPI_ADAPT_STRING("IOLIB_FIELBUS_IO")     //<! Spelling of "Fieldbus" was wrong till MLPI version 1.5.0.0. Due to compatibility reasons, we can not change the adapted string value.
#define MLPI_CONTAINER_TAG_ALIGNMENT_DUMMY                MLPI_ADAPT_STRING("ALIGNMENT_DUMMY")

#define MLPI_CONTAINER_ARG_IOLIB_IO_AREA_INPUT            MLPI_ADAPT_STRING("INPUT")
#define MLPI_CONTAINER_ARG_IOLIB_IO_AREA_OUTPUT           MLPI_ADAPT_STRING("OUTPUT")

#define MLPI_CONTAINER_ARG_LOGICLIB_MEMORY_AREA_INPUT     MLPI_ADAPT_STRING("INPUT")
#define MLPI_CONTAINER_ARG_LOGICLIB_MEMORY_AREA_OUTPUT    MLPI_ADAPT_STRING("OUTPUT")
#define MLPI_CONTAINER_ARG_LOGICLIB_MEMORY_AREA_MARKER    MLPI_ADAPT_STRING("MARKER")

#define MLPI_CONTAINER_NAME_MAX_LENGTH                    (64)                                        

// -----------------------------------------------------------------------
// GLOBAL TYPEDEFS
// -----------------------------------------------------------------------

typedef enum MlpiContainerAccess
{
  MLPI_CONTAINER_ACCESS_READ   = 0,   
  MLPI_CONTAINER_ACCESS_WRITE  = 1    
}MlpiContainerAccess;

// message packing follows 8 byte natural alignment
#if !defined(TARGET_OS_VXWORKS)
#pragma pack(push,8)
#endif

typedef struct MlpiContainerHandle
{
  ULONG connectionID;      
  ULONG containerID;       
} MlpiContainerHandle;

typedef struct MlpiContainerInformation
{
  WCHAR16             name[MLPI_CONTAINER_NAME_MAX_LENGTH]; 
  MlpiDateAndTime     dateTime;                             
  ULONG               numItems;                             
  ULONG               numElementsTagList;                   
  ULONG               dataSize;                             
  MlpiContainerAccess accessFlag;                           
} MlpiContainerInformation;

typedef struct MlpiContainerItemInformation
{
  MlpiType  type;                 
  ULONG     offset;               
  ULONG     dataSize;             
} MlpiContainerItemInformation;


#if !defined(TARGET_OS_VXWORKS)
#pragma pack(pop)
#endif





// -----------------------------------------------------------------------
// GLOBAL EXPORTS
// -----------------------------------------------------------------------
#ifdef MLPI_API
  #undef MLPI_API
#endif

#if defined(TARGET_OS_WINNT)
  #if defined(MLPI_EXPORTS)
    #define MLPI_API __declspec(dllexport)
  #elif defined(MLPI_IMPORTS)
    #define MLPI_API __declspec(dllimport)
  #else
    #define MLPI_API
  #endif
#else
  #if defined(MLPI_EXPORTS)
    #define MLPI_API __attribute__ ((visibility("default")))
  #elif defined(MLPI_IMPORTS)
    #define MLPI_API
  #else
    #define MLPI_API
  #endif
#endif

#ifdef __cplusplus
extern "C" {
#endif


MLPI_API MLPIRESULT mlpiContainerCreate(const MLPIHANDLE connection, const WCHAR16 *tagList, const MlpiContainerAccess accessFlag, MlpiContainerHandle *handle, ULONG *dataSize);


MLPI_API MLPIRESULT mlpiContainerUpdate(const MLPIHANDLE connection, const MlpiContainerHandle handle, void *data, const ULONG dataSize);


MLPI_API MLPIRESULT mlpiContainerDestroy(const MLPIHANDLE connection, MlpiContainerHandle *handle);


MLPI_API MLPIRESULT mlpiContainerSetName(const MLPIHANDLE connection, const MlpiContainerHandle handle, const WCHAR16 *name);


MLPI_API MLPIRESULT mlpiContainerGetName(const MLPIHANDLE connection, const MlpiContainerHandle handle, WCHAR16 *name, const ULONG numElements);


MLPI_API MLPIRESULT mlpiContainerGetInformation(const MLPIHANDLE connection, const MlpiContainerHandle handle, MlpiContainerInformation *info);


MLPI_API MLPIRESULT mlpiContainerGetTagList(const MLPIHANDLE connection, const MlpiContainerHandle handle, WCHAR16 *tagList, const ULONG numElements);


MLPI_API MLPIRESULT mlpiContainerGetItemInformation(const MLPIHANDLE connection, const MlpiContainerHandle handle, MlpiContainerItemInformation *info, const ULONG numElements, ULONG *numElementsRet);


MLPI_API MLPIRESULT mlpiContainerGetSingleItemInformation(const MLPIHANDLE connection, const MlpiContainerHandle handle, const ULONG index, WCHAR16 *tag, const ULONG numElements, MlpiContainerItemInformation *info);


MLPI_API MLPIRESULT mlpiContainerGetNumberOfContainer(const MLPIHANDLE connection, ULONG *number);


MLPI_API MLPIRESULT mlpiContainerGetHandlesOfContainer(const MLPIHANDLE connection, MlpiContainerHandle *handles, const ULONG numElements, ULONG *numElementsRet);



#ifdef __cplusplus
}
#endif



#endif // endof: #ifndef __MLPICONTAINERLIB_H__