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

#include <FilterInfo.hpp>

Public Member Functions

 FilterInfo (global_broker_id core_id_, interface_handle handle_, const std::string &key_, const std::string &type_in_, const std::string &type_out_, bool destFilter_)
 
void removeTarget (global_handle targetToRemove)
 

Public Attributes

const global_broker_id core_id
 id of the core that manages the filter
 
const interface_handle handle
 id handle of the filter
 
const std::string key
 the identifier of the filter
 
const std::string inputType
 the type of data for the filter
 
const std::string outputType
 the outputType of data of the filter
 
const bool dest_filter = false
 
bool cloning = false
 indicator that the filter is a destination filter More...
 
uint16_t flags = 0
 flags for the filter
 
std::shared_ptr< FilterOperatorfilterOp
 the callback operation of the filter
 
std::vector< global_handlesourceTargets
 
std::vector< global_handledestTargets
 

Detailed Description

data class defining the information about a filter

Constructor & Destructor Documentation

◆ FilterInfo()

helics::FilterInfo::FilterInfo ( global_broker_id  core_id_,
interface_handle  handle_,
const std::string &  key_,
const std::string &  type_in_,
const std::string &  type_out_,
bool  destFilter_ 
)
inline

constructor from all fields

Member Function Documentation

◆ removeTarget()

void helics::FilterInfo::removeTarget ( global_handle  targetToRemove)

remove a target from interface with the filter

Member Data Documentation

◆ cloning

bool helics::FilterInfo::cloning = false

indicator that the filter is a destination filter

indicator that the filter is a cloning filter

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


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