helics  3.0.1
Classes | Typedefs | Enumerations | Functions
helicscpp Namespace Reference

Classes

class  Broker
 
class  CloningFilter
 
class  CombinationFederate
 
class  Core
 
class  Endpoint
 
class  Federate
 
class  FederateInfo
 
class  Filter
 
class  HelicsException
 
struct  HelicsIterationTime
 
class  hThrowOnError
 
class  Input
 
class  Message
 
class  MessageFederate
 
class  Publication
 
class  ValueFederate
 

Typedefs

typedef struct helicscpp::HelicsIterationTime HelicsIterationTime
 

Enumerations

enum  PubSubTypes {
  STRING_TYPE = HELICS_DATA_TYPE_STRING, DOUBLE_TYPE = HELICS_DATA_TYPE_DOUBLE, INT_TYPE = HELICS_DATA_TYPE_INT, COMPLEX_TYPE = HELICS_DATA_TYPE_COMPLEX,
  VECTOR_TYPE = HELICS_DATA_TYPE_VECTOR, TIME_TYPE = HELICS_DATA_TYPE_TIME, BOOLEAN_TYPE = HELICS_DATA_TYPE_BOOLEAN, RAW_TYPE = HELICS_DATA_TYPE_RAW
}
 

Functions

std::string getHelicsVersionString ()
 
std::string version ()
 
std::string buildFlags ()
 
std::string compilerVersion ()
 
void cleanupHelicsLibrary ()
 
void closeLibrary ()
 
void loadSignalHandler ()
 
void loadSignalHandler (HelicsBool(*handler)(int))
 
void clearSignalHandler ()
 

Detailed Description

HELICS C++98 Interface

Typedef Documentation

◆ HelicsIterationTime

an iteration time structure

Enumeration Type Documentation

◆ PubSubTypes

enumeration of the available types of publications and inputs

Function Documentation

◆ buildFlags()

std::string helicscpp::buildFlags ( )
inline

get a string with the helics version info

References helicsGetBuildFlags().

◆ cleanupHelicsLibrary()

void helicscpp::cleanupHelicsLibrary ( )
inline

do a cleanup of the brokers and cores currently in the library

References helicsCleanupLibrary().

◆ closeLibrary()

void helicscpp::closeLibrary ( )
inline

close the library and cleanup all open objects

References helicsCloseLibrary().

◆ compilerVersion()

std::string helicscpp::compilerVersion ( )
inline

get a string with the compiler used to compile the library

References helicsGetCompilerVersion().

◆ getHelicsVersionString()

std::string helicscpp::getHelicsVersionString ( )
inline

get a string with the helics version info

References helicsGetVersion().

◆ version()

std::string helicscpp::version ( )
inline

get a string with the helics version info

References helicsGetVersion().