C++ API Reference
Attach Class Referenceabstract

Helper class to manage attachment of metadata to other class objects. More...

#include <adskDataAttach.h>

+ Inheritance diagram for Attach:

Public Member Functions

 Attach ()
 Default constructor.
 
virtual ~Attach ()
 Default destructor.
 
 Attach (const Attach &)
 Copy constructor, does nothing since there is no data. More...
 
virtual adsk::Data::AssociationseditableMetadata ()=0
 Retrieve the metadata uniquely associated with this object.
 
virtual const adsk::Data::Associationsmetadata () const =0
 Retrieve the metadata uniquely associated with this object (const form)
 
virtual bool setMetadata (const adsk::Data::Associations &)=0
 Attach new metadata to this object.
 
virtual bool deleteMetadata ()=0
 Remove all metadata attached to this object.
 

Detailed Description

Helper class to manage attachment of metadata to other class objects.

Since in the purest sense metadata means "data about data" it is often useful to attach the metadata directly to the data which it informs. This helper class provides a simple interface for doing just that.

Use it as a mixin on any class to which metadata is to be attached. Implement the abstract methods to access the metadata from wherever your class wishes to store it.

Constructor & Destructor Documentation

Attach ( const Attach rhs)

Copy constructor, does nothing since there is no data.

Parameters
[in]rhsAttach data to be copied

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