ImagingTools Core SDK
Public Member Functions | List of all members
imtbase::ICollectionDataControllerabstract

#include <ICollectionDataController.h>

Inheritance diagram for imtbase::ICollectionDataController:
imtbase::CObjectCollectionBase imtrepo::CFileCollectionCompBase imtbase::CFilterCollectionProxy imtbase::CObjectCollection imtbase::CStaticObjectCollection

Public Member Functions

virtual const ifile::IFilePersistence * GetPersistenceForObjectType (const QByteArray &typeId) const =0
 
virtual bool ExportFile (const imtbase::IObjectCollection &collection, const ICollectionInfo::Id &objectId, const QString &targetFilePath=QString()) const =0
 
virtual ICollectionInfo::Id ImportFile (imtbase::IObjectCollection &collection, const QByteArray &typeId, const QString &sourceFilePath=QString(), const QString &objectName=QString()) const =0
 

Detailed Description

Common interface for the services around the objects in the collection.

Definition at line 26 of file ICollectionDataController.h.

Member Function Documentation

◆ ExportFile()

virtual bool imtbase::ICollectionDataController::ExportFile ( const imtbase::IObjectCollection collection,
const ICollectionInfo::Id &  objectId,
const QString &  targetFilePath = QString() 
) const
pure virtual

Export a file from an object collection.

Parameters
collectionCollection containing the object to be exported.
objectIdID of the object to be exported from a collection.
targetPathPath to the exported file.
Returns
true if the file object was successfully exported or false otherwise.

◆ GetPersistenceForObjectType()

virtual const ifile::IFilePersistence * imtbase::ICollectionDataController::GetPersistenceForObjectType ( const QByteArray &  typeId) const
pure virtual

Get the file persistence for a given object type.

◆ ImportFile()

virtual ICollectionInfo::Id imtbase::ICollectionDataController::ImportFile ( imtbase::IObjectCollection collection,
const QByteArray &  typeId,
const QString &  sourceFilePath = QString(),
const QString &  objectName = QString() 
) const
pure virtual

Import an object in the collection from a file.

Parameters
collectionCollection instance where the will be imported.
typeIdObject type ID.
sourcePathPath to the imported file.
objectNameName of the imported object after import in the collection.
Returns
true if the file object was successfully imported or false otherwise.