helics::InterfaceInfo Class Reference

#include <InterfaceInfo.hpp>

Public Member Functions
const PublicationInfo *	getPublication (const std::string &pubName) const
const PublicationInfo *	getPublication (interface_handle handle) const
PublicationInfo *	getPublication (const std::string &pubName)
PublicationInfo *	getPublication (interface_handle handle)
const InputInfo *	getInput (const std::string &inputName) const
const InputInfo *	getInput (interface_handle handle) const
InputInfo *	getInput (const std::string &inputName)
InputInfo *	getInput (interface_handle handle)
const EndpointInfo *	getEndpoint (const std::string &endpointName) const
const EndpointInfo *	getEndpoint (interface_handle handle) const
EndpointInfo *	getEndpoint (const std::string &endpointName)
EndpointInfo *	getEndpoint (interface_handle handle)
void	createPublication (interface_handle handle, const std::string &key, const std::string &type, const std::string &units)
void	createInput (interface_handle handle, const std::string &key, const std::string &type, const std::string &units)
void	createEndpoint (interface_handle 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 (global_federate_id newglobalId)
void	setChangeUpdateFlag (bool updateFlag)
bool	getChangeUpdateFlag () const
bool	setInputProperty (interface_handle id, int32_t option, int32_t value)
bool	setPublicationProperty (interface_handle id, int32_t option, int32_t value)
bool	setEndpointProperty (interface_handle id, int32_t option, int32_t value)
int32_t	getInputProperty (interface_handle id, int32_t option) const
int32_t	getPublicationProperty (interface_handle id, int32_t option) const
int32_t	getEndpointProperty (interface_handle 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	(	interface_handle	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

References helics::ip.

setGlobalId()

void helics::InterfaceInfo::setGlobalId ( global_federate_id  newglobalId )

inline

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

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

setInputProperty()

bool helics::InterfaceInfo::setInputProperty	(	interface_handle	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:

• InterfaceInfo.hpp
• InterfaceInfo.cpp