Methods common to all classes, Print – Teledyne LeCroy Automation API for IBTrainer Software Ver.2.0 User Manual
Page 36
Classes of the C++ Interface
Methods Common to All Classes
2-14
CATC IBTrainer InfiniBand Exerciser API Reference
Methods Common to All Classes
Every class (or its base class) has the method Print() and supports the
C++ stream operator for the user to be able to print the content of the
class. The content can be either debug information or status
information.
ostream & Print (ostream & o) const;
Prints the content of the class as text representation of the specified
ostream
(in a form readable by humans). While this method is common
to all classes, it is additionally mentioned in the classes
IGCGeneratorInfo
, IGCGeneratorStatus and Error. In these classes it is
used to deliver the content of the internal variables of the particular
class (for instance for the purpose of debugging while using TCL).
Returns a reference to an ostream object with the content of the class.
o
The stream to print into. This provides you with the possibility to print to a file or
to stdout.
None
Call
Description
Return Value
Input Parameters
See also