Engee documentation

simulation_signal

Page in progress.

Creates a signal object.

Library

EngeeDesignOptimization

Description

Function simulation_signal creates an object EngeeDesignOptimization.SimulationSignal, which binds the data to the model’s signal.

Syntax

Function call

  • signal = simulation_signal() — creates a signal object signal with default property values.

  • signal = simulation_signal(Name=Value) — creates an object signal and sets its properties using one or more arguments of the type «name-value».

Arguments

Input arguments

# base_signal is the original signal

+ object

Details

The object of the signal. The object contains the following properties: block_path, block, port, values, name.

Типы данных

EngeeDesignOptimization.SimulationSignal

Input arguments «name-value»

Specify optional argument pairs as Name=Value, where Name — the name of the argument, and Value — the appropriate value. The order of type arguments «name-value» It doesn’t matter.

# block_path is the path to the system where the port is located
"" (by default) | line

Details

The path to the system in the model where the port is located, specified as a string.

Типы данных

String

# block — the name of the system where the port is located
"" (by default) | line

Details

The name of the system where the port is located, set as a string.

Типы данных

String

# port — port name

+ "" (by default) | line

Details

The name of the port, set as a string.

Типы данных

String

# values — signal values

+ DataFrame() (by default) | tabular data

Details

Signal values set as tabular data.

Типы данных

DataFrame

# name — the name of the signal

+ "" (by default) | line

Details

The name of the signal in the model, set as a string.

Типы данных

String

Output arguments

# signal — signal

+ object

Details

The object of the signal. The object contains the following properties: block_path, block, port, values, name.

Типы данных

EngeeDesignOptimization.SimulationSignal