helics  3.0.1
Public Member Functions | List of all members
helics::InterfaceInfo Class Reference

#include <InterfaceInfo.hpp>

Public Member Functions

const PublicationInfogetPublication (const std::string &pubName) const
 
const PublicationInfogetPublication (InterfaceHandle handle) const
 
PublicationInfogetPublication (const std::string &pubName)
 
PublicationInfogetPublication (InterfaceHandle handle)
 
const InputInfogetInput (const std::string &inputName) const
 
const InputInfogetInput (InterfaceHandle handle) const
 
InputInfogetInput (const std::string &inputName)
 
InputInfogetInput (InterfaceHandle handle)
 
const EndpointInfogetEndpoint (const std::string &endpointName) const
 
const EndpointInfogetEndpoint (InterfaceHandle handle) const
 
EndpointInfogetEndpoint (const std::string &endpointName)
 
EndpointInfogetEndpoint (InterfaceHandle handle)
 
void createPublication (InterfaceHandle handle, const std::string &key, const std::string &type, const std::string &units)
 
void createInput (InterfaceHandle handle, const std::string &key, const std::string &type, const std::string &units)
 
void createEndpoint (InterfaceHandle handle, const std::string &endpointName, const std::string &type)
 
auto getEndpoints ()
 
auto getPublications ()
 
auto getInputs ()
 
auto getEndpoints () const
 
auto getPublications () const
 
auto getInputs () const
 
auto cgetEndpoints () const
 
auto cgetPublications () const
 
auto cgetInputs () const
 
void setGlobalId (GlobalFederateId newglobalId)
 
void setChangeUpdateFlag (bool updateFlag)
 
bool getChangeUpdateFlag () const
 
bool setInputProperty (InterfaceHandle id, int32_t option, int32_t value)
 
bool setPublicationProperty (InterfaceHandle id, int32_t option, int32_t value)
 
bool setEndpointProperty (InterfaceHandle id, int32_t option, int32_t value)
 
int32_t getInputProperty (InterfaceHandle id, int32_t option) const
 
int32_t getPublicationProperty (InterfaceHandle id, int32_t option) const
 
int32_t getEndpointProperty (InterfaceHandle id, int32_t option) const
 
std::vector< std::pair< int, std::string > > checkInterfacesForIssues ()
 
void generateInferfaceConfig (Json::Value &base) const
 
void GenerateDataFlowGraph (Json::Value &base) const
 

Detailed Description

generic class for holding information about interfaces for a core federate structure

Member Function Documentation

◆ checkInterfacesForIssues()

std::vector< std::pair< int, std::string > > helics::InterfaceInfo::checkInterfacesForIssues ( )

check the interfaces for specific issues

◆ GenerateDataFlowGraph()

void helics::InterfaceInfo::GenerateDataFlowGraph ( Json::Value &  base) const

load a dependency graph for the interfaces

◆ generateInferfaceConfig()

void helics::InterfaceInfo::generateInferfaceConfig ( Json::Value &  base) const

generate a configuration script for the interfaces

◆ getChangeUpdateFlag()

bool helics::InterfaceInfo::getChangeUpdateFlag ( ) const
inline

get the current value of the change update flag

◆ getInputProperty()

int32_t helics::InterfaceInfo::getInputProperty ( InterfaceHandle  id,
int32_t  option 
) const

get properties for an interface

◆ setChangeUpdateFlag()

void helics::InterfaceInfo::setChangeUpdateFlag ( bool  updateFlag)

set the change update flag which controls when a subscription is updated

◆ setGlobalId()

void helics::InterfaceInfo::setGlobalId ( GlobalFederateId  newglobalId)
inline

set the global id of the federate for use in the interfaces

Referenced by helics::FederateState::reset().

◆ setInputProperty()

bool helics::InterfaceInfo::setInputProperty ( InterfaceHandle  id,
int32_t  option,
int32_t  value 
)

set a property on a specific interface


The documentation for this class was generated from the following files: