ImFusion SDK 4.3
DataSourceComponent::DataSourceInfo Struct Reference

#include <ImFusion/Base/DataSourceComponent.h>

Simple struct for storing the original filename of a data, how it has been loaded and the history of its sources. More...

+ Inheritance diagram for DataSourceComponent::DataSourceInfo:

Detailed Description

Simple struct for storing the original filename of a data, how it has been loaded and the history of its sources.

The DataSourceComponent will store a vector of such structures, typically one per frame of an image set. This might seem unnecessary because most multi-frame datasets have the same origin but this is useful in the context of machine learning pipelines, where we assemble batches of multiple images, each one coming from a different source and its own history.

Public Member Functions

 DataSourceInfo (std::string filename, std::string ioAlgorithmName, Properties ioAlgorithmConfiguration, int indexInFile, std::vector< DataSourceInfo > history={})
 
bool operator== (const DataSourceInfo &other) const
 
bool operator!= (const DataSourceInfo &other) const
 
void update (const DataSourceInfo &other)
 Update current data info with other and move the current one in history.
 
bool isEqualTo (const DataSourceInfo &other, bool ignoreHistory=false) const
 Another equality comparator (but configurable)
 
void configure (const Properties *p) override
 Configure this object instance by de-serializing the given Properties.
 
void configuration (Properties *p) const override
 Serialize the current object configuration into the given Properties object.
 
- Public Member Functions inherited from Configurable
virtual void configureDefaults ()
 Retrieve the properties of this object, replaces values with their defaults and sets it again.
 
void registerParameter (ParameterBase *param)
 Register the given Parameter or SubProperty, so that it will be configured during configure()/configuration().
 
void unregisterParameter (const ParameterBase *param)
 Remove the given Parameter or SubProperty from the list of registered parameters.
 
 Configurable (const Configurable &rhs)
 
 Configurable (Configurable &&rhs) noexcept
 
Configurableoperator= (const Configurable &)
 
Configurableoperator= (Configurable &&) noexcept
 

Public Attributes

std::string filename
 Path to original file.
 
std::string ioAlgorithmName
 Name of the IO algorithm used to load the data.
 
Properties ioAlgorithmConfig
 Parameters of the IO algorithm.
 
int indexInFile = 0
 Index of the data in its original file.
 
std::vector< DataSourceInfohistory
 Previous source infos (for traceability)
 
- Public Attributes inherited from Configurable
Signal signalParametersChanged
 Emitted whenever one of the registered Parameters' or SubPropertys' signalValueChanged signal was emitted.
 

Additional Inherited Members

- Protected Attributes inherited from Configurable
std::vector< Paramm_params
 List of all registered Parameter and SubProperty instances.
 

Member Function Documentation

◆ configure()

void configure ( const Properties * p)
overridevirtual

Configure this object instance by de-serializing the given Properties.

The default implementation will do so automatically for all registered Parameter and SubProperty instances.

See also
configuration() for the inverse functionality

Reimplemented from Configurable.

◆ configuration()

void configuration ( Properties * p) const
overridevirtual

Serialize the current object configuration into the given Properties object.

The default implementation will do so automatically for all registered Parameter and SubProperty instances.

See also
configure() for the inverse functionality

Reimplemented from Configurable.


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