ControllerInput Struct Reference

Kynema API: kynema::interfaces::components::ControllerInput Struct Reference
Kynema API
A flexible multibody structural dynamics code for wind turbines
Loading...
Searching...
No Matches
kynema::interfaces::components::ControllerInput Struct Reference

Configuration parameters for a DISCON-style turbine controller. More...

#include <controller_input.hpp>

Public Member Functions

 ControllerInput ()=default
 Default constructor - creates empty controller input.
 
 ControllerInput (std::string lib_path, std::string func_name="DISCON", std::string inp_file_path="", std::string sim_name="")
 Constructor with all parameters.
 
bool IsEnabled () const
 Check if controller is enabled (i.e. has library path)
 

Public Attributes

std::string shared_lib_path
 Path to controller shared library.
 
std::string function_name
 Controller function name (default: "DISCON")
 
std::string input_file_path
 Path to controller input file.
 
std::string simulation_name
 Simulation name for controller.
 

Detailed Description

Configuration parameters for a DISCON-style turbine controller.

This struct encapsulates all the necessary configuration parameters needed to initialize and configure a DISCON-style wind turbine controller. DISCON is a standardized interface for wind turbine control algorithms that allows for dynamic loading of controller implementations at runtime.

Constructor & Destructor Documentation

◆ ControllerInput() [1/2]

kynema::interfaces::components::ControllerInput::ControllerInput ( )
default

Default constructor - creates empty controller input.

◆ ControllerInput() [2/2]

kynema::interfaces::components::ControllerInput::ControllerInput ( std::string  lib_path,
std::string  func_name = "DISCON",
std::string  inp_file_path = "",
std::string  sim_name = "" 
)
inlineexplicit

Constructor with all parameters.

Parameters
lib_pathPath to the shared library containing the controller implementation
func_nameName of the controller function to call (defaults to "DISCON")
inp_file_pathOptional path to controller-specific configuration file
sim_nameOptional identifier for the simulation run

Member Function Documentation

◆ IsEnabled()

bool kynema::interfaces::components::ControllerInput::IsEnabled ( ) const
inline

Check if controller is enabled (i.e. has library path)

Returns
If the shared library path is set

Member Data Documentation

◆ function_name

std::string kynema::interfaces::components::ControllerInput::function_name

Controller function name (default: "DISCON")

◆ input_file_path

std::string kynema::interfaces::components::ControllerInput::input_file_path

Path to controller input file.

◆ shared_lib_path

std::string kynema::interfaces::components::ControllerInput::shared_lib_path

Path to controller shared library.

◆ simulation_name

std::string kynema::interfaces::components::ControllerInput::simulation_name

Simulation name for controller.


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