MRUnitInfo.h File Reference

#include <MRCMisc/exports.h>
#include <stddef.h>

Go to the source code of this file.

Typedefs
typedef struct MR_std_string_view	MR_std_string_view
typedef enum MR_NoUnit	MR_NoUnit
typedef enum MR_LengthUnit	MR_LengthUnit
typedef enum MR_AngleUnit	MR_AngleUnit
typedef enum MR_PixelSizeUnit	MR_PixelSizeUnit
typedef enum MR_RatioUnit	MR_RatioUnit
typedef enum MR_TimeUnit	MR_TimeUnit
typedef enum MR_MovementSpeedUnit	MR_MovementSpeedUnit
typedef enum MR_AreaUnit	MR_AreaUnit
typedef enum MR_VolumeUnit	MR_VolumeUnit
typedef enum MR_InvLengthUnit	MR_InvLengthUnit
typedef struct MR_UnitInfo	MR_UnitInfo
	Generated from class MR::UnitInfo.

Enumerations
enum	MR_NoUnit { MR_NoUnit__count = 0 }
enum	MR_LengthUnit {   MR_LengthUnit_microns = 0 , MR_LengthUnit_millimeters = 1 , MR_LengthUnit_centimeters = 2 , MR_LengthUnit_meters = 3 ,   MR_LengthUnit_inches = 4 , MR_LengthUnit_feet = 5 , MR_LengthUnit__count = 6 }
enum	MR_AngleUnit { MR_AngleUnit_radians = 0 , MR_AngleUnit_degrees = 1 , MR_AngleUnit__count = 2 }
enum	MR_PixelSizeUnit { MR_PixelSizeUnit_pixels = 0 , MR_PixelSizeUnit__count = 1 }
enum	MR_RatioUnit { MR_RatioUnit_factor = 0 , MR_RatioUnit_percents = 1 , MR_RatioUnit__count = 2 }
enum	MR_TimeUnit { MR_TimeUnit_seconds = 0 , MR_TimeUnit_milliseconds = 1 , MR_TimeUnit__count = 2 }
enum	MR_MovementSpeedUnit {   MR_MovementSpeedUnit_micronsPerSecond = 0 , MR_MovementSpeedUnit_millimetersPerSecond = 1 , MR_MovementSpeedUnit_centimetersPerSecond = 2 , MR_MovementSpeedUnit_metersPerSecond = 3 ,   MR_MovementSpeedUnit_inchesPerSecond = 4 , MR_MovementSpeedUnit_feetPerSecond = 5 , MR_MovementSpeedUnit__count = 6 }
enum	MR_AreaUnit {   MR_AreaUnit_microns2 = 0 , MR_AreaUnit_millimeters2 = 1 , MR_AreaUnit_centimeters2 = 2 , MR_AreaUnit_meters2 = 3 ,   MR_AreaUnit_inches2 = 4 , MR_AreaUnit_feet2 = 5 , MR_AreaUnit__count = 6 }
enum	MR_VolumeUnit {   MR_VolumeUnit_microns3 = 0 , MR_VolumeUnit_millimeters3 = 1 , MR_VolumeUnit_centimeters3 = 2 , MR_VolumeUnit_meters3 = 3 ,   MR_VolumeUnit_inches3 = 4 , MR_VolumeUnit_feet3 = 5 , MR_VolumeUnit__count = 6 }
enum	MR_InvLengthUnit {   MR_InvLengthUnit_inv_microns = 0 , MR_InvLengthUnit_inv_millimeters = 1 , MR_InvLengthUnit_inv_centimeters = 2 , MR_InvLengthUnit_inv_meters = 3 ,   MR_InvLengthUnit_inv_inches = 4 , MR_InvLengthUnit_inv_feet = 5 , MR_InvLengthUnit__count = 6 }

Functions
MRC_API const float *	MR_UnitInfo_Get_conversionFactor (const MR_UnitInfo *_this)
MRC_API void	MR_UnitInfo_Set_conversionFactor (MR_UnitInfo *_this, float value)
MRC_API float *	MR_UnitInfo_GetMutable_conversionFactor (MR_UnitInfo *_this)
MRC_API const MR_std_string_view *	MR_UnitInfo_Get_prettyName (const MR_UnitInfo *_this)
MRC_API void	MR_UnitInfo_Set_prettyName (MR_UnitInfo *_this, const char *value, const char *value_end)
MRC_API MR_std_string_view *	MR_UnitInfo_GetMutable_prettyName (MR_UnitInfo *_this)
MRC_API const MR_std_string_view *	MR_UnitInfo_Get_unitSuffix (const MR_UnitInfo *_this)
MRC_API void	MR_UnitInfo_Set_unitSuffix (MR_UnitInfo *_this, const char *value, const char *value_end)
MRC_API MR_std_string_view *	MR_UnitInfo_GetMutable_unitSuffix (MR_UnitInfo *_this)
MRC_API MR_UnitInfo *	MR_UnitInfo_DefaultConstruct (void)
MRC_API MR_UnitInfo *	MR_UnitInfo_DefaultConstructArray (size_t num_elems)
MRC_API MR_UnitInfo *	MR_UnitInfo_ConstructFrom (float conversionFactor, const char *prettyName, const char *prettyName_end, const char *unitSuffix, const char *unitSuffix_end)
MRC_API const MR_UnitInfo *	MR_UnitInfo_OffsetPtr (const MR_UnitInfo *ptr, ptrdiff_t i)
	Offsets a pointer to an array element by i positions (not bytes). Use only if you're certain that the pointer points to an array element.
MRC_API MR_UnitInfo *	MR_UnitInfo_OffsetMutablePtr (MR_UnitInfo *ptr, ptrdiff_t i)
	Offsets a pointer to an array element by i positions (not bytes). Use only if you're certain that the pointer points to an array element.
MRC_API MR_UnitInfo *	MR_UnitInfo_ConstructFromAnother (const MR_UnitInfo *_other)
MRC_API void	MR_UnitInfo_Destroy (const MR_UnitInfo *_this)
	Destroys a heap-allocated instance of MR_UnitInfo. Does nothing if the pointer is null.
MRC_API void	MR_UnitInfo_DestroyArray (const MR_UnitInfo *_this)
	Destroys a heap-allocated array of MR_UnitInfo. Does nothing if the pointer is null.
MRC_API MR_UnitInfo *	MR_UnitInfo_AssignFromAnother (MR_UnitInfo *_this, const MR_UnitInfo *_other)

Typedef Documentation

MR_AngleUnit

typedef enum MR_AngleUnit MR_AngleUnit

MR_AreaUnit

typedef enum MR_AreaUnit MR_AreaUnit

MR_InvLengthUnit

typedef enum MR_InvLengthUnit MR_InvLengthUnit

MR_LengthUnit

typedef enum MR_LengthUnit MR_LengthUnit

MR_MovementSpeedUnit

typedef enum MR_MovementSpeedUnit MR_MovementSpeedUnit

MR_NoUnit

typedef enum MR_NoUnit MR_NoUnit

MR_PixelSizeUnit

typedef enum MR_PixelSizeUnit MR_PixelSizeUnit

MR_RatioUnit

typedef enum MR_RatioUnit MR_RatioUnit

MR_std_string_view

typedef struct MR_std_string_view MR_std_string_view

MR_TimeUnit

typedef enum MR_TimeUnit MR_TimeUnit

MR_UnitInfo

typedef struct MR_UnitInfo MR_UnitInfo

Generated from class MR::UnitInfo.

MR_VolumeUnit

typedef enum MR_VolumeUnit MR_VolumeUnit

Enumeration Type Documentation

MR_AngleUnit

enum MR_AngleUnit

Enumerator
MR_AngleUnit_radians
MR_AngleUnit_degrees
MR_AngleUnit__count

MR_AreaUnit

enum MR_AreaUnit

Enumerator
MR_AreaUnit_microns2
MR_AreaUnit_millimeters2
MR_AreaUnit_centimeters2
MR_AreaUnit_meters2
MR_AreaUnit_inches2
MR_AreaUnit_feet2
MR_AreaUnit__count

MR_InvLengthUnit

enum MR_InvLengthUnit

Enumerator
MR_InvLengthUnit_inv_microns
MR_InvLengthUnit_inv_millimeters
MR_InvLengthUnit_inv_centimeters
MR_InvLengthUnit_inv_meters
MR_InvLengthUnit_inv_inches
MR_InvLengthUnit_inv_feet
MR_InvLengthUnit__count

MR_LengthUnit

enum MR_LengthUnit

Enumerator
MR_LengthUnit_microns
MR_LengthUnit_millimeters
MR_LengthUnit_centimeters
MR_LengthUnit_meters
MR_LengthUnit_inches
MR_LengthUnit_feet
MR_LengthUnit__count

MR_MovementSpeedUnit

enum MR_MovementSpeedUnit

Enumerator
MR_MovementSpeedUnit_micronsPerSecond
MR_MovementSpeedUnit_millimetersPerSecond
MR_MovementSpeedUnit_centimetersPerSecond
MR_MovementSpeedUnit_metersPerSecond
MR_MovementSpeedUnit_inchesPerSecond
MR_MovementSpeedUnit_feetPerSecond
MR_MovementSpeedUnit__count

MR_NoUnit

enum MR_NoUnit

Enumerator
MR_NoUnit__count

MR_PixelSizeUnit

enum MR_PixelSizeUnit

Enumerator
MR_PixelSizeUnit_pixels
MR_PixelSizeUnit__count

MR_RatioUnit

enum MR_RatioUnit

Enumerator
MR_RatioUnit_factor
MR_RatioUnit_percents
MR_RatioUnit__count

MR_TimeUnit

enum MR_TimeUnit

Enumerator
MR_TimeUnit_seconds
MR_TimeUnit_milliseconds
MR_TimeUnit__count

MR_VolumeUnit

enum MR_VolumeUnit

Enumerator
MR_VolumeUnit_microns3
MR_VolumeUnit_millimeters3
MR_VolumeUnit_centimeters3
MR_VolumeUnit_meters3
MR_VolumeUnit_inches3
MR_VolumeUnit_feet3
MR_VolumeUnit__count

Function Documentation

MR_UnitInfo_AssignFromAnother()

MRC_API MR_UnitInfo * MR_UnitInfo_AssignFromAnother	(	MR_UnitInfo *	_this,
		const MR_UnitInfo *	_other )

Generated from a method of class MR::UnitInfo named operator=. Parameter _this can not be null. It is a single object. Parameter _other can not be null. It is a single object. The returned pointer will never be null. It is non-owning, do NOT destroy it.

MR_UnitInfo_ConstructFrom()

MRC_API MR_UnitInfo * MR_UnitInfo_ConstructFrom	(	float	conversionFactor,
		const char *	prettyName,
		const char *	prettyName_end,
		const char *	unitSuffix,
		const char *	unitSuffix_end )

Constructs MR::UnitInfo elementwise. Parameter prettyName can not be null. If prettyName_end is null, then prettyName is assumed to be null-terminated. Parameter unitSuffix can not be null. If unitSuffix_end is null, then unitSuffix is assumed to be null-terminated. Never returns null. Returns an instance allocated on the heap! Must call MR_UnitInfo_Destroy() to free it when you're done using it.

MR_UnitInfo_ConstructFromAnother()

MRC_API MR_UnitInfo * MR_UnitInfo_ConstructFromAnother

(

const MR_UnitInfo *

_other

)

Generated from a constructor of class MR::UnitInfo. Parameter _other can not be null. It is a single object. Never returns null. Returns an instance allocated on the heap! Must call MR_UnitInfo_Destroy() to free it when you're done using it.

MR_UnitInfo_DefaultConstruct()

MRC_API MR_UnitInfo * MR_UnitInfo_DefaultConstruct

(

void

)

Constructs an empty (default-constructed) instance. Never returns null. Returns an instance allocated on the heap! Must call MR_UnitInfo_Destroy() to free it when you're done using it.

MR_UnitInfo_DefaultConstructArray()

MRC_API MR_UnitInfo * MR_UnitInfo_DefaultConstructArray

(

size_t

num_elems

)

Constructs an array of empty (default-constructed) instances, of the specified size. Will never return null. The array must be destroyed using MR_UnitInfo_DestroyArray(). Use MR_UnitInfo_OffsetMutablePtr() and MR_UnitInfo_OffsetPtr() to access the array elements.

MR_UnitInfo_Destroy()

MRC_API void MR_UnitInfo_Destroy

(

const MR_UnitInfo *

_this

)

Destroys a heap-allocated instance of MR_UnitInfo. Does nothing if the pointer is null.

MR_UnitInfo_DestroyArray()

MRC_API void MR_UnitInfo_DestroyArray

(

const MR_UnitInfo *

_this

)

Destroys a heap-allocated array of MR_UnitInfo. Does nothing if the pointer is null.

MR_UnitInfo_Get_conversionFactor()

MRC_API const float * MR_UnitInfo_Get_conversionFactor

(

const MR_UnitInfo *

_this

)

Returns a pointer to a member variable of class MR::UnitInfo named conversionFactor. Parameter _this can not be null. It is a single object. The returned pointer will never be null. It is non-owning, do NOT destroy it.

MR_UnitInfo_Get_prettyName()

MRC_API const MR_std_string_view * MR_UnitInfo_Get_prettyName

(

const MR_UnitInfo *

_this

)

Returns a pointer to a member variable of class MR::UnitInfo named prettyName. Parameter _this can not be null. It is a single object. The returned pointer will never be null. It is non-owning, do NOT destroy it.

MR_UnitInfo_Get_unitSuffix()

MRC_API const MR_std_string_view * MR_UnitInfo_Get_unitSuffix

(

const MR_UnitInfo *

_this

)

Returns a pointer to a member variable of class MR::UnitInfo named unitSuffix. Parameter _this can not be null. It is a single object. The returned pointer will never be null. It is non-owning, do NOT destroy it.

MR_UnitInfo_GetMutable_conversionFactor()

MRC_API float * MR_UnitInfo_GetMutable_conversionFactor

(

MR_UnitInfo *

_this

)

Returns a mutable pointer to a member variable of class MR::UnitInfo named conversionFactor. Parameter _this can not be null. It is a single object. The returned pointer will never be null. It is non-owning, do NOT destroy it.

MR_UnitInfo_GetMutable_prettyName()

MRC_API MR_std_string_view * MR_UnitInfo_GetMutable_prettyName

(

MR_UnitInfo *

_this

)

Returns a mutable pointer to a member variable of class MR::UnitInfo named prettyName. Parameter _this can not be null. It is a single object. The returned pointer will never be null. It is non-owning, do NOT destroy it.

MR_UnitInfo_GetMutable_unitSuffix()

MRC_API MR_std_string_view * MR_UnitInfo_GetMutable_unitSuffix

(

MR_UnitInfo *

_this

)

Returns a mutable pointer to a member variable of class MR::UnitInfo named unitSuffix. Parameter _this can not be null. It is a single object. The returned pointer will never be null. It is non-owning, do NOT destroy it.

MR_UnitInfo_OffsetMutablePtr()

MRC_API MR_UnitInfo * MR_UnitInfo_OffsetMutablePtr	(	MR_UnitInfo *	ptr,
		ptrdiff_t	i )

Offsets a pointer to an array element by i positions (not bytes). Use only if you're certain that the pointer points to an array element.

MR_UnitInfo_OffsetPtr()

MRC_API const MR_UnitInfo * MR_UnitInfo_OffsetPtr	(	const MR_UnitInfo *	ptr,
		ptrdiff_t	i )

Offsets a pointer to an array element by i positions (not bytes). Use only if you're certain that the pointer points to an array element.

MR_UnitInfo_Set_conversionFactor()

MRC_API void MR_UnitInfo_Set_conversionFactor	(	MR_UnitInfo *	_this,
		float	value )

Modifies a member variable of class MR::UnitInfo named conversionFactor. Parameter _this can not be null. It is a single object.

MR_UnitInfo_Set_prettyName()

MRC_API void MR_UnitInfo_Set_prettyName	(	MR_UnitInfo *	_this,
		const char *	value,
		const char *	value_end )

Modifies a member variable of class MR::UnitInfo named prettyName. Parameter _this can not be null. It is a single object. Parameter value can not be null. If value_end is null, then value is assumed to be null-terminated.

MR_UnitInfo_Set_unitSuffix()

MRC_API void MR_UnitInfo_Set_unitSuffix	(	MR_UnitInfo *	_this,
		const char *	value,
		const char *	value_end )

Modifies a member variable of class MR::UnitInfo named unitSuffix. Parameter _this can not be null. It is a single object. Parameter value can not be null. If value_end is null, then value is assumed to be null-terminated.