ecmcMisc.h

Go to the documentation of this file.

/*************************************************************************\
* Copyright (c) 2019 European Spallation Source ERIC
* ecmc is distributed subject to a Software License Agreement found
* in file LICENSE that is included with this distribution.
*
*  ecmcMisc.h
*
*  Created on: Jan 10, 2019
*      Author: anderssandstrom
*
\*************************************************************************/
 
#ifndef ECMC_MISC_H_
#define ECMC_MISC_H_
 
#define CHECK_COMMAND_LIST_RETURN_IF_ERROR(commandListIndex)\
        {\
          if (indexCommandList >= ECMC_MAX_COMMANDS_LISTS ||\
              indexCommandList < 0) {\
            LOGERR("ERROR: Command list index out of range.\n");\
            return ERROR_COMMAND_LIST_INDEX_OUT_OF_RANGE;\
          }\
          if (commandLists[indexCommandList] == NULL) {\
            LOGERR("ERROR: Command list object NULL.\n");\
            return ERROR_COMMAND_LIST_NULL;\
          }\
        }\
 
#define CHECK_EVENT_RETURN_IF_ERROR(indexEvent)\
        {\
          if (indexEvent >= ECMC_MAX_EVENT_OBJECTS || indexEvent < 0) {\
            LOGERR("ERROR: Event index out of range.\n");\
            return ERROR_MAIN_EVENT_INDEX_OUT_OF_RANGE;\
          }\
          if (events[indexEvent] == NULL) {\
            LOGERR("ERROR: Event object NULL.\n");\
            return ERROR_MAIN_EVENT_NULL;\
          }\
        }\
 
#define CHECK_STORAGE_RETURN_IF_ERROR(indexStorage)\
        {\
          if (indexStorage >= ECMC_MAX_DATA_STORAGE_OBJECTS ||\
              indexStorage < 0) {\
            LOGERR("ERROR: Data storage index out of range.\n");\
            return ERROR_MAIN_DATA_STORAGE_INDEX_OUT_OF_RANGE;\
          }\
          if (dataStorages[indexStorage] == NULL) {\
            LOGERR("ERROR: Data storage object NULL.\n");\
            return ERROR_MAIN_DATA_STORAGE_NULL;\
          }\
        }\
 
#define CHECK_RECORDER_RETURN_IF_ERROR(indexRecorder)\
        {\
          if (indexRecorder >= ECMC_MAX_DATA_RECORDERS_OBJECTS ||\
              indexRecorder < 0) {\
            LOGERR("ERROR: Data recorder index out of range.\n");\
            return ERROR_MAIN_DATA_RECORDER_INDEX_OUT_OF_RANGE;\
          }\
          if (dataRecorders[indexRecorder] == NULL) {\
            LOGERR("ERROR: Data recorder object NULL.\n");\
            return ERROR_MAIN_DATA_RECORDER_NULL;\
          }\
        }\
 
# ifdef __cplusplus
extern "C" {
# endif  // ifdef __cplusplus
 
 
int createEvent(int index);
 
int linkEcEntryToEvent(int   indexEvent,
                       int   eventEntryIndex,
                       int   slaveBusPosition,
                       char *entryIDString,
                       int   bitIndex);
 
int setEventType(int indexEvent,
                 int type);
 
int setEventSampleTime(int indexEvent,
                       int sampleTime);
 
int setEventTriggerEdge(int indexEvent,
                        int triggerEdge);
 
int setEventEnable(int indexEvent,
                   int enable);
 
int getEventEnabled(int  indexEvent,
                    int *enabled);
 
int setEventEnableArmSequence(int indexEvent,
                              int enable);
 
int setEventEnablePrintouts(int indexEvent,
                            int enable);
 
int triggerEvent(int indexEvent);
 
int armEvent(int indexEvent);
 
int createDataStorage(int index,
                      int elements,
                      int bufferType);
 
int clearStorage(int indexStorage);
 
int getStorageDataIndex(int  indexStorage,
                        int *index);
 
int setStorageEnablePrintouts(int indexStorage,
                              int enable);
 
int printStorageBuffer(int indexStorage);
 
int readStorageBuffer(int      indexStorage,
                      double **data,
                      int     *size);
 
int writeStorageBuffer(int     indexStorage,
                       double *data,
                       int     size);
 
int appendStorageBuffer(int     indexStorage,
                        double *data,
                        int     size);
 
int setDataStorageCurrentDataIndex(int indexStorage,
                                   int position);
 
int createRecorder(int indexRecorder);
 
int linkStorageToRecorder(int indexStorage,
                          int indexRecorder);
 
int linkEcEntryToRecorder(int   indexRecorder,
                          int   recorderEntryIndex,
                          int   slaveBusPosition,
                          char *entryIDString,
                          int   bitIndex);
 
int linkAxisDataToRecorder(int indexRecorder,
                           int axisIndex,
                           int dataToStore);
 
int setRecorderEnable(int indexRecorder,
                      int enable);
 
int getRecorderEnabled(int  indexRecorder,
                       int *enabled);
 
int setRecorderEnablePrintouts(int indexRecorder,
                               int enable);
 
int linkRecorderToEvent(int indexRecorder,
                        int indexEvent,
                        int consumerIndex);
 
int triggerRecorder(int indexRecorder);
 
int createCommandList(int indexCommandList);
 
int linkCommandListToEvent(int indexCommandList,
                           int indexEvent,
                           int consumerIndex);
 
int setCommandListEnable(int indexCommandList,
                         int enable);
 
int setCommandListEnablePrintouts(int indexCommandList,
                                  int enable);
 
int addCommandListCommand(int   indexCommandList,
                          char *expr);
 
int triggerCommandList(int indexCommandList);
 
int createShm();
 
# ifdef __cplusplus
}
# endif  // ifdef __cplusplus
 
#endif  /* ECMC_MISC_H_ */