Writing text to the console

OutputTextStream returns a pointer to a TTieredTextBuffer object that contains the text. Objects of the class TTieredTextBuffer act like C++ ostream objects. They support << operators for all built-in types and for some basic CommonPoint application system types.

TTieredTextBuffer has some additional functionality beyond that of ostream to support retrieving textual information for later analysis:

• Information is recorded. All text sent to a text buffer is stored in the test object. When the object is persistently stored, all text sent to it is stored with it.
• Information is marked with a level of importance. The text objects in a text buffer are TTieredText objects, so you can show a specified amount of detail when you later retrieve the text. You can also filter out information beyond a specific level of detail.
• Text can be redirected to any TStream for output echoing.

A special tier, kEphemeral, indicates text that appears on the console once, but is not saved with the object. This tier is useful for status messages that do not need to be seen later or messages that may take up excessive memory.

This is a list of available tiers in order of least detailed to most detailed:

• kTop: Most general information
• kHeadline: One-line information
• kGeneral: General interest
• kEphemeral: Console only, not saved
• kNormal: Default
• kDetail: Detail not usually needed
• kDebug: Only needed during debugging
• kBottom: Lowest tier, most detailed

  void TSampleObjectOutputTest::Test()
  {
      bool success = true;    // Always set 'success' to false if any test fails.
      // Always check to see that 'success' is true before beginning subsequent
      // tests.
  
      OutputTextStream() << "\nThis is written with default setting.\n";
      OutputTextStream() << PushTier(TTieredText::kTop);
      OutputTextStream() << "This is at tier kTop.\n";
      OutputTextStream() << PushTier(TTieredText::kHeadline);
      OutputTextStream() << "This is at tier kHeadline.\n";
      OutputTextStream() << PushTier(TTieredText::kGeneral);
      OutputTextStream() << "This is at tier kGeneral.\n";
      OutputTextStream() << PushTier(TTieredText::kEphemeral);
      OutputTextStream() << "This is at tier kEphemeral and does not go to the test log.\n";
      OutputTextStream() << PushTier(TTieredText::kNormal);
      OutputTextStream() << "This is at tier kNormal.\n";
      OutputTextStream() << PushTier(TTieredText::kDetail);
      OutputTextStream() << "Tier kDetail and does not print at default settings.\n";
      OutputTextStream() << PushTier(TTieredText::kDebug);
      OutputTextStream() << "Tier kDebug and does not print at default settings.\n";
      OutputTextStream() << PushTier(TTieredText::kBottom);
      OutputTextStream() << "Tier kBottom and does not print at default settings.\n";
      OutputTextStream() << PopTier() ; // return back to kDebug
      OutputTextStream() << PopTier() ; // return back to kDetail
      OutputTextStream() << PopTier() ; // return back to kNormal
      OutputTextStream() << PopTier() ; // return back to kEphemeral
      OutputTextStream() << PopTier() ; // return back to kGeneral
      OutputTextStream() << PopTier() ; // return back to kHeadline
      OutputTextStream() << PopTier() ; // return back to kTop
      OutputTextStream() << "Back to normal.\n";
          
      SetSuccess(success); 
  }