helics  2.8.1
Public Member Functions | Public Attributes | List of all members
helics::BasicHandleInfo Class Reference

#include <BasicHandleInfo.hpp>

Public Member Functions

 BasicHandleInfo () noexcept
 
 BasicHandleInfo (global_federate_id federate_id, interface_handle handle_id, handle_type type_of_handle, const std::string &key_name, const std::string &type_name, const std::string &unit_name)
 
interface_handle getInterfaceHandle () const
 
global_federate_id getFederateId () const
 
void setInfoField (std::string &info)
 

Public Attributes

const global_handle handle {}
 the global federate id for the creator of the handle
 
local_federate_id local_fed_id {}
 the local federate id of the handle
 
const handle_type handleType {handle_type::unknown}
 the type of the handle
 
bool used {false}
 indicator that the handle is being used to link with another federate
 
uint16_t flags
 flags corresponding to the flags used in ActionMessages +some extra ones More...
 
const std::string key
 the name of the handle
 
const std::string type
 the type of data used by the handle
 
const std::string units
 the units associated with the handle
 
std::string interface_info
 storage for a user info string
 
const std::string & type_in
 the input type of a filter
 
const std::string & type_out
 the output type of a filter
 

Detailed Description

class defining and capturing basic information about a handle

Constructor & Destructor Documentation

◆ BasicHandleInfo() [1/2]

helics::BasicHandleInfo::BasicHandleInfo ( )
inlinenoexcept

default constructor

◆ BasicHandleInfo() [2/2]

helics::BasicHandleInfo::BasicHandleInfo ( global_federate_id  federate_id,
interface_handle  handle_id,
handle_type  type_of_handle,
const std::string &  key_name,
const std::string &  type_name,
const std::string &  unit_name 
)
inline

construct from the data

Member Function Documentation

◆ getFederateId()

global_federate_id helics::BasicHandleInfo::getFederateId ( ) const
inline

◆ getInterfaceHandle()

interface_handle helics::BasicHandleInfo::getInterfaceHandle ( ) const
inline

get the interface handle information

References handle, and helics::global_handle::handle.

Referenced by helics::FilterFederate::destinationProcessMessage().

◆ setInfoField()

void helics::BasicHandleInfo::setInfoField ( std::string &  info)
inline

set the user level information field

References interface_info.

Member Data Documentation

◆ flags

uint16_t helics::BasicHandleInfo::flags
Initial value:
{
0}

flags corresponding to the flags used in ActionMessages +some extra ones


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