Ufe::AttributeDef Class Reference

Base class for Attribute definitions. More...

#include <attributeDef.h>

Public Types
enum	IOType { INPUT_ATTR , OUTPUT_ATTR }
typedef std::shared_ptr< const AttributeDef >	ConstPtr

Public Member Functions
virtual	~AttributeDef ()
	Destructor. More...
virtual std::string	name () const =0
virtual std::string	type () const =0
virtual std::string	defaultValue () const =0
virtual IOType	ioType () const =0
virtual Value	getMetadata (const std::string &key) const =0
virtual bool	hasMetadata (const std::string &key) const =0
	Returns true if metadata key has a non-empty value. More...

Static Public Attributes
Metadata Keys:
static constexpr char	kNativeType [] = "NativeType"

Detailed Description

Base class for Attribute definitions.

Thin wrapper around an attribute definition. Defines the standard interface to include name, type, default value, I/O type, and metadata.

Definition at line 30 of file attributeDef.h.

Member Typedef Documentation

ConstPtr

typedef std::shared_ptr<const AttributeDef> Ufe::AttributeDef::ConstPtr

Definition at line 33 of file attributeDef.h.

Member Enumeration Documentation

IOType

enum Ufe::AttributeDef::IOType

Enumerator
INPUT_ATTR
OUTPUT_ATTR

Definition at line 34 of file attributeDef.h.

Constructor & Destructor Documentation

~AttributeDef()

virtual Ufe::AttributeDef::~AttributeDef ( )

virtual

Destructor.

Member Function Documentation

defaultValue()

virtual std::string Ufe::AttributeDef::defaultValue ( ) const

pure virtual

Returns

The string representation of the attributeDef's value.

getMetadata()

virtual Value Ufe::AttributeDef::getMetadata ( const std::string &  key ) const

pure virtual

Get the value of the metadata named key.

Parameters

[in]

key

The metadata key to query.

Returns

The value of the metadata key. If the key does not exist an empty Value is returned.

hasMetadata()

virtual bool Ufe::AttributeDef::hasMetadata ( const std::string &  key ) const

pure virtual

Returns true if metadata key has a non-empty value.

ioType()

virtual IOType Ufe::AttributeDef::ioType ( ) const

pure virtual

Returns

The attribute input/output type.

name()

virtual std::string Ufe::AttributeDef::name ( ) const

pure virtual

Returns

The attributeDef's name.

type()

virtual std::string Ufe::AttributeDef::type ( ) const

pure virtual

Returns

The attributeDef's type.

Member Data Documentation

kNativeType

constexpr char Ufe::AttributeDef::kNativeType[] = "NativeType"

staticconstexpr

Metadata key: NativeType, value type = string
Used to access the AttributeDef's native Type.

Definition at line 70 of file attributeDef.h.

---

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

• common/include/ufe/attributeDef.h