Class representing embedded file data. More...

#include <edl/ifilespec.h>

Inheritance diagram for IFileSpecAsEmbeddedData:

Classes
class	Data
	IFileSpecAsEmbeddedData class parameters. More...

Public Types
enum	eAFRelationship { eAFRNone , eAFRSource , eAFRData , eAFRAlternative , eAFRSupplement , eAFREncryptedPayload , eAFRFormData , eAFRSchema , eAFRUnspecified }
	This is currently a PDF-specific feature used when producing PDF/A-3 output. AFRelationship specifies the nature of the relationship between a PDF or a PDF object and the related content. More...
Public Types inherited from IFileSpec
enum	eFileSpecType { eFileSpecExternal , eFileSpecEmbedded , eFileSpecUrl }
	Types of file specification for file references in PDF. More...

Public Member Functions
virtual bool	getFileName (EDLSysString &fileName) const =0
	Retrieves the file name.
virtual bool	setFileName (const EDLSysString &fileName)=0
	Sets the file name.
virtual bool	getDescription (EDLSysString &description) const =0
	Retrieves the description.
virtual bool	setDescription (const EDLSysString &description)=0
	Sets the description.
virtual bool	getMimeType (EDLSysString &mimeType) const =0
	Retrieves the file mime type.
virtual bool	setMimeType (const EDLSysString &mimeType)=0
	Sets the file mime type.
virtual bool	getCreationDate (EDLSysString &date) const =0
	Retrieves the date and time when the annotation was created.
virtual bool	setCreationDate (const EDLSysString &date)=0
	Sets the annotation creation date.
virtual bool	getModificationDate (EDLSysString &date) const =0
	Retrieves the date and time when the annotation was most recently modified.
virtual bool	setModificationDate (const EDLSysString &date)=0
	Sets the annotation modification date.
virtual uint64	getFileSize () const =0
	Retrieves the file size.
virtual bool	setFileSize (uint64 fileSize)=0
	Sets the file size.
virtual bool	getChecksum (EDLSysString &checksum) const =0
	Retrieves the checksum for the file data.
virtual bool	setChecksum (const EDLSysString &checksum)=0
	Sets the checksum for the file data.
virtual bool	getFileDataStream (IRAInputStreamPtr &stream) const =0
	Retrieves the stream associated with the file data.
virtual bool	setFileDataStream (const IRAInputStreamPtr &stream)=0
	Sets the stream associated with the file data.
virtual eAFRelationship	getAFRelationship ()=0
	Retrieves the AFRelationship associated with the file data.
virtual void	setAFRelationship (eAFRelationship afRelationship)=0
	Sets the AFRelationship associated with the file data.
Public Member Functions inherited from IFileSpec
virtual eFileSpecType	getFileSpecType () const =0
	Retrieves the file spec type.
Public Member Functions inherited from IEDLObject
virtual const CClassID &	getClassID () const =0
	Returns class ID of IEDLObject.
virtual bool	init (CClassParams *pData)
	The init() method is called to perform any post-construction initialization of an IEDLObject that has been created by the EDL class factory, before it is actually returned by the factory.
virtual bool	clone (IEDLObjectPtr &ptrObject, IEDLClassFactory *pFactory)
	Create a copy of EDLObject.
Public Member Functions inherited from IRCObject
virtual void	addRef () const =0
	Increases the reference count of the actual object pointed to. This would take place during an assignment or copying.
virtual bool	decRef () const =0
	Decreases the reference count of the actual object pointed to. When the reference count falls to Zero, it deletes the actual object pointed to.
virtual int32	getRefCount () const =0
	Retrieve the current reference count of the actual object pointed to.

Static Public Member Functions
static const CClassID &	classID ()
	Retrieves class id of IFileSpecAsEmbeddedData.

Additional Inherited Members
Protected Member Functions inherited from IRCObject
virtual	~IRCObject ()
	Virtual destructor.

Detailed Description

Class representing embedded file data.

Member Enumeration Documentation

◆ eAFRelationship

enum IFileSpecAsEmbeddedData::eAFRelationship

This is currently a PDF-specific feature used when producing PDF/A-3 output. AFRelationship specifies the nature of the relationship between a PDF or a PDF object and the related content.

types

Enumerator
eAFRNone	Default; no relationship.
eAFRSource	File specification is the original source material for the associated content.
eAFRData	File specification represents information used to derive a visual presentation.
eAFRAlternative	File specification is an alternative representation of content.
eAFRSupplement	File specification represents a supplemental representation of the original source or data.
eAFREncryptedPayload	File specification is an encrypted payload document that should be displayed to the.
eAFRFormData	File specification is the data associated with a PDF AcroForm.
eAFRSchema	File specification is a schema definition for the associated object (e.g., an XML.
eAFRUnspecified	Relationship is not known or cannot be described using one of the other values.

Member Function Documentation

◆ classID()

const CClassID & IFileSpecAsEmbeddedData::classID ( )

inlinestatic

Retrieves class id of IFileSpecAsEmbeddedData.

Returns: CClassID Class id of the element

◆ getAFRelationship()

virtual eAFRelationship IFileSpecAsEmbeddedData::getAFRelationship ( )

pure virtual

Retrieves the AFRelationship associated with the file data.

Returns: eAFRelationship The AFRelationship. See eAFRelationship for details.

◆ getChecksum()

virtual bool IFileSpecAsEmbeddedData::getChecksum ( EDLSysString & checksum ) const

pure virtual

Retrieves the checksum for the file data.

Parameters

checksum The data checksum

Returns: bool True on success

◆ getCreationDate()

virtual bool IFileSpecAsEmbeddedData::getCreationDate ( EDLSysString & date ) const

pure virtual

Retrieves the date and time when the annotation was created.

Parameters

date	The data and time

Returns: bool True on success

◆ getDescription()

virtual bool IFileSpecAsEmbeddedData::getDescription ( EDLSysString & description ) const

pure virtual

Retrieves the description.

Parameters

description The description.

Returns: bool True on success

◆ getFileDataStream()

virtual bool IFileSpecAsEmbeddedData::getFileDataStream ( IRAInputStreamPtr & stream ) const

pure virtual

Retrieves the stream associated with the file data.

Parameters

stream The file data stream

Returns: bool True on success

◆ getFileName()

virtual bool IFileSpecAsEmbeddedData::getFileName ( EDLSysString & fileName ) const

pure virtual

Retrieves the file name.

Parameters

fileName The file name.

Returns: bool True on success

◆ getFileSize()

virtual uint64 IFileSpecAsEmbeddedData::getFileSize ( ) const

pure virtual

Retrieves the file size.

Returns: uint64 The size of the file.

◆ getMimeType()

virtual bool IFileSpecAsEmbeddedData::getMimeType ( EDLSysString & mimeType ) const

pure virtual

Retrieves the file mime type.

Parameters

mimeType The file mime type.

Returns: bool True on success

◆ getModificationDate()

virtual bool IFileSpecAsEmbeddedData::getModificationDate ( EDLSysString & date ) const

pure virtual

Retrieves the date and time when the annotation was most recently modified.

Parameters

date	The date and time

Returns: bool True on success

◆ setAFRelationship()

virtual void IFileSpecAsEmbeddedData::setAFRelationship ( eAFRelationship afRelationship )

pure virtual

Sets the AFRelationship associated with the file data.

Parameters

afRelationship The AFRelationship. See eAFRelationship for details.

◆ setChecksum()

virtual bool IFileSpecAsEmbeddedData::setChecksum ( const EDLSysString & checksum )

pure virtual

Sets the checksum for the file data.

Parameters

checksum The data checksum

Returns: bool True on success

◆ setCreationDate()

virtual bool IFileSpecAsEmbeddedData::setCreationDate ( const EDLSysString & date )

pure virtual

Sets the annotation creation date.

Parameters

date	the data and time

Returns: bool True on success

◆ setDescription()

virtual bool IFileSpecAsEmbeddedData::setDescription ( const EDLSysString & description )

pure virtual

Sets the description.

Parameters

description The description.

Returns: bool True on success

◆ setFileDataStream()

virtual bool IFileSpecAsEmbeddedData::setFileDataStream ( const IRAInputStreamPtr & stream )

pure virtual

Sets the stream associated with the file data.

Parameters

stream The file data stream

Returns: bool True on success

◆ setFileName()

virtual bool IFileSpecAsEmbeddedData::setFileName ( const EDLSysString & fileName )

pure virtual

Sets the file name.

Parameters

fileName The file name.

Returns: bool True on success

◆ setFileSize()

virtual bool IFileSpecAsEmbeddedData::setFileSize ( uint64 fileSize )

pure virtual

Sets the file size.

Parameters

fileSize the file size.

Returns: bool True on success

◆ setMimeType()

virtual bool IFileSpecAsEmbeddedData::setMimeType ( const EDLSysString & mimeType )

pure virtual

Sets the file mime type.

Parameters

mimeType The file mime type.

Returns: bool True on success

◆ setModificationDate()

virtual bool IFileSpecAsEmbeddedData::setModificationDate ( const EDLSysString & date )

pure virtual

Sets the annotation modification date.

Parameters

date	the date and time

Returns: bool True on success

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

edl/ifilespec.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ eAFRelationship

Member Function Documentation

◆ classID()

◆ getAFRelationship()

◆ getChecksum()

◆ getCreationDate()

◆ getDescription()

◆ getFileDataStream()

◆ getFileName()

◆ getFileSize()

◆ getMimeType()

◆ getModificationDate()

◆ setAFRelationship()

◆ setChecksum()

◆ setCreationDate()

◆ setDescription()

◆ setFileDataStream()

◆ setFileName()

◆ setFileSize()

◆ setMimeType()

◆ setModificationDate()