rrc_utilities.h

Go to the documentation of this file.

#ifndef rrc_utilitiesH
#define rrc_utilitiesH
#include "rrc_exporter.h"
#include "rrc_types.h"
#include "rrc_exporter.h"
#include "rrc_macros.h"
//---------------------------------------------------------------------------

#if defined(__cplusplus)
namespace rrc
{
extern "C"
{
#endif

extern char* gLastError;

extern char* gInstallFolder;

//Error/Warning Messages
extern const char*  ALLOCATE_API_ERROR_MSG;

extern const char*  INVALID_HANDLE_ERROR_MSG;

C_DECL_SPEC char*        rrcCallConv    getFileContent(const char* fName);

C_DECL_SPEC char*        rrcCallConv    createText(const char* text);

C_DECL_SPEC char*        rrcCallConv    createTextMemory(const int count);

// --------------------------------------------------------------------
// List support routines
// --------------------------------------------------------------------

C_DECL_SPEC RRListPtr rrcCallConv createRRList(void);

C_DECL_SPEC void rrcCallConv freeRRList (RRListPtr list);

C_DECL_SPEC int rrcCallConv getListLength (RRListPtr myList);


C_DECL_SPEC RRListItemPtr rrcCallConv createIntegerItem (int value);

C_DECL_SPEC RRListItemPtr rrcCallConv createDoubleItem  (double value);

C_DECL_SPEC RRListItemPtr rrcCallConv createStringItem  (char* value);

C_DECL_SPEC RRListItemPtr rrcCallConv createListItem (struct RRList* value);

C_DECL_SPEC int rrcCallConv addItem (RRListPtr list, RRListItemPtr *item);


C_DECL_SPEC RRListItemPtr rrcCallConv getListItem (RRListPtr list, int index);

C_DECL_SPEC bool rrcCallConv isListItemInteger (RRListItemPtr item);

C_DECL_SPEC bool rrcCallConv isListItemDouble (RRListItemPtr item);

C_DECL_SPEC bool rrcCallConv isListItemString (RRListItemPtr item);

C_DECL_SPEC bool rrcCallConv isListItemList (RRListItemPtr item);

C_DECL_SPEC bool rrcCallConv isListItem (RRListItemPtr item, enum ListItemType itemType);

C_DECL_SPEC bool rrcCallConv getIntegerListItem (RRListItemPtr item, int *value);

C_DECL_SPEC bool rrcCallConv getDoubleListItem (RRListItemPtr item, double *value);

C_DECL_SPEC char* rrcCallConv getStringListItem (RRListItemPtr item);


C_DECL_SPEC RRListPtr rrcCallConv getList(RRListItemPtr item);

// --------------------------------------------------------------------------------
// Free memory functions
// --------------------------------------------------------------------------------

C_DECL_SPEC bool rrcCallConv freeRRCData(RRCDataPtr handle);

C_DECL_SPEC bool rrcCallConv freeText(char* text);


//C_DECL_SPEC bool rrcCallConv freeStringList(RRStringListHandle sl);

C_DECL_SPEC bool rrcCallConv freeStringArray(RRStringArrayPtr sl);

C_DECL_SPEC bool rrcCallConv freeVector(RRVectorPtr vector);

C_DECL_SPEC bool rrcCallConv freeMatrix(RRDoubleMatrixPtr matrix);

C_DECL_SPEC void rrcCallConv pause(void);

// --------------------------------------------------------------------------------
// Helper Methods
// --------------------------------------------------------------------------------

C_DECL_SPEC int rrcCallConv getVectorLength (RRVectorPtr vector);

C_DECL_SPEC RRVectorPtr rrcCallConv createVector (int size);

C_DECL_SPEC bool rrcCallConv getVectorElement (RRVectorPtr vector, int index, double* value);


C_DECL_SPEC bool rrcCallConv setVectorElement (RRVectorPtr vector, int index, double value);

C_DECL_SPEC RRDoubleMatrixPtr rrcCallConv createRRMatrix (int r, int c);

C_DECL_SPEC int rrcCallConv getMatrixNumRows (RRDoubleMatrixPtr m);

C_DECL_SPEC int rrcCallConv getMatrixNumCols (RRDoubleMatrixPtr m);

C_DECL_SPEC bool rrcCallConv getMatrixElement (RRDoubleMatrixPtr m, int r, int c, double* value);

C_DECL_SPEC bool rrcCallConv setMatrixElement (RRDoubleMatrixPtr m, int r, int c, double value);


C_DECL_SPEC bool rrcCallConv getComplexMatrixElement (RRComplexMatrixPtr m, int r, int c, RRComplexPtr value);


C_DECL_SPEC bool rrcCallConv setComplexMatrixElement (RRComplexMatrixPtr m, int r, int c, RRComplexPtr value);

C_DECL_SPEC RRCDataPtr rrcCallConv createRRCData(RRDataHandle rrData);

C_DECL_SPEC int rrcCallConv getRRDataNumRows (RRCDataPtr rrData);

C_DECL_SPEC int rrcCallConv getRRDataNumCols (RRCDataPtr rrData);

C_DECL_SPEC bool rrcCallConv getRRCDataElement (RRCDataPtr rrData, int r, int c, double *value);

C_DECL_SPEC char* rrcCallConv getRRDataColumnLabel (RRCDataPtr rrData, int column);

// --------------------------------------------------------------------------------
// Convert data to string functions
// --------------------------------------------------------------------------------

C_DECL_SPEC char* rrcCallConv vectorToString(const RRVectorPtr vec);

C_DECL_SPEC char* rrcCallConv complexVectorToString(const RRComplexVectorPtr vec);

C_DECL_SPEC char* rrcCallConv rrDataToString(RRDataHandle rrData);

C_DECL_SPEC char* rrcCallConv rrCDataToString(const RRCDataPtr rrData);

C_DECL_SPEC char* rrcCallConv matrixToString(const RRDoubleMatrixPtr mat);

C_DECL_SPEC char* rrcCallConv complexMatrixToString(const RRComplexMatrixPtr mat);

C_DECL_SPEC int rrcCallConv getNumberOfStringElements(const RRStringArrayPtr list);

C_DECL_SPEC char* rrcCallConv getStringElement (RRStringArrayPtr list, int index);

C_DECL_SPEC char* rrcCallConv stringArrayToString(const RRStringArrayPtr list);

C_DECL_SPEC char* rrcCallConv listToString(const RRListPtr list);


//======================== DATA WRITING ROUTINES =============================
C_DECL_SPEC bool rrcCallConv writeRRData(RRHandle handle, const char* fileNameAndPath);


// TEST UTILITY functions (to be documented later. Only for internal testing)
C_DECL_SPEC bool rrcCallConv compileSource(RRHandle handle, const char* sourceFileNameAndPath);


#if defined(__cplusplus)

}   //namespace
}   //Extern "C"
#endif

#endif