TestToolBox::IEventReceiver Struct Reference

This interface is used to convert a textual TestEvent into a message suitable for the specific test environment (e.g. within Boost test a Boost macro will be called). More...

#include <IEventReceiver.h>

Inheritance diagram for TestToolBox::IEventReceiver:

[legend]

List of all members.

Public Member Functions
	IEventReceiver ()
	Constructor.
virtual void	EventMsg (EventContext in_context, const char *in_eventDescription)=0
	Signal actual event as occured during test execution.
Convenience functions
Convenience functions to allow printf formating of output, automatic supply of context param and usage of std::string
virtual void	Event (EventContext in_context, const char *in_eventDescription,...)
	Supply context and char*.
virtual void	Event (const char *in_eventDescription,...)
	Supply char*.
virtual void	Event (EventContext in_context, std::string const in_eventDescription)
	Supply context and std::string.
virtual void	Event (std::string const in_eventDescription)
	Supply std::string.
void	SetEventPrefix (std::string const &in_eventPrefix)
	Optionally add a prefix to the test events.
void	SetSplitAtNewLine (bool in_split)
	Optionally a given event string can be split into several events using newline as separator.

---

Detailed Description

This interface is used to convert a textual TestEvent into a message suitable for the specific test environment (e.g. within Boost test a Boost macro will be called).

---

Member Function Documentation

void TestToolBox::IEventReceiver::SetEventPrefix

(

std::string const &

in_eventPrefix

)

[inline]

Optionally add a prefix to the test events.

A prefix can be added when writing the test script to enable simply copying from test output to test script (e.g. "TTB_EXP" leads to event entry "TTB_EXP(MyEventString);" instead of "MyEventString")

---

The documentation for this struct was generated from the following file:

• IEventReceiver.h