Teuchos - Trilinos Tools Package  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Teuchos_ValidatorFactory.hpp
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_VALIDATORFACTORY_HPP_
43 #define TEUCHOS_VALIDATORFACTORY_HPP_
44 
45 
46 #include "Teuchos_StandardParameterEntryValidators.hpp"
47 
48 
49 namespace Teuchos {
50 
51 
55 public:
56 
57  enum ValidatorType{Int, Short, Double, Float, FileName,
58  IntArray, ShortArray, DoubleArray, FloatArray, FileNameArray};
59 
64  static RCP<ParameterEntryValidator> createValidator(ValidatorType valiType);
65 
68 
71 
74 
77 
80 
83 
86 
89 
92 
95 
96 };
97 
98 
99 } // namespace Teuchos
100 
101 
102 #endif /* TEUCHOS_VALIDATORFACTORY_HPP_ */
static RCP< ArrayNumberValidator< short > > getArrayShortValidator()
Creates and returns an Array Number Validator of type short.
static RCP< EnhancedNumberValidator< double > > getDoubleValidator()
Creates and returns a Enhanced Number Validator of type double.
static RCP< ArrayFileNameValidator > getArrayFileNameValidator()
Creates and returns an Array File Name Validator.
static RCP< EnhancedNumberValidator< int > > getIntValidator()
Creates and returns a Enhanced Number Validator of type int.
static RCP< ArrayNumberValidator< double > > getArrayDoubleValidator()
Creates and returns an Array Number Validator of type double.
static RCP< EnhancedNumberValidator< float > > getFloatValidator()
Creates and returns a Enhanced Number Validator of type float.
static RCP< ParameterEntryValidator > createValidator(ValidatorType valiType)
Creates a validator of the given type.
static RCP< ArrayNumberValidator< float > > getArrayFloatValidator()
Creates and returns an Array Number Validator of type float.
Factory for ParameterEntryValidator objects.
static RCP< ArrayNumberValidator< int > > getArrayIntValidator()
Creates and returns an Array Number Validator of type int.
static RCP< FileNameValidator > getFileNameValidator()
Creates and returns FileNameValidator.
Smart reference counting pointer class for automatic garbage collection.
static RCP< EnhancedNumberValidator< short > > getShortValidator()
Creates and returns a Enhanced Number Validator of type short.