HelicsError Struct Reference

#include <api-data.h>

Public Attributes
int32_t	error_code
const char *	message

Detailed Description

helics error object

if error_code==0 there is no error, if error_code!=0 there is an error and message will contain a string, otherwise it will be an empty string

Member Data Documentation

error_code

int32_t HelicsError::error_code

an error code associated with the error

Referenced by helicsCreateBroker(), helicsCreateBrokerFromArgs(), helicsCreateCore(), helicsCreateCoreFromArgs(), helicsErrorClear(), helicsErrorInitialize(), helicsFederateGetFilter(), helicsFederateGetFilterByIndex(), helicsFederateGetTranslator(), helicsFederateGetTranslatorByIndex(), helicsFederateInfoSetCoreTypeFromString(), helicsFederateIsProtected(), helicsFederateUnProtect(), helicsGetFederateByName(), and helicscpp::hThrowOnError::~hThrowOnError().

message

const char* HelicsError::message

a message associated with the error

Referenced by helicsCreateBroker(), helicsCreateBrokerFromArgs(), helicsCreateCore(), helicsCreateCoreFromArgs(), helicsErrorClear(), helicsErrorInitialize(), helicsFederateGetFilter(), helicsFederateGetFilterByIndex(), helicsFederateGetTranslator(), helicsFederateGetTranslatorByIndex(), helicsFederateInfoSetCoreTypeFromString(), helicsFederateIsProtected(), helicsFederateUnProtect(), helicsGetFederateByName(), and helicscpp::hThrowOnError::~hThrowOnError().

---

The documentation for this struct was generated from the following file:

• api-data.h