helicsData.h

/*
Copyright (c) 2017-2025,
Battelle Memorial Institute; Lawrence Livermore National Security, LLC; Alliance for Sustainable Energy, LLC.  See the top-level NOTICE for
additional details. All rights reserved.
SPDX-License-Identifier: BSD-3-Clause
*/
 
#ifndef HELICS_APISHAREDDATA_FUNCTIONS_H_
#define HELICS_APISHAREDDATA_FUNCTIONS_H_
 
#include "api-data.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include "helics_export.h"
 
HELICS_EXPORT HelicsDataBuffer helicsCreateDataBuffer(int32_t initialCapacity);
 
HELICS_EXPORT HelicsBool helicsDataBufferIsValid(HelicsDataBuffer data);
 
HELICS_EXPORT HelicsDataBuffer helicsWrapDataInBuffer(void* data, int dataSize, int dataCapacity);
 
HELICS_EXPORT void helicsDataBufferFree(HelicsDataBuffer data);
 
HELICS_EXPORT int32_t helicsDataBufferSize(HelicsDataBuffer data);
 
HELICS_EXPORT int32_t helicsDataBufferCapacity(HelicsDataBuffer data);
 
HELICS_EXPORT void* helicsDataBufferData(HelicsDataBuffer data);
 
HELICS_EXPORT HelicsBool helicsDataBufferReserve(HelicsDataBuffer data, int32_t newCapacity);
 
HELICS_EXPORT HelicsDataBuffer helicsDataBufferClone(HelicsDataBuffer data);
 
HELICS_EXPORT int32_t helicsDataBufferFillFromInteger(HelicsDataBuffer data, int64_t value);
 
HELICS_EXPORT int32_t helicsDataBufferFillFromDouble(HelicsDataBuffer data, double value);
 
HELICS_EXPORT int32_t helicsDataBufferFillFromString(HelicsDataBuffer data, const char* value);
 
HELICS_EXPORT int32_t helicsDataBufferFillFromRawString(HelicsDataBuffer data, const char* str, int stringSize);
 
HELICS_EXPORT int32_t helicsDataBufferFillFromBoolean(HelicsDataBuffer data, HelicsBool value);
 
HELICS_EXPORT int32_t helicsDataBufferFillFromChar(HelicsDataBuffer data, char value);
 
HELICS_EXPORT int32_t helicsDataBufferFillFromTime(HelicsDataBuffer data, HelicsTime value);
 
HELICS_EXPORT int32_t helicsDataBufferFillFromComplex(HelicsDataBuffer data, double real, double imag);
 
HELICS_EXPORT int32_t helicsDataBufferFillFromComplexObject(HelicsDataBuffer data, HelicsComplex value);
 
HELICS_EXPORT int32_t helicsDataBufferFillFromVector(HelicsDataBuffer data, const double* value, int dataSize);
 
HELICS_EXPORT int32_t helicsDataBufferFillFromNamedPoint(HelicsDataBuffer data, const char* name, double value);
 
HELICS_EXPORT int32_t helicsDataBufferFillFromComplexVector(HelicsDataBuffer data, const double* value, int dataSize);
 
HELICS_EXPORT int helicsDataBufferType(HelicsDataBuffer data);
 
HELICS_EXPORT int64_t helicsDataBufferToInteger(HelicsDataBuffer data);
 
HELICS_EXPORT double helicsDataBufferToDouble(HelicsDataBuffer data);
 
HELICS_EXPORT HelicsBool helicsDataBufferToBoolean(HelicsDataBuffer data);
 
HELICS_EXPORT char helicsDataBufferToChar(HelicsDataBuffer data);
 
HELICS_EXPORT int helicsDataBufferStringSize(HelicsDataBuffer data);
 
/* convert a data buffer to a string including a null terminator
NOTE:  data may contain null bytes prior to the end but actualLength will be the number of characters in the string
outputString[actualLength] is a null terminator*/
HELICS_EXPORT void helicsDataBufferToString(HelicsDataBuffer data, char* outputString, int maxStringLen, int* actualLength);
 
/* convert a data buffer to a Raw string with no null terminator
 */
HELICS_EXPORT void helicsDataBufferToRawString(HelicsDataBuffer data, char* outputString, int maxStringLen, int* actualLength);
 
HELICS_EXPORT HelicsTime helicsDataBufferToTime(HelicsDataBuffer data);
 
HELICS_EXPORT HelicsComplex helicsDataBufferToComplexObject(HelicsDataBuffer data);
 
HELICS_EXPORT void helicsDataBufferToComplex(HelicsDataBuffer data, double* real, double* imag);
 
HELICS_EXPORT int helicsDataBufferVectorSize(HelicsDataBuffer data);
 
HELICS_EXPORT void helicsDataBufferToVector(HelicsDataBuffer data, double values[], int maxlen, int* actualSize);
 
HELICS_EXPORT void helicsDataBufferToComplexVector(HelicsDataBuffer data, double values[], int maxlen, int* actualSize);
 
HELICS_EXPORT void
    helicsDataBufferToNamedPoint(HelicsDataBuffer data, char* outputString, int maxStringLength, int* actualLength, double* val);
 
HELICS_EXPORT HelicsBool helicsDataBufferConvertToType(HelicsDataBuffer data, int newDataType);
 
#ifdef __cplusplus
} /* end of extern "C" { */
#endif
 
#endif /*HELICS_APISHAREDDATA_FUNCTIONS_H_ */