Home > Articles

The Well-Crafted Class in C++: Part 1

Often when we create a class from scratch, it's only complete enough for the task at hand. But what if you want to create a library that's generally useful to the outside world? A class needs to be more complete and more robust. Hal Fulton discusses some decisions you need to make and things you should keep in mind for both internals and externals.
Like this article? We recommend

In any project, the highest priority is to get the job done. Rather than being pretty, rather than being complete, the code must first work.

So when we (as programmers) create classes for use in custom applications, we tend to cut corners. This is not a good thing, but we have all done it. We leave out features that perhaps should belong to that class, or we skimp on activities such as testing and documentation (especially the latter). This is not necessarily carelessness; it's often the pressure of deadlines.

This is in contrast to our internal urge, which is to make a class complete and robust. A surprising number of us even enjoy documentation if we are proud of the work we have done on the code. The hacker's instinct—and I use the word hacker in the classic sense—is to create well-rounded, general-purpose tools. In this article, I will indulge that instinct.

After all, the class isn't always tangential to our purposes. What if we want to distribute the class or library itself? In that case, this piece of code is our main purpose.

What I want to discuss here is a set of guidelines—an incomplete set, of course. It is more nearly complete in terms of interface design; much less so in terms of implementation. If you want more complete advice, you should be looking in books, not just articles. Read materials by Bjarne Stroustrup himself if you want to go to the source or if you're heavily into theory; and read Scott Meyers if you're a little more of a pragmatist. Both writers are excellent.

What's more, I have no intention of teaching C++ or object-oriented programming here. If you have no idea what a virtual function is, or how inheritance works, refer to a tutorial.

Some of what I say will be common sense; other parts will be controversial. In no sense is it a set of rigid inflexible rules or a checklist we should follow mindlessly. My hope is that this material will help to jog your memory ("Oh yes, I forgot to do such-and-such"), will help correct little defects and add useful features, and will ultimately result in a better piece of code. If you remember the song a few years ago that said, "wear sunscreen," you already know the kind of advice I am offering and the spirit in which you should take it.

Getting Started

The question then is this: What makes a good class in C++? I can't answer this simply or directly. Let me break it down into a set of questions and decisions that a programmer should address.

First of all, is there any way you can leverage existing knowledge from the industry and the community? If there is a relevant, well-known design pattern, code consciously according to that pattern. A common example is the Model-View-Controller pattern (MVC), in which the internal data representation is kept separate from the external view of the data. This crops up in everything from text editors to web-based shopping carts. A good understanding of these frequently recurring patterns can act as a kind of mental amplifier. I recommend the modern classic Design Patterns by the "Gang of Four" (Erich Gamma et al, Addison-Wesley, 1995). This book can serve you well, especially coding in a static language such as C++ or Java.

Can you make your implementation easier by using the Standard Template Library (STL)? Then don't be afraid to do so (unless some of your users have older compilers without STL). If you reinvent the wheel, do it only for a good reason. Do you need to make internal use of a stack or queue? Then use an existing container class from the STL instead of creating your own.

The next question I would ask myself is: Why is this a class in the first place? Bjarne Stroustrup identifies a kind of class which he calls a concrete data type—a data type that is created for convenience, but doesn't necessarily fit into an inheritance hierarchy. In OOP terms, we would say that its chief reason for being is encapsulation. An example is a date class that I wrote several years ago (for handling times and dates in a high-level, object-oriented fashion). Such a class doesn't inherit from anything else; and we normally don't expect it to have child classes, either. Always ask yourself whether this simple case holds true. In short, don't complicate a design unnecessarily.

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.

Overview


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information


To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.

Surveys

Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.

Newsletters

If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information


Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.

Security


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.

Children


This site is not directed to children under the age of 13.

Marketing


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information


If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.

Choice/Opt-out


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information


Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents


California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure


Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.

Links


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact


Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice


We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020