jafar::helloworld::HelloWorld Class Reference

HelloWorld class. More...

---

Detailed Description

HelloWorld class.

This class is a simple example.

Definition at line 22 of file helloWorld.hpp.

#include <helloWorld.hpp>

List of all members.

Public Member Functions
	HelloWorld ()
	Default constructor.
	HelloWorld (const std::string &hello_)
	Constructor.
	~HelloWorld ()
	Destructor.
const std::string &	getHello () const
	Returns hello.
void	setHello (const std::string &hello_)
	Set the value of the string to hello_.
void	clearHello ()
	Set hello to the empty string.
void	printHello ()
	Print the string on the standard output.
Static Private Member Functions
static bool	checkHello (const std::string &hello_)
Private Attributes
std::string	hello
	contains the string to be displayed
Friends
std::ostream &	operator<< (std::ostream &s, const HelloWorld &h_)

---

Constructor & Destructor Documentation

HelloWorld::HelloWorld

(

const std::string &

hello_

)

Constructor.

Parameters:

hello_

the initial string

Precondition:

hello_ is not empty

Definition at line 14 of file helloWorld.cpp.

References JFR_VDEBUG, and setHello().

---

Member Function Documentation

void HelloWorld::printHello

(

)

Print the string on the standard output.

Exceptions:

HelloworldException

try to print an empty string

Definition at line 45 of file helloWorld.cpp.

References jafar::helloworld::HelloworldException::EMPTY_HELLO, hello, and JFR_ERROR.

void HelloWorld::setHello

(

const std::string &

hello_

)

Set the value of the string to hello_.

Precondition:

hello_ not empty

Exceptions:

jafar::kernel::JafarException	precondition
jafar::helloworld::HelloworldFormatException	hello_ must start with "Hello"

Definition at line 29 of file helloWorld.cpp.

References hello, JFR_DEBUG, and JFR_PRECOND.

Referenced by HelloWorld().

---

The documentation for this class was generated from the following files:

• modules/helloworld/include/helloworld/helloWorld.hpp
• modules/helloworld/src/helloWorld.cpp