ImFusion SDK 4.3
SpineDataImFusionFilePlugin Class Reference
+ Inheritance diagram for SpineDataImFusionFilePlugin:

Public Member Functions

virtual DataloadInstance (unsigned int type, unsigned int headerSize) override
 Create specialized instance for a given data type or return null if not supported.
 
virtual unsigned int saveType (const Data *data) override
 Return type for saving a given data instance or null if not supported.
 
virtual bool load (unsigned int anatomicalStructure, Data *anatomicalStructureProperties, std::istream &file, Progress *p=0) override
 Load data into given class instance, return true if data is complete (otherwise ImFusionImage loader will be run)
 
virtual bool save (Data *anatomicalStructure, std::ostream &anatomicalStructureProperties, Progress *p=0) override
 Save a data instance to file, return true if complete (otherwise ImFusionImage writer will be run afterwards) To keep the consistency between the description in data block header and the actual stored block body, use the m_blockType in save method and avoid checking data description directly from the data.
 
virtual bool loadCustomProperties (Data *sp, Properties *prop) override
 Load custom properties as returned previously by customPropertiesToSave()
 
- Public Member Functions inherited from ImFusionFilePlugin
virtual ~ImFusionFilePlugin ()=default
 Destructor.
 
virtual std::unique_ptr< PropertiescustomPropertiesToSave (Data *)
 Lets plugin save custom properties as part of the global file metadata.
 
virtual void applyFlipToEnsureConsistency (Data *)
 Is called after the image content had to be flipped to ensure a consistent coordinate system.
 
virtual bool beginBlockWrite (std::iostream &)
 Initialize plugin with current file pointer.
 
virtual unsigned long long endBlockWrite ()
 Indicate to plugin that the block it is writing needs to be finished.
 
virtual bool beginBlockRead (std::iostream &, unsigned long long)
 Initialize plugin with current file pointer.
 
virtual bool endBlockRead ()
 Indicate to plugin that it will lose read access to the file pointer after this call.
 
virtual void setBlockType (unsigned int type)
 Set the type of current data block which is being loaded/saved.
 

Additional Inherited Members

- Protected Attributes inherited from ImFusionFilePlugin
unsigned int m_blockType = 0
 Keeps the type of currently saving/loading data block.
 

Member Function Documentation

◆ loadInstance()

virtual Data * loadInstance ( unsigned int type,
unsigned int headerSize )
overridevirtual

Create specialized instance for a given data type or return null if not supported.

Implements ImFusionFilePlugin.

◆ saveType()

virtual unsigned int saveType ( const Data * data)
overridevirtual

Return type for saving a given data instance or null if not supported.

Implements ImFusionFilePlugin.

◆ load()

virtual bool load ( unsigned int ,
Data * ,
std::istream & ,
Progress * = 0 )
overridevirtual

Load data into given class instance, return true if data is complete (otherwise ImFusionImage loader will be run)

Reimplemented from ImFusionFilePlugin.

◆ save()

virtual bool save ( Data * ,
std::ostream & ,
Progress * = 0 )
overridevirtual

Save a data instance to file, return true if complete (otherwise ImFusionImage writer will be run afterwards) To keep the consistency between the description in data block header and the actual stored block body, use the m_blockType in save method and avoid checking data description directly from the data.

Reimplemented from ImFusionFilePlugin.

◆ loadCustomProperties()

virtual bool loadCustomProperties ( Data * ,
Properties *  )
overridevirtual

Load custom properties as returned previously by customPropertiesToSave()

Returns
true if successful, false otherwise

Reimplemented from ImFusionFilePlugin.


The documentation for this class was generated from the following file:
Search Tab / S to search, Esc to close