meshlib.ObjectComparableWithReference Class Reference

Inheritance diagram for meshlib.ObjectComparableWithReference:

Public Member Functions
	ObjectComparableWithReference (java.lang.foreign.MemorySegment ptr, boolean owned, java.lang.Object owner)
long	numComparableProperties ()
meshlib.std_string_view	getComparablePropertyName (long i)
meshlib.std_optional_MR_ObjectComparableWithReference_ComparableProperty	computeComparableProperty (long i)
meshlib.std_optional_MR_ObjectComparableWithReference_ComparisonTolerance	getComparisonTolerence (long i)
void	setComparisonTolerance (long i, meshlib.ObjectComparableWithReference_ComparisonTolerance newTolerance)
boolean	comparisonToleranceIsAlwaysOnlyPositive (long i)
long	numComparisonReferenceValues ()
meshlib.std_string_view	getComparisonReferenceValueName (long i)
meshlib.ObjectComparableWithReference_ComparisonReferenceValue	getComparisonReferenceValue (long i)
void	setComparisonReferenceValue (long i, meshlib.std_variant_float_MR_Vector3f value)
void	setComparisonReferenceVal (long i, meshlib.ObjectComparableWithReference_ComparisonReferenceValue value)
Public Member Functions inherited from meshlib.CppObject
final java.lang.foreign.MemorySegment	rawPointer ()
final boolean	isOwned ()
final void	close ()
final java.lang.foreign.MemorySegment	release ()

Additional Inherited Members
Protected Member Functions inherited from meshlib.CppObject
	CppObject (java.lang.foreign.MemorySegment ptr, java.util.function.Consumer< java.lang.foreign.MemorySegment > destroy, java.lang.Object owner)

Detailed Description

A base class for a data-model object that is a feature/measurement that can be compared between two models. Generated from class MR::ObjectComparableWithReference. Derived classes: Direct: (non-virtual) MR::DistanceMeasurementObject MR::PointMeasurementObject

Instances created here own their C++ objects, see CppObject.

Constructor & Destructor Documentation

ObjectComparableWithReference()

meshlib.ObjectComparableWithReference.ObjectComparableWithReference	(	java.lang.foreign.MemorySegment	ptr,
		boolean	owned,
		java.lang.Object	owner )

Wraps a pointer from the C bindings. If owned, the object is destroyed when the wrapper dies. owner is kept alive as long as this wrapper is. Not for normal use.

Member Function Documentation

comparisonToleranceIsAlwaysOnlyPositive()

boolean meshlib.ObjectComparableWithReference.comparisonToleranceIsAlwaysOnlyPositive

(

long

i

)

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. Generated from method MR::ObjectComparableWithReference::comparisonToleranceIsAlwaysOnlyPositive.

Calls MR_ObjectComparableWithReference_comparisonToleranceIsAlwaysOnlyPositive().

computeComparableProperty()

meshlib.std_optional_MR_ObjectComparableWithReference_ComparableProperty meshlib.ObjectComparableWithReference.computeComparableProperty

(

long

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. Generated from method MR::ObjectComparableWithReference::computeComparableProperty.

Calls MR_ObjectComparableWithReference_computeComparableProperty().

getComparablePropertyName()

meshlib.std_string_view meshlib.ObjectComparableWithReference.getComparablePropertyName

(

long

i

)

i goes up to numComparableProperties(), exclusive. Generated from method MR::ObjectComparableWithReference::getComparablePropertyName.

Calls MR_ObjectComparableWithReference_getComparablePropertyName().

getComparisonReferenceValue()

meshlib.ObjectComparableWithReference_ComparisonReferenceValue meshlib.ObjectComparableWithReference.getComparisonReferenceValue

(

long

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. Generated from method MR::ObjectComparableWithReference::getComparisonReferenceValue.

Calls MR_ObjectComparableWithReference_getComparisonReferenceValue().

getComparisonReferenceValueName()

meshlib.std_string_view meshlib.ObjectComparableWithReference.getComparisonReferenceValueName

(

long

i

)

i goes up to numComparisonReferenceValues(), exclusive. Generated from method MR::ObjectComparableWithReference::getComparisonReferenceValueName.

Calls MR_ObjectComparableWithReference_getComparisonReferenceValueName().

getComparisonTolerence()

meshlib.std_optional_MR_ObjectComparableWithReference_ComparisonTolerance meshlib.ObjectComparableWithReference.getComparisonTolerence

(

long

i

)

Returns the tolerance for a specific comparable property. Returns null if not set. i goes up to numComparableProperties(), exclusive. Generated from method MR::ObjectComparableWithReference::getComparisonTolerence.

Calls MR_ObjectComparableWithReference_getComparisonTolerence().

numComparableProperties()

long meshlib.ObjectComparableWithReference.numComparableProperties

(

)

When comparing this object with a reference, how many different properties can we output? Generated from method MR::ObjectComparableWithReference::numComparableProperties.

Calls MR_ObjectComparableWithReference_numComparableProperties().

numComparisonReferenceValues()

long meshlib.ObjectComparableWithReference.numComparisonReferenceValues

(

)

The number and types of reference values can be entirely different compared to numComparableProperties(). Generated from method MR::ObjectComparableWithReference::numComparisonReferenceValues.

Calls MR_ObjectComparableWithReference_numComparisonReferenceValues().

setComparisonReferenceVal()

void meshlib.ObjectComparableWithReference.setComparisonReferenceVal	(	long	i,
		meshlib.ObjectComparableWithReference_ComparisonReferenceValue	value )

Generated from method MR::ObjectComparableWithReference::setComparisonReferenceVal.

Calls MR_ObjectComparableWithReference_setComparisonReferenceVal().

setComparisonReferenceValue()

void meshlib.ObjectComparableWithReference.setComparisonReferenceValue	(	long	i,
		meshlib.std_variant_float_MR_Vector3f	value )

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. Generated from method MR::ObjectComparableWithReference::setComparisonReferenceValue.

Calls MR_ObjectComparableWithReference_setComparisonReferenceValue().

setComparisonTolerance()

void meshlib.ObjectComparableWithReference.setComparisonTolerance	(	long	i,
		meshlib.ObjectComparableWithReference_ComparisonTolerance	newTolerance )

Sets the tolerance for a specific comparable property. i goes up to numComparableProperties(), exclusive. Generated from method MR::ObjectComparableWithReference::setComparisonTolerance.

Calls MR_ObjectComparableWithReference_setComparisonTolerance().

---

The documentation for this class was generated from the following file:

• ObjectComparableWithReference.java