/*
 * Go2PartStudRadius.h
 * 
 * Gocator system communication library
 * Copyright (C) 2013 by LMI Technologies Inc.
 * 
 * Licensed under The MIT License.
 * Redistributions of files must retain the above copyright notice.
 */

#ifndef LMITECH_Z_GO2PARTSTUDRADIUS_H_INCLUDED
#define LMITECH_Z_GO2PARTSTUDRADIUS_H_INCLUDED

#include <Go2Measurement.h>
#include <Go2PartTypes.h>
#include <Go2ApiBegin.h>

/*
 * Go2PartStudRadius Class 
 */

typedef Go2PartMeasurement Go2PartStudRadius;           // Represents part Go2PartStudRadius measurement configuration.

GO2_EXPORT(Go2Status) Go2PartStudRadius_SetId(Go2PartStudRadius measurement, Go2UInt32 id); //
//
//  Description:
//      Sets the unique measurement identifier for the measurement.
//  Arguments:
//      measurement - Go2PartStudRadius object. 
//      id - Unique measurement identifier. 
//  Returns:
//      Operation status. 

GO2_EXPORT(Go2UInt32) Go2PartStudRadius_Id(Go2PartStudRadius measurement); //
//
//  Description:
//      Gets the unique measurement identifier for the measurement.
//  Arguments:
//      measurement - Go2PartStudRadius object. 
//  Returns:
//      Unique measurement identifier

GO2_EXPORT(Go2Status) Go2PartStudRadius_SetName(Go2PartStudRadius measurement, const Go2Char* name); //
//
//  Description:
//      Sets the descriptive name for the measurement.
//  Arguments:
//      measurement - Go2PartStudRadius object. 
//      name - Descriptive name. 
//  Returns:
//      Operation status. 
 
GO2_EXPORT(Go2Status) Go2PartStudRadius_Name(Go2PartStudRadius measurement, Go2Char* name, Go2UInt32 capacity); //
//
//  Description:
//      Gets the descriptive name for the measurement.
//  Arguments:
//      measurement - Go2PartStudRadius object. 
//      name - Receives descriptive name. 
//      capacity - Capacity of name buffer. 
//  Returns:
//      Operation status.  

GO2_EXPORT(Go2Status) Go2PartStudRadius_SetDecisionMin(Go2PartStudRadius measurement, Go2Double min); //
//
//  Description:
//      Sets the decision threshold minimum value.
//  Arguments:
//      measurement - Go2PartStudRadius object. 
//      min - Decision threshold minimum value. 
//  Returns:
//      Operation status.
//  Remarks: 
//      A decision is said to pass if the measurement value is between the minimum and maximum thresholds.
 
GO2_EXPORT(Go2Double) Go2PartStudRadius_DecisionMin(Go2PartStudRadius measurement); //
//
//  Description:
//      Gets the decision threshold minimum value.
//  Arguments:
//      measurement - Go2PartStudRadius object. 
//  Returns:
//      Decision threshold minimum.
//  Remarks: 
//      A decision is said to pass if the measurement value is between the minimum and maximum thresholds.

GO2_EXPORT(Go2Status) Go2PartStudRadius_SetDecisionMax(Go2PartStudRadius measurement, Go2Double max); //
//
//  Description:
//      Sets the decision threshold maximum value.
//  Arguments:
//      measurement - Go2PartStudRadius object. 
//      max - Decision threshold maximum value. 
//  Returns:
//      Operation status.
//  Remarks: 
//      A decision is said to pass if the measurement value is between the minimum and maximum thresholds.
 
GO2_EXPORT(Go2Double) Go2PartStudRadius_DecisionMax(Go2PartStudRadius measurement); //
//
//  Description:
//      Gets the decision threshold maximum value.
//  Arguments:
//      measurement - Go2PartStudRadius object. 
//  Returns:
//      Decision threshold maximum.
//  Remarks: 
//      A decision is said to pass if the measurement value is between the minimum and maximum thresholds.
 
GO2_EXPORT(Go2Status) Go2PartStudRadius_EnableHold(Go2PartStudRadius measurement, Go2Bool enable); //
//
//  Description:
//      Enables measurement value hold.
//  Arguments:
//      measurement - Go2PartStudRadius object.
//      enable - GO2_TRUE to enable, or GO2_FALSE to disable.
//  Returns:
//      Operation status.

GO2_EXPORT(Go2Bool) Go2PartStudRadius_HoldEnabled(Go2PartStudRadius measurement); //
//
//  Description:
//      Reports whether value hold is currently enabled.
//  Arguments:
//      measurement - Go2PartStudRadius object. 
//  Returns:
//      GO2_TRUE if enabled, or GO2_FALSE if disabled.

GO2_EXPORT(Go2Status) Go2PartStudRadius_EnableSmoothing(Go2PartStudRadius measurement, Go2Bool enable); //
//
//  Description:
//      Enables measurement value smoothing.
//  Arguments:
//      measurement - Go2PartStudRadius object.
//      enable - GO2_TRUE to enable, or GO2_FALSE to disable.
//  Returns:
//      Operation status.

GO2_EXPORT(Go2Bool) Go2PartStudRadius_SmoothingEnabled(Go2PartStudRadius measurement); //
//
//  Description:
//      Reports whether value smoothing is currently enabled.
//  Arguments:
//      measurement - Go2PartStudRadius object. 
//  Returns:
//      GO2_TRUE if enabled, or GO2_FALSE if disabled.

GO2_EXPORT(Go2UInt32) Go2PartStudRadius_SmoothingWindowMin(Go2PartStudRadius measurement); //
//
//  Description:
//      Gets the minimum smoothing window value.
//  Arguments:
//      measurement - Go2PartStudRadius object. 
//  Returns:
//      Minimum smoothing window value.

GO2_EXPORT(Go2UInt32) Go2PartStudRadius_SmoothingWindowMax(Go2PartStudRadius measurement); //
//
//  Description:
//      Gets the maximum smoothing window value.
//  Arguments:
//      measurement - Go2PartStudRadius object. 
//  Returns:
//      Maximum smoothing window value.

GO2_EXPORT(Go2Status) Go2PartStudRadius_SetSmoothingWindow(Go2PartStudRadius measurement, Go2UInt32 window); //
//
//  Description:
//      Sets the smoothing window value.
//  Arguments:
//      measurement - Go2PartStudRadius object. 
//      window - Smoothing window value.
//  Returns:
//      Operation status.

GO2_EXPORT(Go2UInt32) Go2PartStudRadius_SmoothingWindow(Go2PartStudRadius measurement); //
//
//  Description:
//      Gets the smoothing window value.
//  Arguments:
//      measurement - Go2PartStudRadius object. 
//  Returns:
//      Smoothing window value.

GO2_EXPORT(Go2Status) Go2PartStudRadius_EnableLink(Go2PartStudRadius measurement, Go2Bool enable); //
//
//  Description:
//      Enables measurement linking.  When enabled, another measurement of the same base type can be 
//      linked, provided that it is a different measurement.  
//  Arguments:
//      measurement - Go2PartStudRadius object. 
//      enable - GO2_TRUE to enable, or GO2_FALSE to disable.
//  Returns:
//      Operation status.
 
GO2_EXPORT(Go2Bool) Go2PartStudRadius_LinkEnabled(Go2PartStudRadius measurement); //
//
//  Description:
//      Reports whether measurement linking is enabled.
//  Arguments:
//      measurement - Go2PartStudRadius object. 
//  Returns:
//      GO2_TRUE if system operates at full frame rate; GO2_FALSE otherwise.

GO2_EXPORT(Go2Status) Go2PartStudRadius_SetLink(Go2PartStudRadius measurement, Go2UInt32 link); //
//
//  Description:
//      Sets the measurement id to which this measurement should link. Linked measurements must:
//          -link to a valid measurement id
//          -not link to themselves
//          -not link to a measurement that is already linked
//          -link only to measurements of the same basic type (eg, all PartStud_? measurements)
//  Arguments:
//      measurement - Go2PartStudRadius object. 
//      link - Measurement id to link to.
//  Returns:
//      Operation status.

GO2_EXPORT(Go2UInt32) Go2PartStudRadius_Link(Go2PartStudRadius measurement); //
//
//  Description:
//      Gets the measurement id of the linked measurement.
//  Arguments:
//      measurement - Go2PartStudRadius object. 
//  Returns:
//      The linked measurement ID.

GO2_EXPORT(Go2PartRegion3d) Go2PartStudRadius_Region(Go2PartStudRadius measurement); //
//
//  Description:
//      Gets the region object which defines the measurement's ROI. 
//  Arguments:
//      measurement - Go2PartStudRadius object. 
//  Returns:
//      Region object.

GO2_EXPORT(Go2UInt32) Go2PartStudRadius_RefRegionCount(Go2PartStudRadius measurement); //
//
//  Description:
//      Gets the number of reference regions. 
//  Arguments:
//      measurement - Go2PartStudRadius object. 
//  Returns:
//      Number of regions.

GO2_EXPORT(Go2Status) Go2PartStudRadius_SetRefRegionCount(Go2PartStudRadius measurement, Go2UInt32 count); //
//
//  Description:
//      Sets the number of reference regions to use. 
//  Arguments:
//      measurement - Go2PartStudRadius object. 
//      count - Number of regions.
//  Returns:
//      Operation status.

GO2_EXPORT(Go2PartRegion2d) Go2PartStudRadius_RefRegionAt(Go2PartStudRadius measurement, Go2UInt32 index); //
//
//  Description:
//      Gets the reference region object at the specified index. 
//  Arguments:
//      measurement - Go2PartStudRadius object. 
//      index - Index of the desired area.
//  Returns:
//      Region object.

GO2_EXPORT(Go2Double) Go2PartStudRadius_StudRadius(Go2PartStudRadius measurement); //
//
//  Description:
//      Gets the radius of the stud to measure.
//  Arguments:
//      measurement - Go2PartStudRadius object. 
//  Returns:
//      Radius of the stud (mm).

GO2_EXPORT(Go2Status) Go2PartStudRadius_SetStudRadius(Go2PartStudRadius measurement, Go2Double radius); //
//
//  Description:
//      Sets the radius of the stud to measure.
//  Arguments:
//      measurement - Go2PartStudRadius object. 
//      radius - Radius of the stud (mm).
//  Returns:
//      Operation status.

GO2_EXPORT(Go2Double) Go2PartStudRadius_StudHeight(Go2PartStudRadius measurement); //
//
//  Description:
//      Gets the height of the stud to measure.
//  Arguments:
//      measurement - Go2PartStudRadius object. 
//  Returns:
//      Height of the stud (mm).

GO2_EXPORT(Go2Status) Go2PartStudRadius_SetStudHeight(Go2PartStudRadius measurement, Go2Double height); //
//
//  Description:
//      Sets the height of the stud to measure.
//  Arguments:
//      measurement - Go2PartStudRadius object. 
//      height - Height of the stud (mm).
//  Returns:
//      Operation status.

GO2_EXPORT(Go2Double) Go2PartStudRadius_BaseHeight(Go2PartStudRadius measurement); //
//
//  Description:
//      Gets the height of the base of the stud.
//  Arguments:
//      measurement - Go2PartStudRadius object. 
//  Returns:
//      Base height (mm).

GO2_EXPORT(Go2Status) Go2PartStudRadius_SetBaseHeight(Go2PartStudRadius measurement, Go2Double height); //
//
//  Description:
//      Sets the height of the base of the stud.
//  Arguments:
//      measurement - Go2PartStudRadius object. 
//      height - Base height (mm).
//  Returns:
//      Operation status.

GO2_EXPORT(Go2Double) Go2PartStudRadius_TipHeight(Go2PartStudRadius measurement); //
//
//  Description:
//      Gets the height of the tip of the stud.
//  Arguments:
//      measurement - Go2PartStudRadius object. 
//  Returns:
//      Tip height (mm).

GO2_EXPORT(Go2Status) Go2PartStudRadius_SetTipHeight(Go2PartStudRadius measurement, Go2Double height); //
//
//  Description:
//      Sets the height of the tip of the stud.
//  Arguments:
//      measurement - Go2PartStudRadius object. 
//      height - Tip height (mm).
//  Returns:
//      Operation status.

GO2_EXPORT(Go2Double) Go2PartStudRadius_RadiusOffset(Go2PartStudRadius measurement); //
//
//  Description:
//      Gets the specified distance along the stud from which to measure the radius.
//  Arguments:
//      measurement - Go2PartStudRadius object. 
//  Returns:
//      Radius offset.
//  Remarks:
//      The offset is specified as the distance from the base to the tip, and must be set to a 
//      value lower the configured StudHeight.

GO2_EXPORT(Go2Status) Go2PartStudRadius_SetRadiusOffset(Go2PartStudRadius measurement, Go2Double offset); //
//
//  Description:
//      Sets the specified distance along the stud from which to measure the radius.
//  Arguments:
//      measurement - Go2PartStudRadius object. 
//      offset - Radius offset.
//  Returns:
//      Operation status.
//  Remarks:
//      The offset is specified as the distance from the base to the tip, and must be set to a 
//      value lower the configured StudHeight.

GO2_EXPORT(Go2Bool) Go2PartStudRadius_AutoRefRegionEnabled(Go2PartStudRadius measurement); //
//
//  Description:
//      Reports whether auto reference regions are enabled.
//  Arguments:
//      measurement - Go2PartStudRadius object. 
//  Returns:
//      A boolean representing whether the auto reference region is enabled (1 - true, 0 - false).

GO2_EXPORT(Go2Status) Go2PartStudRadius_EnableAutoRefRegion(Go2PartStudRadius measurement, Go2Bool enable); //
//
//  Description:
//      Enables or disables auto reference regions.
//  Arguments:
//      measurement - Go2PartStudRadius object. 
//      enable - GO2_TRUE enables auto reference regions, while GO2_FALSE disables them
//  Returns:
//      Operation status.

GO2_EXPORT(Go2Bool) Go2PartStudRadius_AutoTiltCorrectionEnabled(Go2PartStudRadius measurement); //
//
//  Description:
//      Reports whether auto tilt correction is enabled.
//  Arguments:
//      measurement - Go2PartStudRadius object. 
//  Returns:
//      A boolean representing whether the auto reference region is enabled (1 - true, 0 - false).

GO2_EXPORT(Go2Status) Go2PartStudRadius_EnableAutoTiltCorrection(Go2PartStudRadius measurement, Go2Bool enable); //
//
//  Description:
//      Enables or disables auto tilt correction.
//  Arguments:
//      measurement - Go2PartStudRadius object. 
//      enable - GO2_TRUE enables auto reference regions, while GO2_FALSE disables them
//  Returns:
//      Operation status.

GO2_EXPORT(Go2Double) Go2PartStudRadius_TiltXAngle(Go2PartStudRadius measurement); //
//
//  Description:
//      Gets the X axis tilt angle.
//  Arguments:
//      measurement - Go2PartStudRadius object. 
//  Returns:
//      Tilt angle along X axis (degrees).

GO2_EXPORT(Go2Status) Go2PartStudRadius_SetTiltXAngle(Go2PartStudRadius measurement, Go2Double tiltXAngle); //
//
//  Description:
//      Sets the X axis tilt angle.
//  Arguments:
//      measurement - Go2PartStudRadius object. 
//      tiltXAngle - tilt angle along X axis(degrees).  If it exceeds an internal reasonable range, it will be clamped to the boundary value of said range.
//  Returns:
//      Operation status.

GO2_EXPORT(Go2Double) Go2PartStudRadius_TiltYAngle(Go2PartStudRadius measurement); //
//
//  Description:
//      Gets the Y axis tilt angle.
//  Arguments:
//      measurement - Go2PartStudRadius object. 
//  Returns:
//      Tilt angle along Y axis (degrees).

GO2_EXPORT(Go2Status) Go2PartStudRadius_SetTiltYAngle(Go2PartStudRadius measurement, Go2Double tiltYAngle); //
//
//  Description:
//      Sets the Y axis tilt angle.
//  Arguments:
//      measurement - Go2PartStudRadius object. 
//      tiltYAngle - tilt angle along Y axis(degrees).  If it exceeds an internal reasonable range, it will be clamped to the boundary value of said range.
//  Returns:
//      Operation status.



GO2_EXPORT(Go2Double) Go2PartStudRadius_Offset(Go2PartStudRadius measurement); //
//
//  Description:
//      Gets the measurement value offset.
//  Arguments:
//      measurement - Go2PartStudRadius object.
//  Returns:
//      Measurement value offset.

GO2_EXPORT(Go2Status) Go2PartStudRadius_SetOffset(Go2PartStudRadius measurement, Go2Double offset); //
//
//  Description:
//      Sets the measurement value offset.
//  Arguments:
//      measurement - Go2PartStudRadius object.
//      offset - Offset factor.
//  Returns:
//      Operation status.

GO2_EXPORT(Go2Double) Go2PartStudRadius_Scale(Go2PartStudRadius measurement); //
//
//  Description:
//      Gets the measurement value scale factor.
//  Arguments:
//      measurement - Go2PartStudRadius object.
//  Returns:
//      Measurement value scale factor.

GO2_EXPORT(Go2Status) Go2PartStudRadius_SetScale(Go2PartStudRadius measurement, Go2Double scale); //
//
//  Description:
//      Sets the measurement value scale factor.
//  Arguments:
//      measurement - Go2PartStudRadius object.
//      scale - Scale factor.
//  Returns:
//      Operation status.

GO2_EXPORT(Go2Status) Go2PartStudRadius_EnableRefRegions(Go2PartStudRadius measurement, Go2Bool enable); //
//
//  Description:
//      Enables or disables the optional reference region.
//  Arguments:
//      measurement - Go2PartStudRadius object.
//      enable - Use GO2_TRUE to enable the optional reference region and GO2_FALSE to disable it.
//  Returns:
//      Operation status.

GO2_EXPORT(Go2Bool) Go2PartStudRadius_RefRegionsEnabled(Go2PartStudRadius measurement); //
//
//  Description:
//      Returns the current state of the optional reference region.
//  Arguments:
//      measurement - Go2PartStudRadius object.
//  Returns:
//      GO2_TRUE if the optional reference region is enabled and GO2_FALSE if it is disabled.

GO2_EXPORT(Go2Bool) Go2PartStudRadius_RegionEnabled(Go2PartStudRadius measurement);   //
//
//  Description:
//      Returns the current state of the optional region.
//  Arguments:
//      measurement - Go2PartStudRadius object.
//  Returns:
//      GO2_TRUE if the optional region is enabled and GO2_FALSE if it is disabled.

GO2_EXPORT(Go2Status) Go2PartStudRadius_EnableRegion(Go2PartStudRadius measurement, Go2Bool enable);   //
//
//  Description:
//      Enables or disables the optional region.
//  Arguments:
//      measurement - Go2PartStudRadius object.
//      enable - Use GO2_TRUE to enable the optional region and GO2_FALSE to disable it.
//  Returns:
//      Operation status.

GO2_EXPORT(Go2UInt32) Go2PartStudRadius_LinkOptionAt(Go2PartStudRadius measurement, Go2UInt32 index); //
//
//  Description:
//      Gets the link-able measurement id at the specified index. 
//    Arguments:
//      measurement - Go2PartMeasurement object.
//  Returns:
//      The link-able measurement ID at the specified index.

GO2_EXPORT(Go2UInt32) Go2PartStudRadius_LinkOptionCount(Go2PartStudRadius measurement); //
//
//  Description:
//      Gets the number of link-able measurement IDs.
//  Arguments:
//      measurement - Go2PartMeasurement object.
//  Returns:
//      The link-able measurement count.

#include <Go2ApiEnd.h>

#endif      /* #ifndef LMITECH_GO2_PART_MEASUREMENTS_H_INCLUDED */
