Attr::StringAttrId Class Reference

#include <stringattrid.h>

Detailed Description

Typed attribute id for string type.

Copyright

(C) 2006 Radon Labs GmbH (C) 2013-2020 Individual contributors, see AUTHORS file

Inherits Attr::AttrId.

Public Member Functions
	StringAttrId (const AttrId &rhs)
	construct from generic attribute id
	StringAttrId (const AttributeDefinition< StringTypeClass, Util::String > &rhs)
	construct from attribute definition
	StringAttrId (const Util::String &rhs)
	construct from name
	StringAttrId (const Util::FourCC &rhs)
	construct from fourcc code
bool	operator== (const StringAttrId &rhs) const
	equality operator
bool	operator!= (const StringAttrId &rhs) const
	inequality operator
Public Member Functions inherited from Attr::AttrId
	AttrId ()
	default constructor
	AttrId (const AttrId &rhs)
	copy constructor
	AttrId (const AttributeDefinitionBase &def)
	construct from attribute definition class
	AttrId (const AttributeDefinitionBase *ptr)
	construct from pointer to definition class
	AttrId (const Util::String &name)
	construct from attribute name
	AttrId (const Util::FourCC &fcc)
	construct from attribute fourcc code
bool	operator== (const AttrId &rhs) const
	equality operator
bool	operator!= (const AttrId &rhs) const
	inequality operator
bool	operator> (const AttrId &rhs) const
	greater operator
bool	operator>= (const AttrId &rhs) const
	greater-or-equal operator
bool	operator< (const AttrId &rhs) const
	lesser operator
bool	operator<= (const AttrId &rhs) const
	lesser-or-equal operator
const Util::String &	GetName () const
	get attribute name
const Util::String &	GetTypeName () const
	get attribute type name
const Util::FourCC &	GetFourCC () const
	get fourcc code
AccessMode	GetAccessMode () const
	get access type
ValueType	GetValueType () const
	get value type
bool	IsDynamic () const
	return true if this attribute was dynamically registered
bool	IsValid () const
	return true if the attribute id object is valid
uint	GetSizeOfType () const
	return the byte size of the type
bool	GetBoolDefValue () const
	get bool default value
int	GetIntDefValue () const
	get int default value
uint	GetUIntDefValue () const
	get uint default value
float	GetFloatDefValue () const
	get floar default value
const Util::String &	GetStringDefValue () const
	get string default value
Math::vec4	GetVec4DefValue () const
	get float4 default value
const Math::mat4 &	GetMat4DefValue () const
	get mat4 default value
const Util::Blob &	GetBlobDefValue () const
	get blob default value
const Util::Guid &	GetGuidDefValue () const
	get guid default value
const Util::Variant &	GetDefaultValue () const
	get default value variant

Additional Inherited Members
Static Public Member Functions inherited from Attr::AttrId
static bool	IsValidName (const Util::String &n)
	return true if the provided attribute id name is valid
static bool	IsValidFourCC (const Util::FourCC &fcc)
	return true if the provided attribute id fourcc is valid
static Util::FixedArray< AttrId >	GetAllAttrIds ()
	return all attribute id's (slow!)
Protected Attributes inherited from Attr::AttrId
const AttributeDefinitionBase *	defPtr

Constructor & Destructor Documentation

StringAttrId() [1/4]

Attr::StringAttrId::StringAttrId ( const AttrId & rhs )

inline

construct from generic attribute id

StringAttrId() [2/4]

Attr::StringAttrId::StringAttrId ( const AttributeDefinition< StringTypeClass, Util::String > & rhs )

inline

construct from attribute definition

StringAttrId() [3/4]

Attr::StringAttrId::StringAttrId ( const Util::String & rhs )

inline

construct from name

StringAttrId() [4/4]

Attr::StringAttrId::StringAttrId ( const Util::FourCC & rhs )

inline

construct from fourcc code

Member Function Documentation

operator!=()

bool Attr::StringAttrId::operator!= ( const StringAttrId & rhs ) const

inline

inequality operator

operator==()

bool Attr::StringAttrId::operator== ( const StringAttrId & rhs ) const

inline

equality operator

---

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

• /github/workspace/code/addons/attr/stringattrid.h