vlPrint.h File Reference

Functions in vlPrint.h provide an error and print facility for vrlink. More...

Go to the source code of this file.

Classes
class	DtPrinter
	DtPrinter is an abstract base class which provides an interface for output. More...
class	DtFilePrinter
	DtFilePrinter is a subclass of DtPrinter which opens a file and dumps all information received from DtOutputStream to the file. More...
class	DtStdoutPrinter
	DtStdoutPrinter is a subclass of DtPrinter which copies all input received from DtOutputStream to the systems standard output device. More...
class	DtStderrPrinter
	class DtStderrPrinter is a subclass of DtPrinter which copies all input received from DtOutputStream to the systems standard error device. More...
class	DtOutputStreamBuffer
	DtOutputStreamBuffer is the internal buffer for DtOutputStream. More...
class	DtOutputStream
	DtOutputStream is used for all toolkit output. More...

Typedefs
typedef void(*	DtAbortFunc )()

Enumerations
enum	DtNotifyLevelType {   DtNlFatal = 0, DtNlWarn = 1, DtNlInfo = 2, DtNlVerbose = 3,   DtNlDebug = 4 }
	Default is DtNlInfo. More...

Functions
void	DtSetVrLinkPrinter (DtPrinter *newPrinter)
	DtSetVrLinkPrinter is provided for backwards compatibility.
void	DtPrintEnvironmentVariables (DtOutputStream &os=DtInfo)
	Print the environment variables If notifyLevel isn't specified, function will use DtNlInfo as appropriate.
void	DtAbort ()
	DtAbort() exits the program.
void	DtSetAbortFunc (DtAbortFunc func)
DtAbortFunc	DtGetAbortFunc ()
void	DtFatalError (const char *str,...)
	These functions print messages using DtOutputStreams depending on the notify level.
void	DtFatalPerror (const char *str,...)
	These functions print messages using DtOutputStreams depending on the notify level.
void	DtWarnPerror (const char *str,...)
	These functions print messages using DtOutputStreams depending on the notify level.
void	DtFatalNetPerror (const char *str,...)
	These functions print messages using DtOutputStreams depending on the notify level.
void	DtWarnNetPerror (const char *str,...)
	These functions print messages using DtOutputStreams depending on the notify level.

Variables
int	DtNotifyLevel
	DtNotifyLevel is used to control the level of diagnostics output by VR-Link.
DtStdoutPrinter	DtStandardOutConsole
	This class is a basic DtPrinter instance which can be used with DtOutputStream instances.
DtStderrPrinter	DtStandardErrorConsole
	This class is a basic DtPrinter instance which can be used with DtOutputStream instances.
DtOutputStream	DtFatal
	These DtOutputStream instances are used for all print messaging in VR-Link.
DtOutputStream	DtWarn
	These DtOutputStream instances are used for all print messaging in VR-Link.
DtOutputStream	DtInfo
	DtInfo is an global instance of a DtOutputStream.
DtOutputStream	DtVerbose
	These DtOutputStream instances are used for all print messaging in VR-Link.
DtOutputStream	DtDebug
	These DtOutputStream instances are used for all print messaging in VR-Link.

Detailed Description

Functions in vlPrint.h provide an error and print facility for vrlink.

Enumeration Type Documentation

enum DtNotifyLevelType

Default is DtNlInfo.

Notification Levels

Enumerator:

DtNlFatal
DtNlWarn
DtNlInfo
DtNlVerbose
DtNlDebug

Function Documentation

void DtPrintEnvironmentVariables

(

DtOutputStream &

os = DtInfo

)

Print the environment variables If notifyLevel isn't specified, function will use DtNlInfo as appropriate.

Variable Documentation

int DtNotifyLevel

DtNotifyLevel is used to control the level of diagnostics output by VR-Link.

It should be set to one of the levels defined in the enumeration DtNotifyLevelType. Each level includes messages for all lower levels as well. The default level is DtNlInfo, i.e. all messages except debug statements.

Referenced by DtCmdLine::StdOutput::failure(), DtCmdLine::CmdLine::parse(), DtCmdLine::StdOutput::usage(), DtCmdLine::StdOutput::version(), DtCmdLine::HelpVisitor::visit(), and DtCmdLine::VersionVisitor::visit().