element14 Community
element14 Community
    Register Log In
  • Site
  • Search
  • Log In Register
  • About Us
  • Community Hub
    Community Hub
    • What's New on element14
    • Feedback and Support
    • Benefits of Membership
    • Personal Blogs
    • Members Area
    • Achievement Levels
  • Learn
    Learn
    • Ask an Expert
    • eBooks
    • element14 presents
    • Learning Center
    • Tech Spotlight
    • STEM Academy
    • Webinars, Training and Events
    • Learning Groups
  • Technologies
    Technologies
    • 3D Printing
    • FPGA
    • Industrial Automation
    • Internet of Things
    • Power & Energy
    • Sensors
    • Technology Groups
  • Challenges & Projects
    Challenges & Projects
    • Design Challenges
    • element14 presents Projects
    • Project14
    • Arduino Projects
    • Raspberry Pi Projects
    • Project Groups
  • Products
    Products
    • Arduino
    • Avnet Boards Community
    • Dev Tools
    • Manufacturers
    • Multicomp Pro
    • Product Groups
    • Raspberry Pi
    • RoadTests & Reviews
  • Store
    Store
    • Visit Your Store
    • Choose another store...
      • Europe
      •  Austria (German)
      •  Belgium (Dutch, French)
      •  Bulgaria (Bulgarian)
      •  Czech Republic (Czech)
      •  Denmark (Danish)
      •  Estonia (Estonian)
      •  Finland (Finnish)
      •  France (French)
      •  Germany (German)
      •  Hungary (Hungarian)
      •  Ireland
      •  Israel
      •  Italy (Italian)
      •  Latvia (Latvian)
      •  
      •  Lithuania (Lithuanian)
      •  Netherlands (Dutch)
      •  Norway (Norwegian)
      •  Poland (Polish)
      •  Portugal (Portuguese)
      •  Romania (Romanian)
      •  Russia (Russian)
      •  Slovakia (Slovak)
      •  Slovenia (Slovenian)
      •  Spain (Spanish)
      •  Sweden (Swedish)
      •  Switzerland(German, French)
      •  Turkey (Turkish)
      •  United Kingdom
      • Asia Pacific
      •  Australia
      •  China
      •  Hong Kong
      •  India
      •  Korea (Korean)
      •  Malaysia
      •  New Zealand
      •  Philippines
      •  Singapore
      •  Taiwan
      •  Thailand (Thai)
      • Americas
      •  Brazil (Portuguese)
      •  Canada
      •  Mexico (Spanish)
      •  United States
      Can't find the country/region you're looking for? Visit our export site or find a local distributor.
  • Translate
  • Profile
  • Settings
Embedded and Microcontrollers
  • Technologies
  • More
Embedded and Microcontrollers
Embedded Forum OO Digital Pin class: single class or separate in and out classes
  • Blog
  • Forum
  • Documents
  • Quiz
  • Polls
  • Files
  • Members
  • Mentions
  • Sub-Groups
  • Tags
  • More
  • Cancel
  • New
Join Embedded and Microcontrollers to participate - click to join for free!
Actions
  • Share
  • More
  • Cancel
Forum Thread Details
  • Replies 37 replies
  • Subscribers 462 subscribers
  • Views 4498 views
  • Users 0 members are here
Related

OO Digital Pin class: single class or separate in and out classes

Jan Cumps
Jan Cumps over 2 years ago

I'm experimenting with light-weight C++ for microcontrollers. Looking for your opinion for class(es) that represent GPIO pin behaviour

An output pin can

  • accept a value and set it
  • return the value it is set to
  • maybe go high-z

An input can:

  • return the value at its input

I may represent this

  • very simple as a single class.
    Getting the value would perform the "return" action above. The class would decide if it returns output state or input state internally
    Setting would only succeed if the pin is an output pin, else either throw an exception or silently ignore.
    Switching between the two would be simple
  • as separate classes
    out type pin would set the output as indicated, and return the output state if asked
    in type pin would return the value at its input. It would not provide setters.
    Switching between two modes would mean discarding the original object and creating one of the other kind.
    (should both classes inherit from a common parent that defines the actual pin?)

How would you solve this, as OO designer / abstractor that loves simplicity?

  • Sign in to reply
  • Cancel

Top Replies

  • shabaz
    shabaz over 2 years ago in reply to michaelkellett +3
    The compiler was way better than I thought... I gave it a shot with the GNU compiler for ARM, using the Pi Pico SDK. I created a simple class: Then that class is used in the main() function. The…
  • ggabe
    ggabe over 2 years ago +2
    Take a look at WiringPi, as an example how the single class API can be structured: http://wiringpi.com/reference/ I like how it can abstract MCU GPIO and IO expanders under the same API. if you need…
  • Andrew J
    Andrew J over 2 years ago +2
    On the basis of your points above, what you are essentially describing is a variable: you can set a value and you can read a value. I don't think that would benefit from being encapsulated by a class and…
Parents
  • Jan Cumps
    Jan Cumps over 2 years ago
    Andrew J said:
    ... Thus separate classes work but a writable pin is a specialisation of a readable pin and thus WriteablePin could be considered to inherit from ReadablePin rather than be viewed as a sibling of some abstract superclass (a WriteablePin is also a ReadablePin and works for polymorphic purposes.)

    MBED has taken one of your suggested approaches. Both In and Out are different classes, with no superclass.

    Andrew J said:
    Once you get into a situation of "If pinIsSettable Then setValue else throw exception" within method code, you've stepped outside OO paradigm (broken encapsulation) which is the situation with your single class.

    That, I think is debatable. And a reason for creating this forum post :). 
    What I have done for now, is: accept a write to an input pin. It will not change its status, but when you switch it from an input to an output pin, it will output that value.

    • Cancel
    • Vote Up +1 Vote Down
    • Sign in to reply
    • Cancel
Reply
  • Jan Cumps
    Jan Cumps over 2 years ago
    Andrew J said:
    ... Thus separate classes work but a writable pin is a specialisation of a readable pin and thus WriteablePin could be considered to inherit from ReadablePin rather than be viewed as a sibling of some abstract superclass (a WriteablePin is also a ReadablePin and works for polymorphic purposes.)

    MBED has taken one of your suggested approaches. Both In and Out are different classes, with no superclass.

    Andrew J said:
    Once you get into a situation of "If pinIsSettable Then setValue else throw exception" within method code, you've stepped outside OO paradigm (broken encapsulation) which is the situation with your single class.

    That, I think is debatable. And a reason for creating this forum post :). 
    What I have done for now, is: accept a write to an input pin. It will not change its status, but when you switch it from an input to an output pin, it will output that value.

    • Cancel
    • Vote Up +1 Vote Down
    • Sign in to reply
    • Cancel
Children
  • Andrew J
    Andrew J over 2 years ago in reply to Jan Cumps

    To be fair, I don't think it is debatable.  In any case, given the footprint, these sorts of tradeoffs are inevitable and in the code you have I think it's the better approach for that reason.

    • Cancel
    • Vote Up +1 Vote Down
    • Sign in to reply
    • Cancel
  • Jan Cumps
    Jan Cumps over 2 years ago in reply to Andrew J

    Why I think it should be open for discussion: following this guideline has (side)effects. 

    If there are enough situations where you have to make such (or other) decisions, and they don't group nicely (in reality most likely: won't group nicely) under a few categories, you can end up with a big class structure. 

    • Cancel
    • Vote Up 0 Vote Down
    • Sign in to reply
    • Cancel
element14 Community

element14 is the first online community specifically for engineers. Connect with your peers and get expert answers to your questions.

  • Members
  • Learn
  • Technologies
  • Challenges & Projects
  • Products
  • Store
  • About Us
  • Feedback & Support
  • FAQs
  • Terms of Use
  • Privacy Policy
  • Legal and Copyright Notices
  • Sitemap
  • Cookies

An Avnet Company © 2025 Premier Farnell Limited. All Rights Reserved.

Premier Farnell Ltd, registered in England and Wales (no 00876412), registered office: Farnell House, Forge Lane, Leeds LS12 2NE.

ICP 备案号 10220084.

Follow element14

  • X
  • Facebook
  • linkedin
  • YouTube