PlugInShell.h File Reference

#include "ObjectResource.h"
#include "PlugIn.h"
#include <list>
#include <string>
#include <vector>

Go to the source code of this file.

Classes
class	PlugInShell
	A base class for plug-in shells or plug-in instances. More...
Defines
#define	FAIL_IF(cond, errorMessage, action)

---

Define Documentation

#define FAIL_IF	(	cond,
		errorMessage,
		action		)

Value:

if (cond) \
   { \
      if (pProgress != NULL) \
      { \
         pProgress->updateProgress(errorMessage, 0, ERRORS); \
      } \
      pStep.get()->finalize(Message::Failure, errorMessage); \
      action; \
   }

Report failure if a condition is not met.

There must be variables named pProgress and pStep in order to use this macro, of types Progress* and StepResource, respectively.

Parameters:

	cond	The condition to check again.
	errorMessage	The message, implicitly convertable to a std::string, to report.
	action	The action to take in case of failure. For example, "return", "continue", "break"

Definition at line 39 of file PlugInShell.h.