473,800 Members | 2,523 Online
Bytes | Software Development & Data Engineering Community
+ Post

Home Posts Topics Members FAQ

API Design

I am working on designing a set of abstract classes that would be subclassed
by the users and they have to implement the abtract (virtual) methods.

Does anybody know of a good reference on designing APIs and class libraries.
I am particularly interested on how to design interface classes, what kind
of methods to provide to the users, etc.

I'd like to emphasize that what I want to learn is not how to "create"
abstract classes and interfaces, but how to design
"good/extendable/maintainable" interfaces.

Thanks
Bora
Jul 23 '05 #1
7 2133
Bora Eryilmaz wrote:
I am working on designing a set of abstract classes that would be subclassed by the users and they have to implement the abtract (virtual) methods.
So you also have 3 completely different example projects that re-use this
library, right?
Does anybody know of a good reference on designing APIs and class libraries. I am particularly interested on how to design interface classes, what kind
of methods to provide to the users, etc.
Design Patterns, Refactoring, Refactoring to Patterns, and the "Interface
Segregation Principle" and "Dependency Inversion Principle" from Agile
Software Development.
I'd like to emphasize that what I want to learn is not how to "create"
abstract classes and interfaces, but how to design
"good/extendable/maintainable" interfaces.


Very briefly: By taking the extra care to push your library through enough
developmental iterations, with 3 or more clients, to see if it is in fact
maintainable. Anything else would be guesses, which are not good for
engineering.

--
Phlip
http://www.c2.com/cgi/wiki?ZeekLand
Jul 23 '05 #2
Phlip schrieb:
Very briefly: By taking the extra care to push your library through enough
developmental iterations, with 3 or more clients, to see if it is in fact
maintainable. Anything else would be guesses, which are not good for
engineering.

Q: How can I do X?
A: By doing it 3 times.

SCNR.

Jul 23 '05 #3
"Object-Oriented Analysis and Design with Applications (2rd Edition)"
by Grady Booch has a complete chapter titled "Frameworks : Foundation
Class Library". This chapter describes the process of designing a
framework API.

Deepa
--
EventStudio 2.5 - http://www.EventHelix.com/EventStudio
Generate Sequence diagrams from a simple declarative language

Jul 23 '05 #4
See Large-Scale C++ Software Design by Lakos. /david

Jul 23 '05 #5
da********@warp mail.net schrieb:
See Large-Scale C++ Software Design by Lakos. /david


although I agree that this is a very good book, I can't remember it
saying much about API design
Jul 23 '05 #6

Bora Eryilmaz wrote:
I am working on designing a set of abstract classes that would be subclassed by the users and they have to implement the abtract (virtual) methods.
Does anybody know of a good reference on designing APIs and class libraries. I am particularly interested on how to design interface classes, what kind of methods to provide to the users, etc.

I'd like to emphasize that what I want to learn is not how to "create" abstract classes and interfaces, but how to design
"good/extendable/maintainable" interfaces.

Thanks
Bora


Hi,

Good/Extendable/Maintainable interface designs comes with hands-on
experience and by looking into design of those industry standards...i
would recommend to you to look into the design of STLs which would give
a fair idea of how the interfaces are to be designed...(wou ld recomend
"C++ Programming Language" by B. Stroustrup for an explanation of the
STLs)

Also non-standards like Graph Template Library (GTL) and Boost Graph
Library (BGL) can help you learn many things about interface design.

Hope this would help you in design.

-vs_p..

Jul 23 '05 #7
Thanks for all your replies.

It was in fact the "C++ Programming Language" by B. Stroustrup that got me
interested in this subject (API design). I like Chapters 23-25 in this book
and read them a number of times. But other than these chapters, I cannot
find any other good references on the API design issues, with real examples
and applications.

There are, of course, all these books that talk about generic issues
regardind API & object design, with virtually no code examples and a lot of
hand waving!

bora

"Achintya" <vs********@yah oo.com> wrote in message
news:11******** **************@ f14g2000cwb.goo glegroups.com.. .

Bora Eryilmaz wrote:
I am working on designing a set of abstract classes that would be

subclassed
by the users and they have to implement the abtract (virtual)

methods.

Does anybody know of a good reference on designing APIs and class

libraries.
I am particularly interested on how to design interface classes, what

kind
of methods to provide to the users, etc.

I'd like to emphasize that what I want to learn is not how to

"create"
abstract classes and interfaces, but how to design
"good/extendable/maintainable" interfaces.

Thanks
Bora


Hi,

Good/Extendable/Maintainable interface designs comes with hands-on
experience and by looking into design of those industry standards...i
would recommend to you to look into the design of STLs which would give
a fair idea of how the interfaces are to be designed...(wou ld recomend
"C++ Programming Language" by B. Stroustrup for an explanation of the
STLs)

Also non-standards like Graph Template Library (GTL) and Boost Graph
Library (BGL) can help you learn many things about interface design.

Hope this would help you in design.

-vs_p..

Jul 23 '05 #8

This thread has been closed and replies have been disabled. Please start a new discussion.

Similar topics

2
2116
by: adb | last post by:
I came up with a replication configuration that is basically the result of all the restrictions of replication as well as the restrictions of allowable software on work PC's and I was curious if anyone would point out any flaws or possible problems with the design. I'm limited to Access 2000 professional edition (Thus I cannot use indirect sync or internet sync) and cannot install anythird party controls (i.e.
3
4146
by: zlst | last post by:
Many technological innovations rely upon User Interface Design to elevate their technical complexity to a usable product. Technology alone may not win user acceptance and subsequent marketability. The User Experience, or how the user experiences the end product, is the key to acceptance. And that is where User Interface Design enters the design process. While product engineers focus on the technology, usability specialists focus on the user...
0
1916
by: Edward Diener | last post by:
In Borland's VCL it was possible to divide a component into design time and run time DLLs. The design time DLL would only be necessary when the programmer was setting a component's properties or events in the Object Inspector, the equivalent to the VS .NET Windows form designer. The run-time DLL would only contain the code necessary at run-time. The design time DLL referenced the run-time DLL, but not vice-versa. This allowed the run-time...
7
3020
by: Shimon Sim | last post by:
I have a custom composite control I have following property
2
2380
by: Paul Cheetham | last post by:
Hi, I have moved an application from VS2003 to VS2005, and I am now unable to view most of my forms in the designer. The majority of the forms in my project are derived from class PACForm, (which itself derives from System.Windows.Forms.Form) Whenever I try to open on of these forms in the designer, I get an error, stating it is unable to load one or more of the requested types. (Full text at the bottom of this message)
1
6342
by: Nogusta123 | last post by:
Hi, I have had a lot of problems getting web pages, master pages and content pages to render in VS2005 design view the same as they would in Internet Explorer. I did a lot of looking on the internet for answers but didn't have much luck. Anyway I believe I have found the causes of the problems and thought I should share them in case any one else is feeling the pain and also to find out what other peoples opinions are, on whether these...
0
2512
by: YellowFin Announcements | last post by:
Introduction Usability and relevance have been identified as the major factors preventing mass adoption of Business Intelligence applications. What we have today are traditional BI tools that don't work nearly as well as they should, even for analysts and power users. The reason they haven't reached the masses is because most of the tools are so difficult to use and reveal so little
19
3176
by: neelsmail | last post by:
Hi, I have been working on C++ for some time now, and I think I have a flair for design (which just might be only my imagination over- stretched.. :) ). So, I tried to find a design certification, possibly that involves C++, but, if not, C++ and UML. All I could find was Java + UML design certifications (one such is detailed on http://www.objectsbydesign.com/tools/certification.html). Although UML is expected to be language independent,...
10
3680
by: vital | last post by:
Hi, I am designing the middle tier of a project. It has 6 classes and microsoft application data access block. The six classes are DBServices, Logger, ProjectServices ... etc. and all these classes talk to front-end directly. Do I need to use any design pattern in this? or what kind of design pattern is this?
4
2470
by: Ken Fine | last post by:
I've been living with a frustrating issue with VS.NET for some months now and I need to figure out what the problem is. Hopefully someone has run into the same issue and can suggest a fix. I suspect some permissions problem. I'm running VS.NET 2008 in Vista. Symptoms and observations: * ASP.NET's native ImageMap and Image controls work just fine and provide a design-time preview of images that are referenced via the ImageUrl property *...
0
9690
marktang
by: marktang | last post by:
ONU (Optical Network Unit) is one of the key components for providing high-speed Internet services. Its primary function is to act as an endpoint device located at the user's premises. However, people are often confused as to whether an ONU can Work As a Router. In this blog post, we’ll explore What is ONU, What Is Router, ONU & Router’s main usage, and What is the difference between ONU and Router. Let’s take a closer look ! Part I. Meaning of...
0
9550
by: Hystou | last post by:
Most computers default to English, but sometimes we require a different language, especially when relocating. Forgot to request a specific language before your computer shipped? No problem! You can effortlessly switch the default language on Windows 10 without reinstalling. I'll walk you through it. First, let's disable language synchronization. With a Microsoft account, language settings sync across devices. To prevent any complications,...
0
10501
Oralloy
by: Oralloy | last post by:
Hello folks, I am unable to find appropriate documentation on the type promotion of bit-fields when using the generalised comparison operator "<=>". The problem is that using the GNU compilers, it seems that the internal comparison operator "<=>" tries to promote arguments from unsigned to signed. This is as boiled down as I can make it. Here is my compilation command: g++-12 -std=c++20 -Wnarrowing bit_field.cpp Here is the code in...
1
10250
by: Hystou | last post by:
Overview: Windows 11 and 10 have less user interface control over operating system update behaviour than previous versions of Windows. In Windows 11 and 10, there is no way to turn off the Windows Update option using the Control Panel or Settings app; it automatically checks for updates and installs any it finds, whether you like it or not. For most users, this new feature is actually very convenient. If you want to control the update process,...
0
9085
agi2029
by: agi2029 | last post by:
Let's talk about the concept of autonomous AI software engineers and no-code agents. These AIs are designed to manage the entire lifecycle of a software development project—planning, coding, testing, and deployment—without human intervention. Imagine an AI that can take a project description, break it down, write the code, debug it, and then launch it, all on its own.... Now, this would greatly impact the work of software developers. The idea...
1
7574
isladogs
by: isladogs | last post by:
The next Access Europe User Group meeting will be on Wednesday 1 May 2024 starting at 18:00 UK time (6PM UTC+1) and finishing by 19:30 (7.30PM). In this session, we are pleased to welcome a new presenter, Adolph Dupré who will be discussing some powerful techniques for using class modules. He will explain when you may want to use classes instead of User Defined Types (UDT). For example, to manage the data in unbound forms. Adolph will...
0
5603
by: adsilva | last post by:
A Windows Forms form does not have the event Unload, like VB6. What one acts like?
1
4149
by: 6302768590 | last post by:
Hai team i want code for transfer the data from one system to another through IP address by using C# our system has to for every 5mins then we have to update the data what the data is updated we have to send another system
3
2944
bsmnconsultancy
by: bsmnconsultancy | last post by:
In today's digital era, a well-designed website is crucial for businesses looking to succeed. Whether you're a small business owner or a large corporation in Toronto, having a strong online presence can significantly impact your brand's success. BSMN Consultancy, a leader in Website Development in Toronto offers valuable insights into creating effective websites that not only look great but also perform exceptionally well. In this comprehensive...

By using Bytes.com and it's services, you agree to our Privacy Policy and Terms of Use.

To disable or enable advertisements and analytics tracking please visit the manage ads & tracking page.