MRObjectComparableWithReference.h

Go to the documentation of this file.

#pragma once
 
#include <MRCMisc/common.h>
#include <MRCMisc/exports.h>
 
#include <stdbool.h>
#include <stddef.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef struct MR_std_optional_MR_ObjectComparableWithReference_ComparableProperty MR_std_optional_MR_ObjectComparableWithReference_ComparableProperty; // Defined in `#include <MRCMisc/std_optional_MR_ObjectComparableWithReference_ComparableProperty.h>`.
typedef struct MR_std_optional_MR_ObjectComparableWithReference_ComparisonTolerance MR_std_optional_MR_ObjectComparableWithReference_ComparisonTolerance; // Defined in `#include <MRCMisc/std_optional_MR_ObjectComparableWithReference_ComparisonTolerance.h>`.
typedef struct MR_std_optional_float MR_std_optional_float; // Defined in `#include <MRCMisc/std_optional_float.h>`.
typedef struct MR_std_string_view MR_std_string_view; // Defined in `#include <MRCMisc/std_string_view.h>`.
typedef struct MR_std_variant_float_MR_Vector3f MR_std_variant_float_MR_Vector3f; // Defined in `#include <MRCMisc/std_variant_float_MR_Vector3f.h>`.
 

typedef struct MR_ObjectComparableWithReference_ComparableProperty MR_ObjectComparableWithReference_ComparableProperty;
 
// Tolerances:
typedef struct MR_ObjectComparableWithReference_ComparisonTolerance MR_ObjectComparableWithReference_ComparisonTolerance;
 
// This can't be `std::optional<Var>`, because we still need the variant to know the correct type.
typedef struct MR_ObjectComparableWithReference_ComparisonReferenceValue MR_ObjectComparableWithReference_ComparisonReferenceValue;
 
// A base class for a data-model object that is a feature/measurement that can be compared between two models.
typedef struct MR_ObjectComparableWithReference MR_ObjectComparableWithReference;

MRC_API void MR_ObjectComparableWithReference_Destroy(const MR_ObjectComparableWithReference *_this);

MRC_API void MR_ObjectComparableWithReference_DestroyArray(const MR_ObjectComparableWithReference *_this);
 
// When comparing this object with a reference, how many different properties can we output?
MRC_API MR_uint64_t MR_ObjectComparableWithReference_numComparableProperties(const MR_ObjectComparableWithReference *_this);
 
// `i` goes up to `numComparableProperties()`, exclusive.
MRC_API MR_std_string_view *MR_ObjectComparableWithReference_getComparablePropertyName(const MR_ObjectComparableWithReference *_this, MR_uint64_t i);
 
// Compute a value of a property.
// Compare `value` and `referenceValue` using the tolerance.
// This can return null if the value is impossible to compute, e.g. for some types if the reference isn't set (e.g. if
//   we're computing the distance to a reference point).
// `i` goes up to `numComparableProperties()`, exclusive.
MRC_API MR_std_optional_MR_ObjectComparableWithReference_ComparableProperty *MR_ObjectComparableWithReference_computeComparableProperty(const MR_ObjectComparableWithReference *_this, MR_uint64_t i);
 
// Returns the tolerance for a specific comparable property. Returns null if not set.
// `i` goes up to `numComparableProperties()`, exclusive.
MRC_API MR_std_optional_MR_ObjectComparableWithReference_ComparisonTolerance *MR_ObjectComparableWithReference_getComparisonTolerence(const MR_ObjectComparableWithReference *_this, MR_uint64_t i);
 
// Sets the tolerance for a specific comparable property.
// `i` goes up to `numComparableProperties()`, exclusive.
MRC_API void MR_ObjectComparableWithReference_setComparisonTolerance(MR_ObjectComparableWithReference *_this, MR_uint64_t i, const MR_ObjectComparableWithReference_ComparisonTolerance *newTolerance);
 
// If true, indicates that the getter will always return zero negative tolerance, and the setter will ignore the negative tolerance.
// `i` goes up to `numComparableProperties()`, exclusive.
MRC_API bool MR_ObjectComparableWithReference_comparisonToleranceIsAlwaysOnlyPositive(const MR_ObjectComparableWithReference *_this, MR_uint64_t i);
 
// The number and types of reference values can be entirely different compared to `numComparableProperties()`.
MRC_API MR_uint64_t MR_ObjectComparableWithReference_numComparisonReferenceValues(const MR_ObjectComparableWithReference *_this);
 
// `i` goes up to `numComparisonReferenceValues()`, exclusive.
MRC_API MR_std_string_view *MR_ObjectComparableWithReference_getComparisonReferenceValueName(const MR_ObjectComparableWithReference *_this, MR_uint64_t i);
 
// Returns the internal reference value.
// If the value wasn't set yet (as indicated by `isSet == false`), you can still use the returned variant to get the expected type.
// `i` goes up to `numComparisonReferenceValues()`, exclusive.
MRC_API MR_ObjectComparableWithReference_ComparisonReferenceValue *MR_ObjectComparableWithReference_getComparisonReferenceValue(const MR_ObjectComparableWithReference *_this, MR_uint64_t i);
 
// Sets the internal reference value. Makes `hasComparisonReferenceValue()` return true.
// If you pass nullopt, removes this reference value.
// Only a certain variant type is legal to pass, depending on the derived class and the index. Use `getComparisonReferenceValue()` to determine that type.
// `i` goes up to `numComparisonReferenceValues()`, exclusive.
MRC_API void MR_ObjectComparableWithReference_setComparisonReferenceValue(MR_ObjectComparableWithReference *_this, MR_uint64_t i, const MR_std_variant_float_MR_Vector3f *value);

MRC_API void MR_ObjectComparableWithReference_setComparisonReferenceVal(MR_ObjectComparableWithReference *_this, MR_uint64_t i, const MR_ObjectComparableWithReference_ComparisonReferenceValue *value);

MRC_API const MR_ObjectComparableWithReference *MR_ObjectComparableWithReference_OffsetPtr(const MR_ObjectComparableWithReference *ptr, ptrdiff_t i);

MRC_API MR_ObjectComparableWithReference *MR_ObjectComparableWithReference_OffsetMutablePtr(MR_ObjectComparableWithReference *ptr, ptrdiff_t i);

MRC_API const float *MR_ObjectComparableWithReference_ComparableProperty_Get_value(const MR_ObjectComparableWithReference_ComparableProperty *_this);

MRC_API void MR_ObjectComparableWithReference_ComparableProperty_Set_value(MR_ObjectComparableWithReference_ComparableProperty *_this, float value);

MRC_API float *MR_ObjectComparableWithReference_ComparableProperty_GetMutable_value(MR_ObjectComparableWithReference_ComparableProperty *_this);
 
// This can be null if the reference value isn't set, or something else is wrong.
// This can match whatever is set via `get/setComparisonReferenceValue()`, but not necessarily.
// E.g. for point coordinates, those functions act on the reference coordinates (three optional floats), but this number is always zero,
//   and the `value` is the distance to those coordinates.
MRC_API const MR_std_optional_float *MR_ObjectComparableWithReference_ComparableProperty_Get_referenceValue(const MR_ObjectComparableWithReference_ComparableProperty *_this);
 
// This can be null if the reference value isn't set, or something else is wrong.
// This can match whatever is set via `get/setComparisonReferenceValue()`, but not necessarily.
// E.g. for point coordinates, those functions act on the reference coordinates (three optional floats), but this number is always zero,
//   and the `value` is the distance to those coordinates.
MRC_API void MR_ObjectComparableWithReference_ComparableProperty_Set_referenceValue(MR_ObjectComparableWithReference_ComparableProperty *_this, const float *value);
 
// This can be null if the reference value isn't set, or something else is wrong.
// This can match whatever is set via `get/setComparisonReferenceValue()`, but not necessarily.
// E.g. for point coordinates, those functions act on the reference coordinates (three optional floats), but this number is always zero,
//   and the `value` is the distance to those coordinates.
MRC_API MR_std_optional_float *MR_ObjectComparableWithReference_ComparableProperty_GetMutable_referenceValue(MR_ObjectComparableWithReference_ComparableProperty *_this);

MRC_API MR_ObjectComparableWithReference_ComparableProperty *MR_ObjectComparableWithReference_ComparableProperty_DefaultConstruct(void);

MRC_API MR_ObjectComparableWithReference_ComparableProperty *MR_ObjectComparableWithReference_ComparableProperty_DefaultConstructArray(size_t num_elems);

MRC_API MR_ObjectComparableWithReference_ComparableProperty *MR_ObjectComparableWithReference_ComparableProperty_ConstructFrom(float value, const float *referenceValue);

MRC_API const MR_ObjectComparableWithReference_ComparableProperty *MR_ObjectComparableWithReference_ComparableProperty_OffsetPtr(const MR_ObjectComparableWithReference_ComparableProperty *ptr, ptrdiff_t i);

MRC_API MR_ObjectComparableWithReference_ComparableProperty *MR_ObjectComparableWithReference_ComparableProperty_OffsetMutablePtr(MR_ObjectComparableWithReference_ComparableProperty *ptr, ptrdiff_t i);

MRC_API MR_ObjectComparableWithReference_ComparableProperty *MR_ObjectComparableWithReference_ComparableProperty_ConstructFromAnother(const MR_ObjectComparableWithReference_ComparableProperty *_other);

MRC_API void MR_ObjectComparableWithReference_ComparableProperty_Destroy(const MR_ObjectComparableWithReference_ComparableProperty *_this);

MRC_API void MR_ObjectComparableWithReference_ComparableProperty_DestroyArray(const MR_ObjectComparableWithReference_ComparableProperty *_this);

MRC_API MR_ObjectComparableWithReference_ComparableProperty *MR_ObjectComparableWithReference_ComparableProperty_AssignFromAnother(MR_ObjectComparableWithReference_ComparableProperty *_this, const MR_ObjectComparableWithReference_ComparableProperty *_other);
 
// How much larger can this value be compared to the reference?
MRC_API const float *MR_ObjectComparableWithReference_ComparisonTolerance_Get_positive(const MR_ObjectComparableWithReference_ComparisonTolerance *_this);
 
// How much larger can this value be compared to the reference?
MRC_API void MR_ObjectComparableWithReference_ComparisonTolerance_Set_positive(MR_ObjectComparableWithReference_ComparisonTolerance *_this, float value);
 
// How much larger can this value be compared to the reference?
MRC_API float *MR_ObjectComparableWithReference_ComparisonTolerance_GetMutable_positive(MR_ObjectComparableWithReference_ComparisonTolerance *_this);
 
// How much smaller can this value be compared to the reference?
// This number should normally be zero or negative.
MRC_API const float *MR_ObjectComparableWithReference_ComparisonTolerance_Get_negative(const MR_ObjectComparableWithReference_ComparisonTolerance *_this);
 
// How much smaller can this value be compared to the reference?
// This number should normally be zero or negative.
MRC_API void MR_ObjectComparableWithReference_ComparisonTolerance_Set_negative(MR_ObjectComparableWithReference_ComparisonTolerance *_this, float value);
 
// How much smaller can this value be compared to the reference?
// This number should normally be zero or negative.
MRC_API float *MR_ObjectComparableWithReference_ComparisonTolerance_GetMutable_negative(MR_ObjectComparableWithReference_ComparisonTolerance *_this);

MRC_API MR_ObjectComparableWithReference_ComparisonTolerance *MR_ObjectComparableWithReference_ComparisonTolerance_DefaultConstruct(void);

MRC_API MR_ObjectComparableWithReference_ComparisonTolerance *MR_ObjectComparableWithReference_ComparisonTolerance_DefaultConstructArray(size_t num_elems);

MRC_API MR_ObjectComparableWithReference_ComparisonTolerance *MR_ObjectComparableWithReference_ComparisonTolerance_ConstructFrom(float positive, float negative);

MRC_API const MR_ObjectComparableWithReference_ComparisonTolerance *MR_ObjectComparableWithReference_ComparisonTolerance_OffsetPtr(const MR_ObjectComparableWithReference_ComparisonTolerance *ptr, ptrdiff_t i);

MRC_API MR_ObjectComparableWithReference_ComparisonTolerance *MR_ObjectComparableWithReference_ComparisonTolerance_OffsetMutablePtr(MR_ObjectComparableWithReference_ComparisonTolerance *ptr, ptrdiff_t i);

MRC_API MR_ObjectComparableWithReference_ComparisonTolerance *MR_ObjectComparableWithReference_ComparisonTolerance_ConstructFromAnother(const MR_ObjectComparableWithReference_ComparisonTolerance *_other);

MRC_API void MR_ObjectComparableWithReference_ComparisonTolerance_Destroy(const MR_ObjectComparableWithReference_ComparisonTolerance *_this);

MRC_API void MR_ObjectComparableWithReference_ComparisonTolerance_DestroyArray(const MR_ObjectComparableWithReference_ComparisonTolerance *_this);

MRC_API MR_ObjectComparableWithReference_ComparisonTolerance *MR_ObjectComparableWithReference_ComparisonTolerance_AssignFromAnother(MR_ObjectComparableWithReference_ComparisonTolerance *_this, const MR_ObjectComparableWithReference_ComparisonTolerance *_other);

MRC_API const bool *MR_ObjectComparableWithReference_ComparisonReferenceValue_Get_isSet(const MR_ObjectComparableWithReference_ComparisonReferenceValue *_this);

MRC_API void MR_ObjectComparableWithReference_ComparisonReferenceValue_Set_isSet(MR_ObjectComparableWithReference_ComparisonReferenceValue *_this, bool value);

MRC_API bool *MR_ObjectComparableWithReference_ComparisonReferenceValue_GetMutable_isSet(MR_ObjectComparableWithReference_ComparisonReferenceValue *_this);
 
// If `isSet == false`, this will hold zeroes, or some other default values.
MRC_API const MR_std_variant_float_MR_Vector3f *MR_ObjectComparableWithReference_ComparisonReferenceValue_Get_var(const MR_ObjectComparableWithReference_ComparisonReferenceValue *_this);
 
// If `isSet == false`, this will hold zeroes, or some other default values.
MRC_API void MR_ObjectComparableWithReference_ComparisonReferenceValue_Set_var(MR_ObjectComparableWithReference_ComparisonReferenceValue *_this, const MR_std_variant_float_MR_Vector3f *value);
 
// If `isSet == false`, this will hold zeroes, or some other default values.
MRC_API MR_std_variant_float_MR_Vector3f *MR_ObjectComparableWithReference_ComparisonReferenceValue_GetMutable_var(MR_ObjectComparableWithReference_ComparisonReferenceValue *_this);

MRC_API MR_ObjectComparableWithReference_ComparisonReferenceValue *MR_ObjectComparableWithReference_ComparisonReferenceValue_DefaultConstruct(void);

MRC_API MR_ObjectComparableWithReference_ComparisonReferenceValue *MR_ObjectComparableWithReference_ComparisonReferenceValue_DefaultConstructArray(size_t num_elems);

MRC_API MR_ObjectComparableWithReference_ComparisonReferenceValue *MR_ObjectComparableWithReference_ComparisonReferenceValue_ConstructFrom(bool isSet, const MR_std_variant_float_MR_Vector3f *var);

MRC_API const MR_ObjectComparableWithReference_ComparisonReferenceValue *MR_ObjectComparableWithReference_ComparisonReferenceValue_OffsetPtr(const MR_ObjectComparableWithReference_ComparisonReferenceValue *ptr, ptrdiff_t i);

MRC_API MR_ObjectComparableWithReference_ComparisonReferenceValue *MR_ObjectComparableWithReference_ComparisonReferenceValue_OffsetMutablePtr(MR_ObjectComparableWithReference_ComparisonReferenceValue *ptr, ptrdiff_t i);

MRC_API MR_ObjectComparableWithReference_ComparisonReferenceValue *MR_ObjectComparableWithReference_ComparisonReferenceValue_ConstructFromAnother(const MR_ObjectComparableWithReference_ComparisonReferenceValue *_other);

MRC_API void MR_ObjectComparableWithReference_ComparisonReferenceValue_Destroy(const MR_ObjectComparableWithReference_ComparisonReferenceValue *_this);

MRC_API void MR_ObjectComparableWithReference_ComparisonReferenceValue_DestroyArray(const MR_ObjectComparableWithReference_ComparisonReferenceValue *_this);

MRC_API MR_ObjectComparableWithReference_ComparisonReferenceValue *MR_ObjectComparableWithReference_ComparisonReferenceValue_AssignFromAnother(MR_ObjectComparableWithReference_ComparisonReferenceValue *_this, const MR_ObjectComparableWithReference_ComparisonReferenceValue *_other);
 
#ifdef __cplusplus
} // extern "C"
#endif