/*
 * Go2ProfileGrooveZ.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_GO2PROFILEGROOVEZ_H_INCLUDED
#define LMITECH_Z_GO2PROFILEGROOVEZ_H_INCLUDED

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

/*
 * Go2ProfileGrooveZ Class 
 */

typedef Go2Measurement Go2ProfileGrooveZ;           // Represents profile groove minimum point Z-value measurement configuration.

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

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

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

GO2_EXPORT(Go2UInt32) Go2ProfileGrooveZ_SourceOptionCount(Go2ProfileGrooveZ measurement); //
//
//  Description:
//      Gets the number of profile source options for the measurement.
//  Arguments:
//      measurement - Go2ProfileGrooveZ object. 
//  Returns:
//      Count of source options.

GO2_EXPORT(Go2ProfileSource) Go2ProfileGrooveZ_SourceOptionAt(Go2ProfileGrooveZ measurement, Go2UInt32 index); //
//
//  Description:
//      Gets the profile source option at the specified index.
//  Arguments:
//      measurement - Go2ProfileGrooveZ object. 
//      index - Selected profile source option.
//  Returns:
//      Profile source option. 

GO2_EXPORT(Go2Status) Go2ProfileGrooveZ_SetSource(Go2ProfileGrooveZ measurement, Go2ProfileSource source); //
//
//  Description:
//      Sets the source for profile data used in this measurement.
//  Arguments:
//      measurement - Go2ProfileGrooveZ object. 
//      source - Profile source.
//  Returns:
//      Operation status.

GO2_EXPORT(Go2ProfileSource) Go2ProfileGrooveZ_Source(Go2ProfileGrooveZ measurement); //
//
//  Description:
//      Gets the source for profile data used in this measurement.
//  Arguments:
//      measurement - Go2ProfileGrooveZ object. 
//  Returns: 
//      Profile source. 
 
GO2_EXPORT(Go2Status) Go2ProfileGrooveZ_SetDecisionMin(Go2ProfileGrooveZ measurement, Go2Double min); //
//
//  Description:
//      Sets the decision threshold minimum value.
//  Arguments:
//      measurement - Go2ProfileGrooveZ 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) Go2ProfileGrooveZ_DecisionMin(Go2ProfileGrooveZ measurement); //
//
//  Description:
//      Gets the decision threshold minimum value.
//  Arguments:
//      measurement - Go2ProfileGrooveZ 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) Go2ProfileGrooveZ_SetDecisionMax(Go2ProfileGrooveZ measurement, Go2Double max); //
//
//  Description:
//      Sets the decision threshold maximum value.
//  Arguments:
//      measurement - Go2ProfileGrooveZ 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) Go2ProfileGrooveZ_DecisionMax(Go2ProfileGrooveZ measurement); //
//
//  Description:
//      Gets the decision threshold maximum value.
//  Arguments:
//      measurement - Go2ProfileGrooveZ 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) Go2ProfileGrooveZ_EnableHold(Go2ProfileGrooveZ measurement, Go2Bool enable); //
//
//  Description:
//      Enables measurement value hold.
//  Arguments:
//      measurement - Go2ProfileGrooveZ object.
//      enable - GO2_TRUE to enable, or GO2_FALSE to disable.
//  Returns:
//      Operation status.

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

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

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

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

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

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

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

GO2_EXPORT(Go2ProfileArea) Go2ProfileGrooveZ_Area(Go2ProfileGrooveZ measurement); //
//
//  Description:
//      Gets the region of interest.
//  Arguments:
//      measurement - Go2ProfileGrooveZ object. 
//  Returns:
//      Area object. 

GO2_EXPORT(Go2Status) Go2ProfileGrooveZ_SetShape(Go2ProfileGrooveZ measurement, Go2ProfileGrooveShape shape); //
//
//  Description:
//      Sets the groove shape to search for.
//  Arguments:
//      measurement - Go2ProfileGrooveZ object. 
//      shape - The groove shape.
//  Returns:
//      Operation status.
 
GO2_EXPORT(Go2ProfileGrooveShape) Go2ProfileGrooveZ_Shape(Go2ProfileGrooveZ measurement); //
//
//  Description:
//      Gets the groove shape to search for.
//  Arguments:
//      measurement - Go2ProfileGrooveZ object. 
//  Returns:
//      The groove shape.

GO2_EXPORT(Go2Status) Go2ProfileGrooveZ_SetSelectType(Go2ProfileGrooveZ measurement, Go2ProfileGrooveSelectType type); //
//
//  Description:
//      Sets the select type.
//  Arguments:
//      measurement - Go2ProfileGrooveZ object. 
//      type - The select type.
//  Returns:
//      Operation status.
 
GO2_EXPORT(Go2ProfileGrooveSelectType) Go2ProfileGrooveZ_SelectType(Go2ProfileGrooveZ measurement); //
//
//  Description:
//      Gets the select type.
//  Arguments:
//      measurement - Go2ProfileGrooveZ object. 
//  Returns:
//      The select type.

GO2_EXPORT(Go2Status) Go2ProfileGrooveZ_SetSelectN(Go2ProfileGrooveZ measurement, Go2UInt32 n); //
//
//  Description:
//      Sets the N-th groove to select when selectType is 
//      GO2_PROFILE_GROOVE_SELECT_LEFT or GO2_PROFILE_GROOVE_SELECT_RIGHT.
//  Arguments:
//      measurement - Go2ProfileGrooveZ object. 
//      n - The N-th groove to select.
//  Returns:
//      Operation status.
 
GO2_EXPORT(Go2UInt32) Go2ProfileGrooveZ_SelectN(Go2ProfileGrooveZ measurement); //
//
//  Description:
//      Gets the N-th groove to select when selectType is
//      GO2_PROFILE_GROOVE_SELECT_LEFT or GO2_PROFILE_GROOVE_SELECT_RIGHT.
//  Arguments:
//      measurement - Go2ProfileGrooveZ object. 
//  Returns:
//      The N-th groove to select.

GO2_EXPORT(Go2Status) Go2ProfileGrooveZ_SetLocation(Go2ProfileGrooveZ measurement, Go2ProfileGrooveLocation location); //
//
//  Description:
//      Sets what location on the groove to return the position of.
//  Arguments:
//      measurement - Go2ProfileGrooveZ object. 
//      location - The groove position location.
//  Returns:
//      Operation status.

GO2_EXPORT(Go2ProfileGrooveLocation) Go2ProfileGrooveZ_Location(Go2ProfileGrooveZ measurement); //
//
//  Description:
//      Gets what location on the groove to return the position of.
//  Arguments:
//      measurement - Go2ProfileGrooveZ object. 
//  Returns:
//      The groove position location.

GO2_EXPORT(Go2Status) Go2ProfileGrooveZ_SetDepthMin(Go2ProfileGrooveZ measurement, Go2Double depth); //
//
//  Description:
//      Sets the minimum depth for a groove to be considered.
//  Arguments:
//      measurement - Go2ProfileGrooveZ object. 
//      depth - The minimum groove depth.
//  Returns:
//      Operation status.
 
GO2_EXPORT(Go2Double) Go2ProfileGrooveZ_DepthMin(Go2ProfileGrooveZ measurement); //
//
//  Description:
//      Gets the minimum depth for a groove to be considered.
//  Arguments:
//      measurement - Go2ProfileGrooveZ object. 
//  Returns:
//      The minimum groove depth

GO2_EXPORT(Go2Status) Go2ProfileGrooveZ_SetWidthMin(Go2ProfileGrooveZ measurement, Go2Double width); //
//
//  Description:
//      Sets the minimum width for a groove to be considered.
//  Arguments:
//      measurement - Go2ProfileGrooveZ object. 
//      width - The minimum groove width.
//  Returns:
//      Operation status.
 
GO2_EXPORT(Go2Double) Go2ProfileGrooveZ_WidthMin(Go2ProfileGrooveZ measurement); //
//
//  Description:
//      Gets the minimum width for a groove to be considered.
//  Arguments:
//      measurement - Go2ProfileGrooveZ object. 
//  Returns:
//      The minimum groove width

GO2_EXPORT(Go2Status) Go2ProfileGrooveZ_SetWidthMax(Go2ProfileGrooveZ measurement, Go2Double width); //
//
//  Description:
//      Sets the maximum width for a groove to be considered.
//  Arguments:
//      measurement - Go2ProfileGrooveZ object. 
//      width - The maximum groove width.
//  Returns:
//      Operation status.
 
GO2_EXPORT(Go2Double) Go2ProfileGrooveZ_WidthMax(Go2ProfileGrooveZ measurement); //
//
//  Description:
//      Gets the maximum width for a groove to be considered.
//  Arguments:
//      measurement - Go2ProfileGrooveZ object. 
//  Returns:
//      The maximum groove width



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

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

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

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

GO2_EXPORT(Go2UInt32) Go2ProfileGrooveZ_LinkOptionAt(Go2ProfileGrooveZ 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) Go2ProfileGrooveZ_LinkOptionCount(Go2ProfileGrooveZ measurement); //
//
//  Description:
//      Gets the number of link-able measurement IDs.
//  Arguments:
//      measurement - Go2PartMeasurement object.
//  Returns:
//      The link-able measurement count.

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

GO2_EXPORT(Go2Status) Go2ProfileGrooveZ_SetLink(Go2ProfileGrooveZ 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 PartOpening_? measurements)
//    Arguments:
//      measurement - Go2PartMeasurement object.
//      link - Measurement id to link to.
//  Returns:
//      Operation status.

GO2_EXPORT(Go2Bool) Go2ProfileGrooveZ_LinkEnabled(Go2ProfileGrooveZ measurement);   //
//
//  Description:
//      Enables measurement linking.  When enabled, another measurement of the same base type can be 
//          linked, provided that it is a different measurement.
//          E.g. A Go2PartOpeningX and Go2PartOpeningY measurement can link, but two Go2PartOpeningX measurements can not be linked.
//    Arguments:
//      measurement - Go2PartMeasurement object.
//    Returns:
//      enable - GO2_TRUE to enable, or GO2_FALSE to disable.

GO2_EXPORT(Go2Status) Go2ProfileGrooveZ_EnableLink(Go2ProfileGrooveZ measurement, Go2Bool enable);   //
//
//  Description:
//      Enables or disables measurement linking.
//  Arguments:
//      measurement - Go2PartMeasurement object.
//      enable - Use GO2_TRUE to enable linking and GO2_FALSE to disable it.
//  Returns:
//      Operation status.

#include <Go2ApiEnd.h>
#endif
