Helics Enumerations

Many of the functions take properties or options that are defined by the enumerations available in the HELICS library see helics_enums.h Index of functions available in the C and by extension the language API's

General Functions

in the HELICS C library

helicsGetVersion
helicsGetBuildFlags
helicsGetCompilerVersion
helicsGetSystemInfo
helicsErrorInitialize
helicsErrorClear
helicsLoadSignalHandler
helicsLoadThreadedSignalHandler
helicsClearSignalHandler
helicsLoadSignalHandlerCallback
helicsLoadSignalHandlerCallbackNoExit
helicsAbort
helicsIsCoreTypeAvailable
helicsGetFederateByName
helicsGetPropertyIndex
helicsGetFlagIndex
helicsGetOptionIndex
helicsGetOptionValue
helicsGetDataType
helicsCloseLibrary
helicsCleanupLibrary
helicsCallbackFederateNextTimeCallback
helicsCallbackFederateNextTimeIterativeCallback
helicsCallbackFederateInitializeCallback
helicsWrapDataInBuffer

Creation Function Functions to create the different objects in the library

helicsCreateCore
helicsCreateCoreFromArgs
helicsCreateBroker
helicsCreateBrokerFromArgs
helicsCreateValueFederate
helicsCreateValueFederateFromConfig
helicsCreateMessageFederate
helicsCreateMessageFederateFromConfig
helicsCreateCombinationFederate
helicsCreateCombinationFederateFromConfig
helicsCreateCallbackFederate
helicsCreateCallbackFederateFromConfig
helicsCreateFederateInfo
helicsCreateQuery
helicsCreateApp
helicsCreateDataBuffer

Core Functions

functions applying to a HelicsCore object

helicsCoreClone
helicsCoreIsValid
helicsCoreWaitForDisconnect
helicsCoreIsConnected
helicsCoreIsOpenToNewFederates
helicsCoreDataLink
helicsCoreAddSourceFilterToEndpoint
helicsCoreAddDestinationFilterToEndpoint
helicsCoreMakeConnections
helicsCoreGetIdentifier
helicsCoreGetAddress
helicsCoreSetReadyToInit
helicsCoreConnect
helicsCoreDisconnect
helicsCoreDestroy
helicsCoreFree
helicsCoreSetGlobal
helicsCoreAddAlias
helicsCoreSendCommand
helicsCoreSendOrderedCommand
helicsCoreSetLogFile
helicsCoreGlobalError
helicsCoreSetLoggingCallback
helicsCoreRegisterFilter
helicsCoreRegisterCloningFilter
helicsCoreRegisterTranslator

Broker Functions

Functions applying to a HelicsBroker object

App Functions

Functions applying to a HelicsApp object

Federate Info Functions

Functions applying to a HelicsFederateInfo object

helicsFederateInfoClone
helicsFederateInfoLoadFromArgs
helicsFederateInfoLoadFromString
helicsFederateInfoFree
helicsFederateInfoSetCoreName
helicsFederateInfoSetCoreInitString
helicsFederateInfoSetBrokerInitString
helicsFederateInfoSetCoreType
helicsFederateInfoSetCoreTypeFromString
helicsFederateInfoSetBroker
helicsFederateInfoSetBrokerKey
helicsFederateInfoSetBrokerPort
helicsFederateInfoSetLocalPort
helicsFederateInfoSetFlagOption
helicsFederateInfoSetSeparator
helicsFederateInfoSetTimeProperty
helicsFederateInfoSetIntegerProperty

Federate Functions

Functions applying to all HelicsFederate objects

helicsFederateDestroy
helicsFederateClone
helicsFederateProtect
helicsFederateUnProtect
helicsFederateIsProtected
helicsFederateIsValid
helicsFederateRegisterInterfaces
helicsFederateGlobalError
helicsFederateLocalError
helicsFederateFinalize
helicsFederateFinalizeAsync
helicsFederateFinalizeComplete
helicsFederateDisconnect
helicsFederateDisconnectAsync
helicsFederateDisconnectComplete
helicsFederateFree
helicsFederateEnterInitializingMode
helicsFederateEnterInitializingModeAsync
helicsFederateEnterInitializingModeComplete
helicsFederateEnterInitializingModeIterative
helicsFederateEnterInitializingModeIterativeAsync
helicsFederateEnterInitializingModeIterativeComplete
helicsFederateIsAsyncOperationCompleted
helicsFederateEnterExecutingMode
helicsFederateEnterExecutingModeAsync
helicsFederateEnterExecutingModeComplete
helicsFederateEnterExecutingModeIterative
helicsFederateEnterExecutingModeIterativeAsync
helicsFederateEnterExecutingModeIterativeComplete
helicsFederateGetState
helicsFederateGetCore
helicsFederateRequestTime
helicsFederateRequestTimeAdvance
helicsFederateRequestNextStep
helicsFederateRequestTimeIterative
helicsFederateRequestTimeAsync
helicsFederateRequestTimeComplete
helicsFederateRequestTimeIterativeAsync
helicsFederateRequestTimeIterativeComplete
helicsFederateProcessCommunications
helicsFederateGetName
helicsFederateSetTimeProperty
helicsFederateSetFlagOption
helicsFederateSetSeparator
helicsFederateSetIntegerProperty
helicsFederateGetTimeProperty
helicsFederateGetFlagOption
helicsFederateGetIntegerProperty
helicsFederateGetCurrentTime
helicsFederateAddAlias
helicsFederateSetGlobal
helicsFederateSetTag
helicsFederateGetTag
helicsFederateAddDependency
helicsFederateSetLogFile
helicsFederateLogErrorMessage
helicsFederateLogWarningMessage
helicsFederateLogInfoMessage
helicsFederateLogDebugMessage
helicsFederateLogLevelMessage
helicsFederateSendCommand
helicsFederateGetCommand
helicsFederateGetCommandSource
helicsFederateWaitCommand
helicsFederateSetLoggingCallback
helicsFederateSetQueryCallback
helicsFederateSetTimeRequestEntryCallback
helicsFederateSetTimeUpdateCallback
helicsFederateSetStateChangeCallback
helicsFederateSetTimeRequestReturnCallback
helicsFederateInitializingEntryCallback
helicsFederateExecutingEntryCallback
helicsFederateCosimulationTerminationCallback
helicsFederateErrorHandlerCallback
helicsFederateRegisterTranslator
helicsFederateRegisterGlobalTranslator
helicsFederateGetTranslatorCount
helicsFederateGetTranslator
helicsFederateGetTranslatorByIndex

Value Federate Functions

functions applying to federates created as a value or combination federate HelicsFederate objects

Publication interface Functions

functions applying to a HelicsPublication object

Input interface Functions

functions applying to a HelicsInput object

Message Federate Functions

Functions applying to federates created as a value or combination federate HelicsFederate objects

Message object Functions

functions applying to a HelicsMessage

object Functions

functions applying to a HelicsData buffer

helicsDataBufferIsValid
helicsDataBufferFree
helicsDataBufferSize
helicsDataBufferCapacity
helicsDataBufferReserve
helicsDataBufferClone
helicsDataBufferFillFromInteger
helicsDataBufferFillFromDouble
helicsDataBufferFillFromString
helicsDataBufferFillFromRawString
helicsDataBufferFillFromBoolean
helicsDataBufferFillFromChar
helicsDataBufferFillFromTime
helicsDataBufferFillFromComplex
helicsDataBufferFillFromComplexObject
helicsDataBufferFillFromVector
helicsDataBufferFillFromNamedPoint
helicsDataBufferFillFromComplexVector
helicsDataBufferType
helicsDataBufferToInteger
helicsDataBufferToDouble
helicsDataBufferToBoolean
helicsDataBufferToChar
helicsDataBufferStringSize
helicsDataBufferToString
helicsDataBufferToRawString
helicsDataBufferToTime
helicsDataBufferToComplexObject
helicsDataBufferToComplex
helicsDataBufferVectorSize
helicsDataBufferToVector
helicsDataBufferToComplexVector
helicsDataBufferToNamedPoint
helicsDataBufferConvertToType

Endpoint interface Functions

functions applying to a HelicsEndpoint object

Filter Federate Functions

Functions applying to all federates but related to HelicsFilter

Filter interface Functions

Functions applying to a HelicsFilter object

Translator interface Functions

Functions applying to a HelicsTranslator object

helicsTranslatorSetCustomCallback
helicsTranslatorIsValid
helicsTranslatorGetName
helicsTranslatorSet
helicsTranslatorSetString
helicsTranslatorAddInputTarget
helicsTranslatorAddPublicationTarget
helicsTranslatorAddSourceEndpoint
helicsTranslatorAddDestinationEndpoint
helicsTranslatorRemoveTarget
helicsTranslatorGetInfo
helicsTranslatorSetInfo
helicsTranslatorGetTag
helicsTranslatorSetTag
helicsTranslatorSetOption
helicsTranslatorGetOption

Query Functions

functions applying to a HelicsQuery object