Actions
Forum Thread Details
  • Replies 22 replies
  • Subscribers 47 subscribers
  • Views 1221 views
  • Users 0 members are here
Related

find a good name for a C++ class

Jan Cumps

I'm designing two classes, for a stepper motor project:

  • one can send commands to a stepper motor.
    Each command has the number of steps and direction
    Running the motor happens async. Once the first command is sent, the motor heads off, until all commands are done.
    I named it stepper

  • the other class does the same, but it can notify the caller when it has completed a command.
    I named it stepper_interrupt

I'm not happy with that second name. It doesn't show what the class does. It's named after how it does it. I don't like that.

Do you have a better name?

please don't call it Stepper McStepperFace

Parents

  • If I listen to ChatGPT, this would be a possible naming schema:

    image

  • in reply to Jan Cumps 

    class stepper_controller {
public:
    stepper_controller(PIO pio, uint sm) : pio_(pio), sm_(sm) {}
    virtual ~stepper_controller() {}
    take_steps(count, reverse);
    set_delay(delay)
// ...
};

class stepper_callback_controller : public stepper_controller {
private:

    class interrupt_manager {
    public:        // if an object is currently handling a pio + sm combination, it will 
        static bool register_stepper(stepper_callback_controller * stepper, bool step) {
            // ... logic to be able to send PIO IRQ to correct object
        }
    // ...
    };   

public:
    stepper_callback_controller(PIO pio, uint sm) : 
        stepper_controller(pio,sm), 
        commands_(0U),
        callback_(nullptr) {
        interrupt_manager::register_stepper(this, true);
    }
    virtual ~stepper_callback_controller() {
        interrupt_manager::register_stepper(this, false);
    }
    uint commands();
    void reset_commands();
    void on_complete_callback(handler);
    // ...
};

Reply
  • in reply to Jan Cumps 

    class stepper_controller {
public:
    stepper_controller(PIO pio, uint sm) : pio_(pio), sm_(sm) {}
    virtual ~stepper_controller() {}
    take_steps(count, reverse);
    set_delay(delay)
// ...
};

class stepper_callback_controller : public stepper_controller {
private:

    class interrupt_manager {
    public:        // if an object is currently handling a pio + sm combination, it will 
        static bool register_stepper(stepper_callback_controller * stepper, bool step) {
            // ... logic to be able to send PIO IRQ to correct object
        }
    // ...
    };   

public:
    stepper_callback_controller(PIO pio, uint sm) : 
        stepper_controller(pio,sm), 
        commands_(0U),
        callback_(nullptr) {
        interrupt_manager::register_stepper(this, true);
    }
    virtual ~stepper_callback_controller() {
        interrupt_manager::register_stepper(this, false);
    }
    uint commands();
    void reset_commands();
    void on_complete_callback(handler);
    // ...
};

Children
No Data