5.2. Optional Arguments

5.2. Optional Arguments
	Chapter 5. Functions

[ fromfile: functions.xml id: defaultargs ]

Function parameters can have default values, making them optional.
The default value for an optional argument can be a constant expression or an expression that does not involve local variables.

Parameters with default arguments must be the right-most (trailing) parameters in the parameter list.
Trailing arguments with default values can be left out of the function call.
The corresponding parameters will then be initialized with the default values.

Because an optional argument specifier applies to a function's interface, it belongs with the declaration, not the definition of the function if the declaration is kept in a separate header file.

[ . . . . ]
class Date {
public:
    Date(int d = 0, int m = 0, int y = 0);
    void display(bool eoln = true) const;
private:
    int m_Day, m_Month, m_Year;
};
[ . . . . ]

If 0 turns out to be the value of any of the supplied arguments, it will be replaced with a sensible value derived from the current date.

Example 5.4. src/functions/date.cpp

#include <QDate>
#include "date.h"
#include <iostream>



Date::Date(int d , int m , int y ) 
: m_Day(d), m_Month(m), m_Year(y) {
    
    static QDate currentDate = QDate::currentDate(); 
    
    if (m_Day == 0) m_Day = currentDate.day(); 
    if (m_Month == 0) m_Month = currentDate.month();
    if (m_Year == 0) m_Year = currentDate.year();
}
        

void Date::display(bool eoln) const {
    using namespace std;
    cout << m_Year << "/" << m_Month << '/' << m_Day;
    if (eoln)
        cout << endl;
}

We use Qt's QDate class only to get the current date.

Example 5.5. src/functions/date-test.cpp

#include "date.h"
#include <iostream>

int main() {
    using namespace std;
    Date d1;
    Date d2(15);
    Date d3(23, 8);
    Date d4(19, 11, 2003);

    d1.display(false);
    cout << '\t';
    d2.display();
    d3.display(false);
    cout << '\t';
    d4.display();
    return 0;
}

Example 5.5 demonstrates that by defining default values you are, in effect, overloading the function.
The different versions of the function execute the same code, but with different values passed in for the later parameters.

So if you ran this program on May 14, 2011, it should show you the following output:

src/functions> qmake
src/functions> make
[ compiler linker messages ] 
src/functions> ./functions
2011/5/14       2011/5/15
2011/8/23       2003/11/19
src/functions>


5.1.1. Exercises: Overloading Functions		5.3. Operator Overloading