/*
 * Go2ProfileDistance.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_GO2PROFILEDISTANCE_H_INCLUDED
#define LMITECH_Z_GO2PROFILEDISTANCE_H_INCLUDED

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

/*
 * Go2ProfileDistance Class 
 */

typedef Go2Measurement Go2ProfileDistance;          // Represents profile distance measurement configuration.

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

GO2_EXPORT(Go2Status) Go2ProfileDistance_SetName(Go2ProfileDistance measurement, const Go2Char* name); //
//
//  Description:
//      Sets the descriptive name for the measurement.
//  Arguments:
//      measurement - Go2ProfileDistance object. 
//      name - Descriptive name. 
//  Returns:
//      Operation status. 

GO2_EXPORT(Go2Status) Go2ProfileDistance_Name(Go2ProfileDistance measurement, Go2Char* name, Go2UInt32 capacity); //
//
//  Description:
//      Gets the descriptive name for the measurement.
//  Arguments:
//      measurement - Go2ProfileDistance object. 
//      name - Receives descriptive name. 
//      capacity - Capacity of name buffer. 
//  Returns:
//      Operation status.  

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

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

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

GO2_EXPORT(Go2ProfileSource) Go2ProfileDistance_Source(Go2ProfileDistance measurement); //
//
//  Description:
//      Gets the source for profile data used in this measurement.
//  Arguments:
//      measurement - Go2ProfileDistance object. 
//  Returns: 
//      Profile source. 

GO2_EXPORT(Go2Status) Go2ProfileDistance_SetDecisionMin(Go2ProfileDistance measurement, Go2Double min); //
//
//  Description:
//      Sets the decision threshold minimum value.
//  Arguments:
//      measurement - Go2ProfileDistance 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) Go2ProfileDistance_DecisionMin(Go2ProfileDistance measurement); //
//
//  Description:
//      Gets the decision threshold minimum value.
//  Arguments:
//      measurement - Go2ProfileDistance 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) Go2ProfileDistance_SetDecisionMax(Go2ProfileDistance measurement, Go2Double max); //
//
//  Description:
//      Sets the decision threshold maximum value.
//  Arguments:
//      measurement - Go2ProfileDistance 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) Go2ProfileDistance_DecisionMax(Go2ProfileDistance measurement); //
//
//  Description:
//      Gets the decision threshold maximum value.
//  Arguments:
//      measurement - Go2ProfileDistance 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) Go2ProfileDistance_EnableHold(Go2ProfileDistance measurement, Go2Bool enable); //
//
//  Description:
//      Enables measurement value hold.
//  Arguments:
//      measurement - Go2ProfileDistance object.
//      enable - GO2_TRUE to enable, or GO2_FALSE to disable.
//  Returns:
//      Operation status.

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

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

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

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

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

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

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

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

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

GO2_EXPORT(Go2UInt32) Go2ProfileDistance_FeatureCount(Go2ProfileDistance measurement); //
//
//  Description:
//      Gets the count of feature points.
//  Arguments:
//      measurement - Go2ProfileDistance object. 
//  Returns:
//      Count of feature points.
 
GO2_EXPORT(Go2ProfileFeature) Go2ProfileDistance_FeatureAt(Go2ProfileDistance measurement, Go2UInt32 index); //
//
//  Description:
//      Gets the feature point at the specified index.
//  Arguments:
//      measurement - Go2ProfileDistance object. 
//      index - Index of the desired feature point.
//  Returns:
//      Feature point object. 



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

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

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

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

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

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

GO2_EXPORT(Go2Status) Go2ProfileDistance_SetLink(Go2ProfileDistance 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) Go2ProfileDistance_LinkEnabled(Go2ProfileDistance 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) Go2ProfileDistance_EnableLink(Go2ProfileDistance 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
