/*
 * Go2PartPlaneZOffset.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_GO2PARTPLANEZOFFSET_H_INCLUDED
#define LMITECH_Z_GO2PARTPLANEZOFFSET_H_INCLUDED

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

/*
 * Go2PartPlaneZOffset Class 
 */

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

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

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

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

GO2_EXPORT(Go2Status) Go2PartPlaneZOffset_SetDecisionMin(Go2PartPlaneZOffset measurement, Go2Double min); //
//
//  Description:
//      Sets the decision threshold minimum value.
//  Arguments:
//      measurement - Go2PartPlaneZOffset 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) Go2PartPlaneZOffset_DecisionMin(Go2PartPlaneZOffset measurement); //
//
//  Description:
//      Gets the decision threshold minimum value.
//  Arguments:
//      measurement - Go2PartPlaneZOffset 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) Go2PartPlaneZOffset_SetDecisionMax(Go2PartPlaneZOffset measurement, Go2Double max); //
//
//  Description:
//      Sets the decision threshold maximum value.
//  Arguments:
//      measurement - Go2PartPlaneZOffset 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) Go2PartPlaneZOffset_DecisionMax(Go2PartPlaneZOffset measurement); //
//
//  Description:
//      Gets the decision threshold maximum value.
//  Arguments:
//      measurement - Go2PartPlaneZOffset 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) Go2PartPlaneZOffset_EnableHold(Go2PartPlaneZOffset measurement, Go2Bool enable); //
//
//  Description:
//      Enables measurement value hold.
//  Arguments:
//      measurement - Go2PartPlaneZOffset object.
//      enable - GO2_TRUE to enable, or GO2_FALSE to disable.
//  Returns:
//      Operation status.

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

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

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

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

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

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

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

GO2_EXPORT(Go2Status) Go2PartPlaneZOffset_EnableLink(Go2PartPlaneZOffset 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.  
//      E.g. A Go2PartPlaneZOffset and Go2PartPlaneY measurement can link, but two Go2PartPlaneZOffset measurements can not be linked.
//  Arguments:
//      measurement - Go2PartPlaneZOffset object. 
//      enable - GO2_TRUE to enable, or GO2_FALSE to disable.
//  Returns:
//      Operation status.
 
GO2_EXPORT(Go2Bool) Go2PartPlaneZOffset_LinkEnabled(Go2PartPlaneZOffset measurement); //
//
//  Description:
//      Reports whether measurement linking is enabled.
//  Arguments:
//      measurement - Go2PartPlaneZOffset object. 
//  Returns:
//      GO2_TRUE if the link is enabled; GO2_FALSE otherwise.

GO2_EXPORT(Go2Status) Go2PartPlaneZOffset_SetLink(Go2PartPlaneZOffset 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 PartPlane_? measurements)
//  Arguments:
//      measurement - Go2PartPlaneZOffset object. 
//      link - Measurement id to link to.
//  Returns:
//      Operation status.

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

GO2_EXPORT(Go2Status) Go2PartPlaneZOffset_EnableRegions(Go2PartPlaneZOffset measurement, Go2Bool enable); //
//
//  Description:
//      Enables measurement regions.  
//  Arguments:
//      measurement - Go2PartPlaneZOffset object. 
//      enable - GO2_TRUE to enable, or GO2_FALSE to disable.
//  Returns:
//      Operation status.

GO2_EXPORT(Go2Bool) Go2PartPlaneZOffset_RegionsEnabled(Go2PartPlaneZOffset measurement); //
//
//  Description:
//      Reports whether measurement regions are enabled.
//  Arguments:
//      measurement - Go2PartPlaneZOffset object. 
//  Returns:
//      GO2_TRUE if regions are enabled; GO2_FALSE otherwise.

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

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

GO2_EXPORT(Go2PartRegion3d) Go2PartPlaneZOffset_RegionAt(Go2PartPlaneZOffset measurement, Go2UInt32 index); //
//
//  Description:
//      Gets the region object at the specified index. 
//  Arguments:
//      measurement - Go2PartPlaneZOffset object. 
//      index - Index of the desired area.
//  Returns:
//      Region object.

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

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

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

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

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

#include <Go2ApiEnd.h>
#endif
