ImFusion C++ SDK 4.4.0
ImFusion::US::FrameGeometryMetadata Class Reference

#include <ImFusion/US/FrameGeometryMetadata.h>

Metadata for the frame geometry of an ultrasound sweep. More...

Inheritance diagram for ImFusion::US::FrameGeometryMetadata:

Detailed Description

Metadata for the frame geometry of an ultrasound sweep.

Use this class as a value-type member in algorithms, if you want the frame geometry to be configurable.

Public Member Functions

 FrameGeometryMetadata ()=default
 Default constructor, does not initialize the internal frame geometry.
 FrameGeometryMetadata (const FrameGeometryMetadata &other)
FrameGeometryMetadataoperator= (const FrameGeometryMetadata &other)
bool operator== (const FrameGeometryMetadata &other) const
 Compares the internal frame geometries only.
std::string id () const override
 Returns the id for this class.
const FrameGeometryframeGeometry () const
 Returns a pointer to its geometry.
void setFrameGeometry (const FrameGeometry &geom)
 Sets the internal frame geometry by cloning the given one.
void setFrameGeometry (std::unique_ptr< FrameGeometry > geom)
 Sets the internal frame geometry, takes ownership of the given one.
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 ImFusion::DataComponent< FrameGeometryMetadata >
std::unique_ptr< DataComponentBase > clone () const override
 Creates a clone of this data component.
std::unique_ptr< Subclass > cloneDerived () const
bool assign (const DataComponentBase &other) override
 Assigns the content of other to this data component.
bool equals (const DataComponentBase &other) const override
 Compares this data component to other for equality.
Public Member Functions inherited from ImFusion::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
Configurable & operator= (const Configurable &)
Configurable & operator= (Configurable &&) noexcept

Public Attributes

Signal< const FrameGeometryMetadata * > signalFrameGeometryChanged
 Emitted when the internal frame geometry changes.
Public Attributes inherited from ImFusion::Configurable
Signal signalParametersChanged
 Emitted whenever one of the registered Parameters' or SubPropertys' signalValueChanged signal was emitted.

Additional Inherited Members

Protected Member Functions inherited from ImFusion::DataComponentBase
 DataComponentBase (const DataComponentBase &)=default
DataComponentBase & operator= (const DataComponentBase &other)=default
Protected Attributes inherited from ImFusion::Configurable
std::vector< Paramm_params
 List of all registered Parameter and SubProperty instances.

Member Function Documentation

◆ id()

std::string ImFusion::US::FrameGeometryMetadata::id ( ) const
overridevirtual

Returns the id for this class.

Implements ImFusion::DataComponentBase.

◆ configure()

void ImFusion::US::FrameGeometryMetadata::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 ImFusion::Configurable.

◆ configuration()

void ImFusion::US::FrameGeometryMetadata::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 ImFusion::Configurable.


The documentation for this class was generated from the following file:
  • ImFusion/US/FrameGeometryMetadata.h
Search Tab / S to search, Esc to close