C3D Toolkit  Kernel - 118060, Vision - 2.15.0.1825
IConverterMetadataReceiver Class Referenceabstract

Metadata transfer. More...

#include <conv_requestor.h>

+ Inheritance diagram for IConverterMetadataReceiver:
+ Collaboration diagram for IConverterMetadataReceiver:

Public Member Functions

virtual bool InitMetadataForItem (const c3d::string_t &category, const c3d::string_t &nameInCategory, const c3d::string_t &contentType)=0
 Initialize metadata transfer for item. More...
 
virtual void CloseMetadataForItem (const c3d::string_t &category, const c3d::string_t &nameInCategory)=0
 Finalize metadata transfer for item. More...
 
virtual void TransferMetadataForItem (const c3d::string_t &category, const c3d::string_t &nameInCategory, const char *metadataBuffer, unsigned long int bufferCapacity)=0
 Transfer metadata block for item. More...
 
- Public Member Functions inherited from MbRefItem
virtual MbeRefType RefType () const
 Registration type (for copying, duplication).
 
void AddRegistrator (MbRegDuplicate *reg) const
 Add the register.
 
void RemoveRegistrator (MbRegDuplicate *reg) const
 Remove the register.
 
refcount_t GetUseCount () const
 Get count of references (get count of owners of an object).
 
refcount_t AddRef () const
 Increase count of references by one.
 
refcount_t DecRef () const
 Decrease count of references by one.
 
refcount_t Release () const
 Decrease count of references by one and if count of references became zero, then remove itself.
 

Additional Inherited Members

- Protected Member Functions inherited from MbRefItem
 MbRefItem ()
 Constructor without parameters.
 

Detailed Description

Metadata transfer.

Metadata are used in cases when geometric or attribute model doesn't match structure of information from converters. Alternate tree sutrucure is a sample of metadata.

Member Function Documentation

◆ InitMetadataForItem()

virtual bool IConverterMetadataReceiver::InitMetadataForItem ( const c3d::string_t category,
const c3d::string_t nameInCategory,
const c3d::string_t contentType 
)
pure virtual

Initialize metadata transfer for item.

Should be called before metadata related to non-geometric element to prepare the reciever.

Parameters
[in]category- Category element belongs to.
[in]nameInCategory- Element's name in category.
[in]contentType- Representation of metadata.
Returns
Wether the metadata transfer is possible.
Note
Expected it is called once for each category - name pair.

◆ CloseMetadataForItem()

virtual void IConverterMetadataReceiver::CloseMetadataForItem ( const c3d::string_t category,
const c3d::string_t nameInCategory 
)
pure virtual

Finalize metadata transfer for item.

Should be called after metadata related to non-geometric element to free related resources.

Parameters
[in]category- Category element belongs to.
[in]nameInCategory- Element's name in category.
Note
Expected it is called once for each category - name pair in case transfer is possible or not called otherwise.

◆ TransferMetadataForItem()

virtual void IConverterMetadataReceiver::TransferMetadataForItem ( const c3d::string_t category,
const c3d::string_t nameInCategory,
const char *  metadataBuffer,
unsigned long int  bufferCapacity 
)
pure virtual

Transfer metadata block for item.

Parameters
[in]category- Category element belongs to.
[in]nameInCategory- Element's name in category.
[in]metadataBuffer- Binary buffer containing block data.
[in]bufferCapacity- Lenght of binary buffer containing block data.
Note
Many calls for each category - name are possible.

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