prtx::Attributable Class Reference

#include <Attributable.h>

Inheritance diagram for prtx::Attributable:

Public Types
using	PrimitiveType = uint8_t

Public Member Functions
virtual void *	getBlindData (const std::wstring &key) const =0
virtual Bool	getBool (const std::wstring &key) const =0
virtual const BoolVector &	getBoolArray (const std::wstring &key) const =0
virtual double	getFloat (const std::wstring &key) const =0
virtual const DoubleVector &	getFloatArray (const std::wstring &key) const =0
virtual int32_t	getInt (const std::wstring &key) const =0
virtual const Int32Vector &	getIntArray (const std::wstring &key) const =0
virtual const WStringVector &	getKeys () const =0
virtual const std::wstring &	getString (const std::wstring &key) const =0
virtual const WStringVector &	getStringArray (const std::wstring &key) const =0
virtual PrimitiveType	getType (const std::wstring &key) const =0
virtual bool	hasKey (const std::wstring &key) const =0

Static Public Attributes
static constexpr PrimitiveType	PT_BLIND_DATA = prt::Attributable::PT_BLIND_DATA
static constexpr PrimitiveType	PT_BLIND_DATA_ARRAY = prt::Attributable::PT_BLIND_DATA_ARRAY
static constexpr PrimitiveType	PT_BOOL = prt::Attributable::PT_BOOL
static constexpr PrimitiveType	PT_BOOL_ARRAY = prt::Attributable::PT_BOOL_ARRAY
static constexpr PrimitiveType	PT_COUNT = prt::Attributable::PT_COUNT
static constexpr PrimitiveType	PT_FLOAT = prt::Attributable::PT_FLOAT
static constexpr PrimitiveType	PT_FLOAT_ARRAY = prt::Attributable::PT_FLOAT_ARRAY
static constexpr PrimitiveType	PT_INT = prt::Attributable::PT_INT
static constexpr PrimitiveType	PT_INT_ARRAY = prt::Attributable::PT_INT_ARRAY
static constexpr PrimitiveType	PT_STRING = prt::Attributable::PT_STRING
static constexpr PrimitiveType	PT_STRING_ARRAY = prt::Attributable::PT_STRING_ARRAY
static constexpr PrimitiveType	PT_UNDEFINED = prt::Attributable::PT_UNDEFINED

Detailed Description

Interface to provide read-only access to attributes of the basic types. Exceptions are thrown on errors.

Each key is unique over all types.

Member Typedef Documentation

PrimitiveType

using prtx::Attributable::PrimitiveType = uint8_t

Primitive Types (inherited from prt::Attributable)

Member Function Documentation

getBlindData()

virtual void* prtx::Attributable::getBlindData ( const std::wstring &  key ) const

pure virtual

Gets a blind data value.

Parameters

key	Key to look for.

Returns

blind data value associated with a key or throws an exception if key not found.

Implemented in prtx::Material.

getBool()

virtual Bool prtx::Attributable::getBool ( const std::wstring &  key ) const

pure virtual

Gets a boolean value.

Parameters

key	Key to look for.

Returns

the value associated with a key or throws an exception if key not found.

Implemented in prtx::Material.

getBoolArray()

virtual const BoolVector& prtx::Attributable::getBoolArray ( const std::wstring &  key ) const

pure virtual

Gets an array of booleans. The returned reference stays valid until destruction of the Attributable.

Parameters

key	Key to look for.

Returns

reference to a vector associated with a key or throws an exception if key not found.

Implemented in prtx::Material.

getFloat()

virtual double prtx::Attributable::getFloat ( const std::wstring &  key ) const

pure virtual

Gets a float value.

Parameters

key	Key to look for.

Returns

the value associated with a key or throws an exception if key not found.

Implemented in prtx::Material.

getFloatArray()

virtual const DoubleVector& prtx::Attributable::getFloatArray ( const std::wstring &  key ) const

pure virtual

Gets an array of floats. The returned reference stays valid until destruction of the Attributable.

Parameters

key	Key to look for.

Returns

reference to a vector associated with a key or throws an exception if key not found.

Implemented in prtx::Material.

getInt()

virtual int32_t prtx::Attributable::getInt ( const std::wstring &  key ) const

pure virtual

Gets an integer value.

Parameters

key	Key to look for.

Returns

the value associated with a key or throws an exception if key not found.

Implemented in prtx::Material.

getIntArray()

virtual const Int32Vector& prtx::Attributable::getIntArray ( const std::wstring &  key ) const

pure virtual

Gets an array of integers. The returned reference stays valid until destruction of the Attributable.

Parameters

key	Key to look for.

Returns

reference to a vector associated with a key or throws an exception if key not found.

Implemented in prtx::Material.

getKeys()

virtual const WStringVector& prtx::Attributable::getKeys ( ) const

pure virtual

Get all used keys. The returned reference stays valid until destruction of the Attributable.

Returns

reference to vector with all all keys.

Implemented in prtx::Material.

getString()

virtual const std::wstring& prtx::Attributable::getString ( const std::wstring &  key ) const

pure virtual

Gets a string. The returned reference stays valid until destruction of the Attributable.

Parameters

key	Key to look for.

Returns

reference to the string associated with a key or throws an exception if key not found.

Implemented in prtx::Material.

getStringArray()

virtual const WStringVector& prtx::Attributable::getStringArray ( const std::wstring &  key ) const

pure virtual

Gets an array of strings. The returned reference stays valid until destruction of the Attributable.

Parameters

key	Key to look for.

Returns

reference to a vector associated with a key or throws an exception if key not found.

Implemented in prtx::Material.

getType()

virtual PrimitiveType prtx::Attributable::getType ( const std::wstring &  key ) const

pure virtual

Parameters

key	Key to look for.

Returns

the type of the key's value or throws an exception if key is not found.

Implemented in prtx::Material.

hasKey()

virtual bool prtx::Attributable::hasKey ( const std::wstring &  key ) const

pure virtual

Checks whether a key is set.

Parameters

key	Key to look for.

Returns

true if the key is set, false otherwise.

Implemented in prtx::Material.

---

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

• /Attributable.h