Teuchos Package Browser (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Teuchos_Describable.cpp
Go to the documentation of this file.
1 // @HEADER
2 // ***********************************************************************
3 //
4 // Teuchos: Common Tools Package
5 // Copyright (2004) Sandia Corporation
6 //
7 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
8 // license for use of this work by or on behalf of the U.S. Government.
9 //
10 // Redistribution and use in source and binary forms, with or without
11 // modification, are permitted provided that the following conditions are
12 // met:
13 //
14 // 1. Redistributions of source code must retain the above copyright
15 // notice, this list of conditions and the following disclaimer.
16 //
17 // 2. Redistributions in binary form must reproduce the above copyright
18 // notice, this list of conditions and the following disclaimer in the
19 // documentation and/or other materials provided with the distribution.
20 //
21 // 3. Neither the name of the Corporation nor the names of the
22 // contributors may be used to endorse or promote products derived from
23 // this software without specific prior written permission.
24 //
25 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 //
37 // Questions? Contact Michael A. Heroux (maherou@sandia.gov)
38 //
39 // ***********************************************************************
40 // @HEADER
41 
42 #include "Teuchos_Describable.hpp"
44 
45 
46 namespace Teuchos {
47 
48 
50 
51 
52 std::string Describable::description () const
53 {
54  const std::string objectLabel = this->getObjectLabel ();
55  std::ostringstream oss;
56  if (objectLabel.length ()) {
57  oss << "\"" << objectLabel << "\": ";
58  }
59  oss << typeName (*this);
60  return oss.str ();
61 }
62 
63 void
65  const EVerbosityLevel /* verbLevel */) const
66 {
67  RCP<FancyOStream> out = rcpFromRef (out_arg);
68  OSTab tab (out);
69  *out << this->description () << std::endl;
70 }
71 
72 void
73 Describable::describe (std::ostream& out,
74  const EVerbosityLevel verbLevel) const
75 {
76  RCP<FancyOStream> fancyOut = getFancyOStream (rcpFromRef (out));
77  this->describe (*fancyOut, verbLevel);
78 }
79 
81 
82 } // namespace Teuchos
virtual ~Describable()
Destructor (marked virtual for memory safety of derived classes).
EVerbosityLevel
Verbosity level.
virtual std::string getObjectLabel() const
Get the object label (see LabeledObject).
std::string typeName(const T &t)
Template function for returning the concrete type name of a passed-in object.
Tabbing class for helping to create formated, indented output for a basic_FancyOStream object...
std::ostream subclass that performs the magic of indenting data sent to an std::ostream object among ...
virtual std::string description() const
Return a simple one-line description of this object.
static const EVerbosityLevel verbLevel_default
Default value for the verbLevel argument of describe().
Smart reference counting pointer class for automatic garbage collection.
Defines basic traits returning the name of a type in a portable and readable way. ...
Generate output as defined by the object.
virtual void describe(FancyOStream &out, const EVerbosityLevel verbLevel=verbLevel_default) const
Print the object with some verbosity level to a FancyOStream.