helicscpp Namespace Reference

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

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 (helics_bool(*handler)(int))
void	clearSignalHandler ()

Detailed Description

HELICS C++98 Interface

Enumeration Type Documentation

PubSubTypes

enum helicscpp::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().