libCZI
Reading and Writing CZI documents made easy
libCZI::IAttachment Class Referenceabstract

Representation of an attachment. An attachment is a binary blob, its inner structure is opaque. More...

#include <libCZI.h>

Public Member Functions

virtual const AttachmentInfoGetAttachmentInfo () const =0
 
virtual void DangerousGetRawData (const void *&ptr, size_t &size) const =0
 
virtual std::shared_ptr< const void > GetRawData (size_t *ptrSize)=0
 
template<class Q >
void DangerousGetRawData (const Q *&ptr, size_t &size) const
 

Detailed Description

Representation of an attachment. An attachment is a binary blob, its inner structure is opaque.

Member Function Documentation

◆ DangerousGetRawData() [1/2]

template<class Q >
void libCZI::IAttachment::DangerousGetRawData ( const Q *&  ptr,
size_t &  size 
) const
inline

A helper method used to cast the pointer to a specific type.

Parameters
[out]ptrThe pointer to the data is stored here.
[out]sizeThe size of the data.

◆ DangerousGetRawData() [2/2]

virtual void libCZI::IAttachment::DangerousGetRawData ( const void *&  ptr,
size_t &  size 
) const
pure virtual

Get a pointer to the raw data. Note that the pointer returned is only valid during the lifetime of the sub-block-object.

Parameters
[out]ptrThe pointer to the data is stored here.
[out]sizeThe size of the data.

◆ GetAttachmentInfo()

virtual const AttachmentInfo& libCZI::IAttachment::GetAttachmentInfo ( ) const
pure virtual

Gets information about the attachment.

Returns
The attachment information.

◆ GetRawData()

virtual std::shared_ptr<const void> libCZI::IAttachment::GetRawData ( size_t *  ptrSize)
pure virtual

Gets raw data.

Parameters
[out]ptrSizeIf non-null, size of the data buffer is stored here.
Returns
The raw data.

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