Cortex  10.0.0-a4
PathVectorParameter.h
1 //
3 // Copyright (c) 2008-2010, Image Engine Design Inc. All rights reserved.
4 //
5 // Redistribution and use in source and binary forms, with or without
6 // modification, are permitted provided that the following conditions are
7 // met:
8 //
9 // * Redistributions of source code must retain the above copyright
10 // notice, this list of conditions and the following disclaimer.
11 //
12 // * Redistributions in binary form must reproduce the above copyright
13 // notice, this list of conditions and the following disclaimer in the
14 // documentation and/or other materials provided with the distribution.
15 //
16 // * Neither the name of Image Engine Design nor the names of any
17 // other contributors to this software may be used to endorse or
18 // promote products derived from this software without specific prior
19 // written permission.
20 //
21 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
22 // IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
23 // THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
24 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
25 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
26 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
27 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
28 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
29 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
30 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
31 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32 //
34 
35 #ifndef IE_CORE_PATHVECTORPARAMETER_H
36 #define IE_CORE_PATHVECTORPARAMETER_H
37 
38 #include "IECore/Export.h"
39 #include "IECore/VectorTypedParameter.h"
40 
41 namespace IECore
42 {
43 
46 class IECORE_API PathVectorParameter : public StringVectorParameter
47 {
48  public :
49 
50  IE_CORE_DECLARERUNTIMETYPED( PathVectorParameter, StringVectorParameter )
51 
52  typedef enum
53  {
54  DontCare,
55  MustExist,
56  MustNotExist,
57  } CheckType;
58 
59  PathVectorParameter( const std::string &name, const std::string &description,
60  const std::vector<std::string> &defaultValue, bool allowEmptyList = true, CheckType check = PathVectorParameter::DontCare,
61  const StringVectorParameter::PresetsContainer &presets = StringVectorParameter::PresetsContainer(), bool presetsOnly = false, ConstCompoundObjectPtr userData=nullptr );
62 
63  PathVectorParameter( const std::string &name, const std::string &description,
64  ObjectTypePtr defaultValue, bool allowEmptyList = true, CheckType check = PathVectorParameter::DontCare,
65  const StringVectorParameter::ObjectPresetsContainer &presets = StringVectorParameter::ObjectPresetsContainer(), bool presetsOnly = false, ConstCompoundObjectPtr userData=nullptr );
66 
67  bool allowEmptyList() const;
68  bool mustExist() const;
69  bool mustNotExist() const;
70 
77  bool valueValid( const Object *value, std::string *reason = nullptr ) const override;
78 
79  private :
80 
81  bool m_allowEmptyList;
82  CheckType m_check;
83 
84 };
85 
86 IE_CORE_DECLAREPTR( PathVectorParameter )
87 
88 } // namespace IECore
89 
90 #endif // IE_CORE_PATHVECTORPARAMETER_H
Definition: PathVectorParameter.h:46
Definition: TypedParameter.h:48
Definition: Object.h:104
This namespace contains all components of the core library.
Definition: AddSmoothSkinningInfluencesOp.h:43