TestToolBox::TestStream Class Reference

This class allows directing of textual output to multiple devices. More...

#include <TestStream.h>

List of all members.

Public Member Functions

 TestStream (std::fstream *in_pOutFile=0, std::fstream *in_pRptFile=0)
void SetMode (unsigned char in_newMode)
void ResetMode (void)
unsigned char GetMode (void)
 Get current output mode.
void SetStreamActivation (unsigned char in_streamsToActivate)
unsigned char GetStreamActivation (void)
 Get current sream activation status.
int width (int in_newWidth)
 Returns field width in characters. See ios::width() (C++ standard).
int width (void) const
long setf (long in_flags)
 Set TStream format flags. See ios::setf().
long setf (long in_flags, long in_mask)
long unsetf (long in_flags)
TestStreamTestStream::operator<< (std::string in_item)
TestStreamTestStream::operator<< (unsigned char *in_item)
TestStreamTestStream::operator<< (const char *in_item)
TestStreamTestStream::operator<< (char in_item)
TestStreamTestStream::operator<< (unsigned char in_item)
TestStreamTestStream::operator<< (short in_item)
TestStreamTestStream::operator<< (unsigned short in_item)
TestStreamTestStream::operator<< (int in_item)
TestStreamTestStream::operator<< (unsigned int in_item)
TestStreamTestStream::operator<< (long in_item)
TestStreamTestStream::operator<< (unsigned long in_item)
TestStreamTestStream::operator<< (float in_item)
TestStreamTestStream::operator<< (double in_item)
TestStreamTestStream::operator<< (long double in_item)
TestStreamoperator<< (std::ostream &(*f)(std::ostream &))
TestStreamoperator<< (std::ios &(*f)(std::ios &))
TestStreamwrite (const signed char *in_pCh, int in_count)
TestStreamwrite (const unsigned char *in_pCh, int in_count)
TestStreamwrite (const char *in_pCh, int in_count)

Detailed Description

This class allows directing of textual output to multiple devices.

Definition of the class TestStream which performs handling of test output. With this class it is possible to direct test output to standard out, to protocol and report file. With calling member function setMode any of the output devices can be switched on or off.

See also:
TestStream.h (File documentation)
Using TestStream (Usage documentation)

Constructor & Destructor Documentation

TestToolBox::TestStream::TestStream ( std::fstream *  in_pOutFile = 0,
std::fstream *  in_pRptFile = 0 
)

Constructs an object of class TestStream. The given parameters point to the streams to be used for output. A null pointer means that this device is not available.


Member Function Documentation

void TestToolBox::TestStream::SetMode ( unsigned char  in_newMode  ) 

Selects streams for output. Possible values for mode are M_NULL, M_STDOUT, M_OUTFILE, M_RPTFILE. To select more than one device use | operator.

void TestToolBox::TestStream::ResetMode ( void   ) 

Reset mode to default (i.e. all available output devices are selected).

void TestToolBox::TestStream::SetStreamActivation ( unsigned char  in_streamsToActivate  ) 

Completely activate the streams via bit mask Streams not contained within bitmask will be switched off completely

TestStream& TestToolBox::TestStream::TestStream::operator<< ( std::string  in_item  ) 

Insert arguments in TestStream. The output operator << is defined and overloaded similar to ostream.

TestStream& TestToolBox::TestStream::operator<< ( std::ostream &(*)(std::ostream &)  f  ) 

The overloaded operator << accepts ostream (ios) manipulators.

TestStream& TestToolBox::TestStream::write ( const signed char *  in_pCh,
int  in_count 
)

Write the contents of a buffer like ostream::write() The only difference is that the output is directed to several devices according to mode value.


The documentation for this class was generated from the following file:
Generated on Fri May 27 22:57:53 2011 for TestToolBox by  doxygen 1.6.3