Skip to content

feat: added functionality for Wave Generator #2826

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: flutter
Choose a base branch
from

Conversation

AsCress
Copy link
Collaborator

@AsCress AsCress commented Aug 10, 2025

Adds the functionality for the Wave Generator instrument.

Summary by Sourcery

Introduce state management for the Wave Generator instrument with enums for constants and data limits and a ChangeNotifier provider to track selected wave types.

New Features:

  • Define WaveConst enum listing wave types and parameters
  • Define WaveData enum encapsulating min/max values for frequency, phase, and duty cycle
  • Implement WaveGeneratorStateProvider to manage and initialize analog and digital wave selections

@AsCress AsCress self-assigned this Aug 10, 2025
@AsCress AsCress added Feature New addition to the existing app flutter labels Aug 10, 2025
Copy link
Contributor

sourcery-ai bot commented Aug 10, 2025

Reviewer's Guide

Introduces Wave Generator state management by adding WaveConst and WaveData enums and implementing a ChangeNotifier-based provider to track wave selection states.

Entity relationship diagram for Wave Generator enums

erDiagram
    WAVE_CONST {
        ENUM waveType
        ENUM wave1
        ENUM wave2
        ENUM sqr1
        ENUM sqr2
        ENUM sqr3
        ENUM sqr4
        ENUM frequency
        ENUM phase
        ENUM duty
        ENUM square
        ENUM pwm
    }
    WAVE_DATA {
        ENUM freqMin
        ENUM dutyMin
        ENUM phaseMin
        ENUM freqMax
        ENUM phaseMax
        ENUM dutyMax
        INT value
    }
    WAVE_CONST ||--o{ WAVE_GENERATOR_STATE_PROVIDER : uses
    WAVE_DATA ||--o{ WAVE_GENERATOR_STATE_PROVIDER : uses
Loading

Class diagram for Wave Generator state management

classDiagram
    class WaveGeneratorStateProvider {
        +bool isAnalogWaveSelected
        +bool isSine1Selected
        +bool isSine2Selected
        +bool isDigitalWaveSelected
        +bool isSqr1Selected
        +bool isSqr2Selected
        +bool isSqr3Selected
        +bool isSqr4Selected
        +WaveGeneratorStateProvider()
    }
    class WaveConst {
    }
    class WaveData {
        +int value
        +WaveData(int value)
        +int getValue
    }
    WaveGeneratorStateProvider --|> ChangeNotifier
    WaveData <|-- enum
    WaveConst <|-- enum
Loading

File-Level Changes

Change Details Files
Defined WaveConst enumeration for wave parameter identifiers
  • Added enum WaveConst with entries for wave types (analog, sine, digital, square) and parameters (frequency, phase, duty, PWM)
lib/providers/wave_generator_state_provider.dart
Introduced WaveData enum to encapsulate min/max constraints with getter
  • Added enum WaveData with values for frequency, phase, duty limits
  • Implemented custom constructor and getValue accessor
lib/providers/wave_generator_state_provider.dart
Implemented WaveGeneratorStateProvider to manage selection state
  • Extended ChangeNotifier to create provider class
  • Declared boolean flags for analog/digital wave selections
  • Initialized all selection flags with default values in constructor
lib/providers/wave_generator_state_provider.dart

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

github-actions bot commented Aug 10, 2025

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Feature New addition to the existing app flutter
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant