Teuchos - Trilinos Tools Package  Version of the Day
Teuchos_TableEntry.hpp
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 #ifndef TEUCHOS_TABLEENTRY_H
43 #define TEUCHOS_TABLEENTRY_H
44 
54 #include "Teuchos_ConfigDefs.hpp"
55 #include "Teuchos_RCP.hpp"
56 #include "Teuchos_Array.hpp"
57 #include <iostream>
58 
59 namespace Teuchos
60 {
68  class TableEntry
69  {
70  public:
73 
75  virtual ~TableEntry() {}
76 
78  virtual std::string toString() const = 0 ;
79 
87  virtual std::string toChoppedString(int maxWidth) const ;
88 
89  protected:
90  };
91 
92 
96  class DoubleEntry : public TableEntry
97  {
98  public:
101  DoubleEntry(const double& value, int precision);
102 
104  virtual std::string toString() const ;
105 
106  private:
107  double data_;
108  int precision_;
109  };
110 
111 
115  class IntEntry : public TableEntry
116  {
117  public:
119  IntEntry(int value);
120 
122  virtual std::string toString() const ;
123 
124  private:
125  int data_;
126  };
127 
128 
132  class StringEntry : public TableEntry
133  {
134  public:
136  StringEntry(std::string value);
137 
139  virtual std::string toString() const ;
140 
141  private:
142  std::string data_;
143  };
144 
155  {
156  public:
159  const RCP<TableEntry>& second,
160  bool spaceBeforeParens=true);
161 
163  virtual std::string toString() const ;
164 
165  private:
166  RCP<TableEntry> first_;
167  RCP<TableEntry> second_;
168  bool spaceBeforeParens_;
169  };
170 
171 
172 
173 
174 
175 }
176 #endif
virtual ~TableEntry()
virtual dtor
virtual std::string toString() const =0
Return a std::string representation of this entry.
virtual std::string toString() const
Write the specified entry to a std::string.
An entry, perhaps compound, to be written into a table.
Teuchos header file which uses auto-configuration information to include necessary C++ headers...
DoubleEntry(const double &value, int precision)
Construct with a value and a precision.
virtual std::string toString() const
Write the specified entry to a std::string.
A table entry that is a simple double-precision number.
A table entry that is a simple std::string.
An entry containing two subentries, with the second to be written in parentheses after the first...
virtual std::string toChoppedString(int maxWidth) const
Return a std::string representation of this entry, truncated if necessary to fit within the given col...
Templated array class derived from the STL std::vector.
The Teuchos namespace contains all of the classes, structs and enums used by Teuchos, as well as a number of utility routines.
A table entry that is a simple integer.
Smart reference counting pointer class for automatic garbage collection.
virtual std::string toString() const
Write the specified entry to a std::string.
Reference-counted pointer class and non-member templated function implementations.
virtual std::string toString() const
Write the specified entry to a std::string.
IntEntry(int value)
Construct with a value.
StringEntry(std::string value)
Construct with a value.