Cortex
10.0.0-a4
|
#include <DirNameParameter.h>
Public Member Functions | |
IE_CORE_DECLARERUNTIMETYPED (DirNameParameter, PathParameter) | |
DirNameParameter (const std::string &name, const std::string &description, const std::string &defaultValue="", bool allowEmptyString=true, PathParameter::CheckType check=PathParameter::DontCare, const StringParameter::PresetsContainer &presets=StringParameter::PresetsContainer(), bool presetsOnly=false, ConstCompoundObjectPtr userData=nullptr) | |
bool | valueValid (const Object *value, std::string *reason=nullptr) const override |
![]() | |
PathParameter (const std::string &name, const std::string &description, const std::string &defaultValue="", bool allowEmptyString=true, CheckType check=PathParameter::DontCare, const StringParameter::PresetsContainer &presets=StringParameter::PresetsContainer(), bool presetsOnly=false, ConstCompoundObjectPtr userData=nullptr) | |
bool | allowEmptyString () const |
bool | mustExist () const |
bool | mustNotExist () const |
bool | valueValid (const Object *value, std::string *reason=nullptr) const override |
![]() | |
IE_CORE_DECLAREPTR (ObjectType) | |
TypedParameter (const std::string &name, const std::string &description, const T &defaultValue=T(), const PresetsContainer &presets=PresetsContainer(), bool presetsOnly=false, ConstCompoundObjectPtr userData=nullptr) | |
Constructs a new ObjectType object to hold the default value. | |
TypedParameter (const std::string &name, const std::string &description, ObjectTypePtr defaultValue, const ObjectPresetsContainer &presets=ObjectPresetsContainer(), bool presetsOnly=false, ConstCompoundObjectPtr userData=nullptr) | |
Takes a copy of defaultValue for use as the default value. | |
IECORE_RUNTIMETYPED_DECLARETEMPLATE (TypedParameter< T >, Parameter) | |
bool | valueValid (const Object *value, std::string *reason=nullptr) const override |
Implemented to return true only if value is of type TypedData<T>. | |
const ValueType & | typedDefaultValue () const |
ValueType & | getTypedValue () |
const ValueType & | getTypedValue () const |
void | setTypedValue (const T &value) |
![]() | |
IE_CORE_DECLARERUNTIMETYPED (Parameter, RunTimeTyped) | |
Parameter (const std::string &name, const std::string &description, ObjectPtr defaultValue, const PresetsContainer &presets=PresetsContainer(), bool presetsOnly=false, ConstCompoundObjectPtr userData=nullptr) | |
const std::string & | name () const |
Returns the name of this parameter. | |
const InternedString & | internedName () const |
const std::string & | description () const |
Returns the description for this parameter. | |
virtual const Object * | defaultValue () const |
Returns the default value for this parameter. | |
virtual const PresetsContainer & | getPresets () const |
Returns the presets for this parameter. | |
virtual void | setPresets (const PresetsContainer &presets) |
Overrides the presets for this parameter. | |
virtual bool | presetsOnly () const |
CompoundObject * | userData () |
Returns the userdata. This can be modified freely. | |
const CompoundObject * | userData () const |
Read only version of the above. | |
bool | valueValid (std::string *reason=nullptr) const |
Calls valueValid( getValue(), reason ) | |
void | validate () const |
void | validate (const Object *value) const |
virtual void | setValue (ObjectPtr value) |
void | setValidatedValue (ObjectPtr value) |
void | setValue (const std::string &presetName) |
virtual Object * | getValue () |
virtual const Object * | getValue () const |
Object * | getValidatedValue () |
const Object * | getValidatedValue () const |
template<typename T > | |
T * | getTypedValue () |
Convenience function returning runTimeCast<T>( getValue() ). | |
template<typename T > | |
const T * | getTypedValue () const |
Convenience function returning runTimeCast<T>( getValue() ). | |
template<typename T > | |
T * | getTypedValidatedValue () |
template<typename T > | |
const T * | getTypedValidatedValue () const |
std::string | getCurrentPresetName () const |
![]() | |
IE_CORE_DECLAREMEMBERPTR (RunTimeTyped) | |
virtual TypeId | typeId () const |
virtual const char * | typeName () const |
virtual bool | isInstanceOf (TypeId typeId) const |
virtual bool | isInstanceOf (const char *typeName) const |
![]() | |
IE_CORE_DECLAREMEMBERPTR (RefCounted) | |
void | addRef () const |
Add a reference to the current object. | |
void | removeRef () const |
Remove a reference from the current object. | |
RefCount | refCount () const |
Returns the current reference count. | |
Additional Inherited Members | |
![]() | |
enum | CheckType { DontCare, MustExist, MustNotExist } |
![]() | |
typedef T | ValueType |
typedef TypedParameterTraits< T >::ObjectType | ObjectType |
typedef std::pair< std::string, T > | Preset |
typedef std::pair< std::string, ObjectTypePtr > | ObjectPreset |
typedef std::vector< Preset > | PresetsContainer |
typedef std::vector< ObjectPreset > | ObjectPresetsContainer |
![]() | |
typedef std::pair< std::string, ObjectPtr > | Preset |
typedef std::vector< Preset > | PresetsContainer |
A type to store a bunch of preset values for the Parameter. | |
![]() | |
typedef RefCounted | BaseClass |
A typedef for the class this class derives from. All RunTimeTyped classes define this typedef. | |
![]() | |
typedef size_t | RefCount |
![]() | |
static TypeId | staticTypeId () |
Returns the TypeId for this class, without needing an instance. | |
static const char * | staticTypeName () |
Returns the type name for this class, without needing an instance. | |
static TypeId | baseTypeId () |
static const char * | baseTypeName () |
static bool | inheritsFrom (TypeId typeId) |
Returns true if this class inherits from the specified type. | |
static bool | inheritsFrom (const char *typeName) |
Returns true if this class inherits from the specified type. | |
static bool | inheritsFrom (TypeId type, TypeId baseType) |
Returns true if type inherits from baseType. | |
static bool | inheritsFrom (const char *typeName, const char *baseTypeName) |
Returns true if typeName inherits from baseTypeName. | |
static TypeId | baseTypeId (TypeId typeId) |
Returns the base type of the given type, or InvalidTypeId if no such base exists. | |
static const std::vector< TypeId > & | baseTypeIds (TypeId typeId) |
static const std::set< TypeId > & | derivedTypeIds (TypeId typeId) |
static TypeId | typeIdFromTypeName (const char *typeName) |
static const char * | typeNameFromTypeId (TypeId typeId) |
static void | registerType (TypeId derivedTypeId, const char *derivedTypeName, TypeId baseTypeId) |
Allows external modules to register their own type ids. | |
![]() | |
typedef std::map< TypeId, TypeId > | BaseTypeRegistryMap |
typedef std::map< TypeId, std::vector< TypeId > > | BaseTypesRegistryMap |
typedef std::map< TypeId, std::set< TypeId > > | DerivedTypesRegistryMap |
typedef tbb::spin_rw_mutex | Mutex |
typedef std::map< TypeId, std::string > | TypeIdsToTypeNamesMap |
typedef std::map< std::string, TypeId > | TypeNamesToTypeIdsMap |
![]() | |
static BaseTypeRegistryMap & | baseTypeRegistry () |
static DerivedTypesRegistryMap & | derivedTypesRegistry () |
static BaseTypesRegistryMap & | completeBaseTypesRegistry () |
static DerivedTypesRegistryMap & | completeDerivedTypesRegistry () |
static void | derivedTypeIdsWalk (TypeId typeId, std::set< TypeId > &) |
static TypeIdsToTypeNamesMap & | typeIdsToTypeNames () |
static TypeNamesToTypeIdsMap & | typeNamesToTypeIds () |
![]() | |
static Mutex | g_baseTypeIdsMutex |
static Mutex | g_derivedTypeIdsMutex |
This class implements a StringParameter object with validation of the value based on it representing a directory name.
|
overridevirtual |
Returns false if :
Reimplemented from IECore::Parameter.