API — ICoreSDK/ICoreStudio/StudioObjects/Panels/Tools

The public contract of 8 header(s) under src/ICoreSDK/ICoreStudio/StudioObjects/Panels/Tools — 8 class/struct definition(s), 20 declaration(s). Each section shows the header's banner and its public (and protected-virtual) surface exactly as the file writes it.

ICoreToolWindowSignalPicker.h#

src/ICoreSDK/ICoreStudio/StudioObjects/Panels/Tools/ICoreToolWindowSignalPicker.h

ICoreToolWindowSignalPicker#

ICoreToolWindowSignalPicker.h:31 · class · bases public ICoreComboBox · pImpl · 5 declaration(s)

Option picker listing recorded signals -- the time series held in the variables space, whether written there by a Signal Recorder block or scripted by hand in Quick Code.

class ICoreToolWindowSignalPicker : public ICoreComboBox {
public:
    explicit ICoreToolWindowSignalPicker(ICoreWidget* parent = nullptr);
    ~ICoreToolWindowSignalPicker() override;

    // Re-reads the variables space, keeping the current pick when it survives
    // the rescan. Call whenever the window becomes visible.
    void refresh();

    // Resolves the picked entry to a matrix: the signal's times as a column
    // vector, or its whole N x M value block. Re-scans first, so a pick that has
    // been deleted or overwritten since the last refresh() fails cleanly rather
    // than resolving stale data. Returns false with `error` set on failure
    // (nothing picked, a pick that no longer exists, or an empty signal). Not
    // const -- getChosenOption() isn't.
    bool resolveToMatrix(ICoreMatrix& out, ICoreString& error);

    // The picked entry as a whole time series, times included -- what lets a
    // caller scale an axis in real units instead of sample index.
    bool resolveToTimeSeries(ICoreTimeSeries& out, ICoreString& error);

private:
    class Impl;                    // the two-line residue; state lives here
    std::unique_ptr<Impl> impl;
};

ICoreToolWindowTransferFunctionPicker.h#

src/ICoreSDK/ICoreStudio/StudioObjects/Panels/Tools/ICoreToolWindowTransferFunctionPicker.h

ICoreToolWindowTransferFunctionPicker#

ICoreToolWindowTransferFunctionPicker.h:18 · class · bases public ICoreComboBox · 3 declaration(s)

Option picker listing "Transfer Function"-typed console variables, used by the classical-control-analysis tool window as its "pick a transfer function" input.

class ICoreToolWindowTransferFunctionPicker : public ICoreComboBox {
public:
    explicit ICoreToolWindowTransferFunctionPicker(ICoreWidget* parent = nullptr);

    // Re-scans "Transfer Function"-typed console variables, keeping the current
    // pick when it survives the rescan. Call whenever the window becomes visible.
    void refresh();

    // Resolves the picked variable name to a transfer function. Returns false
    // with `error` set on failure. Not const -- getChosenOption() isn't.
    bool resolveToTransferFunction(ICoreTransferFunction& out, ICoreString& error);

};
};

ICoreClassicalControlAnalysisToolWindow.h#

src/ICoreSDK/ICoreStudio/StudioObjects/Panels/Tools/ClassicalControlAnalysis/ICoreClassicalControlAnalysisToolWindow.h

ICoreClassicalControlAnalysisToolWindow#

ICoreClassicalControlAnalysisToolWindow.h:23 · class · bases public ICoreWidget · pImpl · 2 declaration(s)

Standalone tool window for classical control analysis: pick a transfer function (a console variable or an expression like tf([1],[1,2,1])) and run Bode, Nyquist, root locus, pole-zero map, or a ste...

class ICoreClassicalControlAnalysisToolWindow : public ICoreWidget {
public:
    explicit ICoreClassicalControlAnalysisToolWindow(ICoreWidget* parent = nullptr);
    ~ICoreClassicalControlAnalysisToolWindow() override;

protected:
    void shown() override;// refresh the TF picker on open

private:
    class Impl;                    // the two-line residue; state lives here
    std::unique_ptr<Impl> impl;
};

ICoreFFTToolWindow.h#

src/ICoreSDK/ICoreStudio/StudioObjects/Panels/Tools/FFTAnalysis/ICoreFFTToolWindow.h

ICoreFFTToolWindow#

ICoreFFTToolWindow.h:30 · class · bases public ICoreWidget · pImpl · 2 declaration(s)

Standalone tool window for FFT analysis: pick a recorded signal (a Signal Recorder block's time series, read from the variables space) and compute its spectrum.

class ICoreFFTToolWindow : public ICoreWidget {
public:
    explicit ICoreFFTToolWindow(ICoreWidget* parent = nullptr);
    ~ICoreFFTToolWindow() override;

protected:
    void shown() override;// refresh the signal picker on open

private:
    class Impl;                    // the two-line residue; state lives here
    std::unique_ptr<Impl> impl;
};

ICoreFilterDesignToolWindow.h#

src/ICoreSDK/ICoreStudio/StudioObjects/Panels/Tools/FilterDesign/ICoreFilterDesignToolWindow.h

ICoreFilterDesignToolWindow#

ICoreFilterDesignToolWindow.h:21 · class · bases public ICoreWidget · pImpl · 2 declaration(s)

Standalone tool window for digital Butterworth filter design: pick an order, cutoff frequency and sample rate, and lowpass/highpass, then show the resulting transfer function and optionally save it...

class ICoreFilterDesignToolWindow : public ICoreWidget {
public:
    explicit ICoreFilterDesignToolWindow(ICoreWidget* parent = nullptr);
    ~ICoreFilterDesignToolWindow() override;

private:
    class Impl;                    // the two-line residue; state lives here
    std::unique_ptr<Impl> impl;
};

ICoreQuaternionToolWindow.h#

src/ICoreSDK/ICoreStudio/StudioObjects/Panels/Tools/QuaternionConverter/ICoreQuaternionToolWindow.h

ICoreQuaternionToolWindow#

ICoreQuaternionToolWindow.h:22 · class · bases public ICoreWidget · pImpl · 2 declaration(s)

Standalone quaternion/rotation converter: three "set from" input groups (axis-angle, Euler ZYX, 3x3 rotation matrix) feeding one shared quaternion state, whose derived rotation matrix and Euler ang...

class ICoreQuaternionToolWindow : public ICoreWidget {
public:
    explicit ICoreQuaternionToolWindow(ICoreWidget* parent = nullptr);
    ~ICoreQuaternionToolWindow() override;

private:
    class Impl;                    // the two-line residue; state lives here
    std::unique_ptr<Impl> impl;
};

ICoreSplineToolWindow.h#

src/ICoreSDK/ICoreStudio/StudioObjects/Panels/Tools/SplineFitting/ICoreSplineToolWindow.h

ICoreSplineToolWindow#

ICoreSplineToolWindow.h:23 · class · bases public ICoreWidget · pImpl · 2 declaration(s)

Standalone tool window for interp1/spline fitting: pick x/y sample signals (recorded, from Signal Recorder blocks) or console variables, plus a query-points source, and plot the fitted curve.

class ICoreSplineToolWindow : public ICoreWidget {
public:
    explicit ICoreSplineToolWindow(ICoreWidget* parent = nullptr);
    ~ICoreSplineToolWindow() override;

protected:
    void shown() override;   // refresh the x/y/xq pickers on open

private:
    class Impl;                    // the two-line residue; state lives here
    std::unique_ptr<Impl> impl;
};

ICoreSystemIdentificationToolWindow.h#

src/ICoreSDK/ICoreStudio/StudioObjects/Panels/Tools/SystemIdentification/ICoreSystemIdentificationToolWindow.h

ICoreSystemIdentificationToolWindow#

ICoreSystemIdentificationToolWindow.h:26 · class · bases public ICoreWidget · pImpl · 2 declaration(s)

Standalone tool window for tfest: pick the recorded input/output signals (time series from the variables space) plus a model order and an estimator, fit a discrete transfer function, show it in can...

class ICoreSystemIdentificationToolWindow : public ICoreWidget {
public:
    explicit ICoreSystemIdentificationToolWindow(ICoreWidget* parent = nullptr);
    ~ICoreSystemIdentificationToolWindow() override;

protected:
    void shown() override;// refresh the u/y pickers on open

private:
    class Impl;                    // the two-line residue; state lives here
    std::unique_ptr<Impl> impl;
};