Ufe::AttributeEnumString Class Reference

Attribute which has a list of strings as enumerated values. More...

#include <attribute.h>

Inheritance diagram for Ufe::AttributeEnumString:

Collaboration diagram for Ufe::AttributeEnumString:

Public Types
typedef std::shared_ptr< AttributeEnumString >	Ptr
typedef std::vector< std::string >	EnumValues
Public Types inherited from Ufe::Attribute
typedef std::shared_ptr< Attribute >	Ptr
typedef std::string	Type

Public Member Functions
Type	type () const final
virtual std::string	get () const =0
virtual bool	isDefault () const =0
virtual void	set (const std::string &value)=0
	Set the attribute value. More...
virtual void	reset ()=0
	Reset the attribute value to its default setting. More...
virtual UndoableCommand::Ptr	setCmd (const std::string &value)
virtual UndoableCommand::Ptr	resetCmd ()
virtual EnumValues	getEnumValues () const =0
	Attribute (const SceneItem::Ptr &)
	Constructor. More...
	Attribute (const Attribute &)=delete
	No copy or move constructor/assignment. More...
	Attribute (Attribute &&)=delete
Public Member Functions inherited from Ufe::Attribute
	Attribute (const SceneItem::Ptr &)
	Constructor. More...
virtual	~Attribute ()
	Attribute (const Attribute &)=delete
	No copy or move constructor/assignment. More...
Attribute &	operator= (const Attribute &)=delete
	Attribute (Attribute &&)=delete
Attribute &	operator= (Attribute &&)=delete
bool	operator== (const Attribute &rhs) const
bool	operator!= (const Attribute &rhs) const
SceneItem::Ptr	sceneItem () const
virtual bool	hasValue () const =0
virtual std::string	name () const =0
virtual std::string	displayName () const
virtual std::string	documentation () const =0
virtual Type	type () const =0
virtual std::string	string () const =0
virtual Value	getMetadata (const std::string &key) const =0
virtual bool	setMetadata (const std::string &key, const Value &value)=0
virtual UndoableCommand::Ptr	setMetadataCmd (const std::string &key, const Value &value)
virtual bool	clearMetadata (const std::string &key)=0
virtual UndoableCommand::Ptr	clearMetadataCmd (const std::string &key)
virtual bool	hasMetadata (const std::string &key) const =0
	Returns true if metadata key has a non-empty value. More...

Additional Inherited Members
Static Public Attributes inherited from Ufe::Attribute
static constexpr char	kInvalid [] = "Invalid"
static constexpr char	kBool [] = "Bool"
static constexpr char	kInt [] = "Int"
static constexpr char	kFloat [] = "Float"
static constexpr char	kDouble [] = "Double"
static constexpr char	kString [] = "String"
static constexpr char	kColorFloat3 [] = "ColorFloat3"
static constexpr char	kColorFloat4 [] = "ColorFloat4"
static constexpr char	kFilename [] = "Filename"
static constexpr char	kEnumString [] = "EnumString"
static constexpr char	kInt3 [] = "Int3"
static constexpr char	kFloat2 [] = "Float2"
static constexpr char	kFloat3 [] = "Float3"
static constexpr char	kFloat4 [] = "Float4"
static constexpr char	kDouble3 [] = "Double3"
static constexpr char	kMatrix3d [] = "Matrix3d"
static constexpr char	kMatrix4d [] = "Matrix4d"
static constexpr char	kGeneric [] = "Generic"
static constexpr char	kLocked [] = "Locked"

Detailed Description

Attribute which has a list of strings as enumerated values.

Definition at line 234 of file attribute.h.

Member Typedef Documentation

EnumValues

typedef std::vector< std::string > Ufe::AttributeEnumString::EnumValues

Definition at line 239 of file attribute.h.

Ptr

typedef std::shared_ptr<AttributeEnumString> Ufe::AttributeEnumString::Ptr

Definition at line 238 of file attribute.h.

Member Function Documentation

Attribute() [1/3]

Ufe::Attribute::Attribute ( Attribute &&  )

delete

Attribute() [2/3]

Ufe::Attribute::Attribute ( const Attribute &  )

delete

No copy or move constructor/assignment.

Attribute() [3/3]

Ufe::Attribute::Attribute

(

const SceneItem::Ptr &

)

Constructor.

get()

virtual std::string Ufe::AttributeEnumString::get ( ) const

pure virtual

Returns

Attribute current value.

getEnumValues()

virtual EnumValues Ufe::AttributeEnumString::getEnumValues ( ) const

pure virtual

Returns

The list of allowed enum values for this attribute.

isDefault()

virtual bool Ufe::AttributeEnumString::isDefault ( ) const

pure virtual

Returns true if this attribute value was never set and is still at the default value.

reset()

virtual void Ufe::AttributeEnumString::reset ( )

pure virtual

Reset the attribute value to its default setting.

resetCmd()

virtual UndoableCommand::Ptr Ufe::AttributeEnumString::resetCmd ( )

virtual

Return a command for undo / redo that resets the attribute value. The returned command is not executed; it is up to the caller to call execute(). The default implementation stores undo/redo data in an AttributeInfo that allows reconstructing a stale Attribute. Executing the command will throw if reconstruction fails or leads to an incorrectly typed attribute.

set()

virtual void Ufe::AttributeEnumString::set ( const std::string &  value )

pure virtual

Set the attribute value.

setCmd()

virtual UndoableCommand::Ptr Ufe::AttributeEnumString::setCmd ( const std::string &  value )

virtual

Return a command for undo / redo that sets the attribute value. The returned command is not executed; it is up to the caller to call execute(). The default implementation stores undo/redo data in an AttributeInfo that allows reconstructing a stale Attribute. Executing the command will throw if reconstruction fails or leads to an incorrectly typed attribute.

type()

Type Ufe::AttributeEnumString::type ( ) const

finalvirtual

Returns

The attributes type.

Implements Ufe::Attribute.

---

The documentation for this class was generated from the following file:

• common/include/ufe/attribute.h