DOFObjectIDAttribute

The Attribute class is used to retrieve attributes from a DOFObjectID. More...

Data Structures
struct	DOFObjectIDAttribute
	DOF Object ID Attribute Descriptor. More...

Enumerations
enum	DOFObjectIDAttributeType {   DOFOBJECTIDATTRIBUTE_PROVIDER,   DOFOBJECTIDATTRIBUTE_SESSION,   DOFOBJECTIDATTRIBUTE_GROUP,   DOFOBJECTIDATTRIBUTE_BINDING_PROVIDER,   DOFOBJECTIDATTRIBUTE_RELATED_TIME,   DOFOBJECTIDATTRIBUTE_CREATED_TIME,   DOFOBJECTIDATTRIBUTE_INVALID }
	Predefined DOF Object Identifier Attribute ID codes, defining the data with which an Object ID can be augmented. More...

Functions
boolean	DOFObjectIDAttribute_IsValid (const DOFObjectIDAttribute attribute)
	Determine if the attribute is a valid attribute.
DOFObjectIDAttributeType	DOFObjectIDAttribute_GetType (const DOFObjectIDAttribute attribute)
	Get the ID of the attribute.
DOFObjectIDAttributeDataSize	DOFObjectIDAttribute_GetValueSize (const DOFObjectIDAttribute attribute)
	Get the size of the data associated with the attribute.
const uint8 *	DOFObjectIDAttribute_GetValue (const DOFObjectIDAttribute attribute)
	Get the data associated with the attribute.
const char *	DOFObjectIDAttribute_GetValueString (const DOFObjectIDAttribute attribute)
	Get the data associated with the attribute as a string.
DOFObjectID	DOFObjectIDAttribute_CreateValueObjectID (const DOFObjectIDAttribute attribute)
	Create a new DOFObjectID from the data associated with the attribute.

Detailed Description

The Attribute class is used to retrieve attributes from a DOFObjectID.

Attributes are used to add additional information to the object identifier, either to qualify its use or modify the way that the system uses it.

There are a set of attribute types defined by this class, although this is not guaranteed to be exhaustive. Further types may be defined, and this library is flexible enough to allow access to them. However, these kinds of extensions must be registered with the OpenDOF Project and will be added to the library once approved.