Class BossHoleProbingCycleHelper

Helper methods for ICamApiBossProbingCycle, ICamApiHoleProbingCycle and ICamApiHoleProbingProtectedCycle.

Inheritance

object

BossHoleProbingCycleHelper

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: CAMAPI.DotnetHelper

Assembly: CAMAPI.DotnetHelper.dll

Syntax

public static class BossHoleProbingCycleHelper

Methods

GetCenterPoint(ComWrapper<ICamApiBossProbingCycle>)

Center point of the boss in world coordinates.

Declaration

public static TST3DPoint GetCenterPoint(this ComWrapper<ICamApiBossProbingCycle> c)

Parameters

Type	Name	Description
ComWrapper<ICamApiBossProbingCycle>	c

Returns

Type	Description
TST3DPoint

GetCenterPoint(ComWrapper<ICamApiHoleProbingCycle>)

Center point of the hole in world coordinates.

Declaration

public static TST3DPoint GetCenterPoint(this ComWrapper<ICamApiHoleProbingCycle> c)

Parameters

Type	Name	Description
ComWrapper<ICamApiHoleProbingCycle>	c

Returns

Type	Description
TST3DPoint

GetCenterPoint(ComWrapper<ICamApiHoleProbingProtectedCycle>)

Center point of the hole in world coordinates.

Declaration

public static TST3DPoint GetCenterPoint(this ComWrapper<ICamApiHoleProbingProtectedCycle> c)

Parameters

Type	Name	Description
ComWrapper<ICamApiHoleProbingProtectedCycle>	c

Returns

Type	Description
TST3DPoint

GetCycleVariantIsAngular(ComWrapper<ICamApiBossProbingCycle>, out double, out int, out double)

Returns true if the cycle is in angular variant and fills out-parameters with angular settings.

Declaration

public static bool GetCycleVariantIsAngular(this ComWrapper<ICamApiBossProbingCycle> c, out double startAngle, out int stepCnt, out double angularStep)

Parameters

Type	Name	Description
ComWrapper<ICamApiBossProbingCycle>	c
double	startAngle
int	stepCnt
double	angularStep

Returns

Type	Description
bool

GetCycleVariantIsAngular(ComWrapper<ICamApiHoleProbingCycle>, out double, out int, out double)

Returns true if the cycle is in angular variant and fills out-parameters with angular settings.

Declaration

public static bool GetCycleVariantIsAngular(this ComWrapper<ICamApiHoleProbingCycle> c, out double startAngle, out int stepCnt, out double angularStep)

Parameters

Type	Name	Description
ComWrapper<ICamApiHoleProbingCycle>	c
double	startAngle
int	stepCnt
double	angularStep

Returns

Type	Description
bool

GetCycleVariantIsAngular(ComWrapper<ICamApiHoleProbingProtectedCycle>, out double, out int, out double)

Returns true if the cycle is in angular variant and fills out-parameters with angular settings.

Declaration

public static bool GetCycleVariantIsAngular(this ComWrapper<ICamApiHoleProbingProtectedCycle> c, out double startAngle, out int stepCnt, out double angularStep)

Parameters

Type	Name	Description
ComWrapper<ICamApiHoleProbingProtectedCycle>	c
double	startAngle
int	stepCnt
double	angularStep

Returns

Type	Description
bool

GetCycleVariantIsRectangular(ComWrapper<ICamApiBossProbingCycle>)

Returns true if the cycle is in rectangular variant.

Declaration

public static bool GetCycleVariantIsRectangular(this ComWrapper<ICamApiBossProbingCycle> c)

Parameters

Type	Name	Description
ComWrapper<ICamApiBossProbingCycle>	c

Returns

Type	Description
bool

GetCycleVariantIsRectangular(ComWrapper<ICamApiHoleProbingCycle>)

Returns true if the cycle is in rectangular variant.

Declaration

public static bool GetCycleVariantIsRectangular(this ComWrapper<ICamApiHoleProbingCycle> c)

Parameters

Type	Name	Description
ComWrapper<ICamApiHoleProbingCycle>	c

Returns

Type	Description
bool

GetCycleVariantIsRectangular(ComWrapper<ICamApiHoleProbingProtectedCycle>)

Returns true if the cycle is in rectangular variant.

Declaration

public static bool GetCycleVariantIsRectangular(this ComWrapper<ICamApiHoleProbingProtectedCycle> c)

Parameters

Type	Name	Description
ComWrapper<ICamApiHoleProbingProtectedCycle>	c

Returns

Type	Description
bool

GetDepth(ComWrapper<ICamApiBossProbingCycle>)

Probing depth (Z travel during measurement).

Declaration

public static double GetDepth(this ComWrapper<ICamApiBossProbingCycle> c)

Parameters

Type	Name	Description
ComWrapper<ICamApiBossProbingCycle>	c

Returns

Type	Description
double

GetDepth(ComWrapper<ICamApiHoleProbingCycle>)

Probing depth (Z travel during measurement).

Declaration

public static double GetDepth(this ComWrapper<ICamApiHoleProbingCycle> c)

Parameters

Type	Name	Description
ComWrapper<ICamApiHoleProbingCycle>	c

Returns

Type	Description
double

GetDepth(ComWrapper<ICamApiHoleProbingProtectedCycle>)

Probing depth (Z travel during measurement).

Declaration

public static double GetDepth(this ComWrapper<ICamApiHoleProbingProtectedCycle> c)

Parameters

Type	Name	Description
ComWrapper<ICamApiHoleProbingProtectedCycle>	c

Returns

Type	Description
double

GetDiameter(ComWrapper<ICamApiBossProbingCycle>)

Nominal diameter of the boss.

Declaration

public static double GetDiameter(this ComWrapper<ICamApiBossProbingCycle> c)

Parameters

Type	Name	Description
ComWrapper<ICamApiBossProbingCycle>	c

Returns

Type	Description
double

GetDiameter(ComWrapper<ICamApiHoleProbingCycle>)

Nominal diameter of the hole.

Declaration

public static double GetDiameter(this ComWrapper<ICamApiHoleProbingCycle> c)

Parameters

Type	Name	Description
ComWrapper<ICamApiHoleProbingCycle>	c

Returns

Type	Description
double

GetDiameter(ComWrapper<ICamApiHoleProbingProtectedCycle>)

Nominal diameter of the hole.

Declaration

public static double GetDiameter(this ComWrapper<ICamApiHoleProbingProtectedCycle> c)

Parameters

Type	Name	Description
ComWrapper<ICamApiHoleProbingProtectedCycle>	c

Returns

Type	Description
double

GetSideClearance(ComWrapper<ICamApiBossProbingCycle>)

Lateral clearance distance from the boss surface.

Declaration

public static double GetSideClearance(this ComWrapper<ICamApiBossProbingCycle> c)

Parameters

Type	Name	Description
ComWrapper<ICamApiBossProbingCycle>	c

Returns

Type	Description
double

GetSideClearance(ComWrapper<ICamApiHoleProbingCycle>)

Lateral clearance distance from the hole wall.

Declaration

public static double GetSideClearance(this ComWrapper<ICamApiHoleProbingCycle> c)

Parameters

Type	Name	Description
ComWrapper<ICamApiHoleProbingCycle>	c

Returns

Type	Description
double

GetSideClearance(ComWrapper<ICamApiHoleProbingProtectedCycle>)

Lateral clearance distance from the hole wall.

Declaration

public static double GetSideClearance(this ComWrapper<ICamApiHoleProbingProtectedCycle> c)

Parameters

Type	Name	Description
ComWrapper<ICamApiHoleProbingProtectedCycle>	c

Returns

Type	Description
double

GetStock(ComWrapper<ICamApiBossProbingCycle>)

Material allowance (stock) on the boss surface.

Declaration

public static double GetStock(this ComWrapper<ICamApiBossProbingCycle> c)

Parameters

Type	Name	Description
ComWrapper<ICamApiBossProbingCycle>	c

Returns

Type	Description
double

GetStock(ComWrapper<ICamApiHoleProbingCycle>)

Material allowance (stock) on the hole surface.

Declaration

public static double GetStock(this ComWrapper<ICamApiHoleProbingCycle> c)

Parameters

Type	Name	Description
ComWrapper<ICamApiHoleProbingCycle>	c

Returns

Type	Description
double

GetStock(ComWrapper<ICamApiHoleProbingProtectedCycle>)

Material allowance (stock) on the hole surface.

Declaration

public static double GetStock(this ComWrapper<ICamApiHoleProbingProtectedCycle> c)

Parameters

Type	Name	Description
ComWrapper<ICamApiHoleProbingProtectedCycle>	c

Returns

Type	Description
double

GetTargetPoint(ComWrapper<ICamApiBossProbingCycle>)

First probe touch target point in world coordinates.

Declaration

public static TST3DPoint GetTargetPoint(this ComWrapper<ICamApiBossProbingCycle> c)

Parameters

Type	Name	Description
ComWrapper<ICamApiBossProbingCycle>	c

Returns

Type	Description
TST3DPoint

GetTargetPoint(ComWrapper<ICamApiHoleProbingCycle>)

First probe touch target point in world coordinates.

Declaration

public static TST3DPoint GetTargetPoint(this ComWrapper<ICamApiHoleProbingCycle> c)

Parameters

Type	Name	Description
ComWrapper<ICamApiHoleProbingCycle>	c

Returns

Type	Description
TST3DPoint

GetTargetPoint(ComWrapper<ICamApiHoleProbingProtectedCycle>)

First probe touch target point in world coordinates.

Declaration

public static TST3DPoint GetTargetPoint(this ComWrapper<ICamApiHoleProbingProtectedCycle> c)

Parameters

Type	Name	Description
ComWrapper<ICamApiHoleProbingProtectedCycle>	c

Returns

Type	Description
TST3DPoint

GetTargetVector(ComWrapper<ICamApiBossProbingCycle>)

Probe approach direction vector.

Declaration

public static TST3DPoint GetTargetVector(this ComWrapper<ICamApiBossProbingCycle> c)

Parameters

Type	Name	Description
ComWrapper<ICamApiBossProbingCycle>	c

Returns

Type	Description
TST3DPoint

GetTargetVector(ComWrapper<ICamApiHoleProbingCycle>)

Probe approach direction vector.

Declaration

public static TST3DPoint GetTargetVector(this ComWrapper<ICamApiHoleProbingCycle> c)

Parameters

Type	Name	Description
ComWrapper<ICamApiHoleProbingCycle>	c

Returns

Type	Description
TST3DPoint

GetTargetVector(ComWrapper<ICamApiHoleProbingProtectedCycle>)

Probe approach direction vector.

Declaration

public static TST3DPoint GetTargetVector(this ComWrapper<ICamApiHoleProbingProtectedCycle> c)

Parameters

Type	Name	Description
ComWrapper<ICamApiHoleProbingProtectedCycle>	c

Returns

Type	Description
TST3DPoint

GetTopClearance(ComWrapper<ICamApiBossProbingCycle>)

Clearance distance above the top of the boss.

Declaration

public static double GetTopClearance(this ComWrapper<ICamApiBossProbingCycle> c)

Parameters

Type	Name	Description
ComWrapper<ICamApiBossProbingCycle>	c

Returns

Type	Description
double

GetTopClearance(ComWrapper<ICamApiHoleProbingCycle>)

Clearance distance above the hole entry.

Declaration

public static double GetTopClearance(this ComWrapper<ICamApiHoleProbingCycle> c)

Parameters

Type	Name	Description
ComWrapper<ICamApiHoleProbingCycle>	c

Returns

Type	Description
double

GetTopClearance(ComWrapper<ICamApiHoleProbingProtectedCycle>)

Clearance distance above the hole entry.

Declaration

public static double GetTopClearance(this ComWrapper<ICamApiHoleProbingProtectedCycle> c)

Parameters

Type	Name	Description
ComWrapper<ICamApiHoleProbingProtectedCycle>	c

Returns

Type	Description
double

GetTopClearanceEnabled(ComWrapper<ICamApiBossProbingCycle>)

Whether the top clearance move is enabled.

Declaration

public static bool GetTopClearanceEnabled(this ComWrapper<ICamApiBossProbingCycle> c)

Parameters

Type	Name	Description
ComWrapper<ICamApiBossProbingCycle>	c

Returns

Type	Description
bool

GetTopClearanceEnabled(ComWrapper<ICamApiHoleProbingCycle>)

Whether the top clearance move is enabled.

Declaration

public static bool GetTopClearanceEnabled(this ComWrapper<ICamApiHoleProbingCycle> c)

Parameters

Type	Name	Description
ComWrapper<ICamApiHoleProbingCycle>	c

Returns

Type	Description
bool

GetTopClearanceEnabled(ComWrapper<ICamApiHoleProbingProtectedCycle>)

Whether the top clearance move is enabled.

Declaration

public static bool GetTopClearanceEnabled(this ComWrapper<ICamApiHoleProbingProtectedCycle> c)

Parameters

Type	Name	Description
ComWrapper<ICamApiHoleProbingProtectedCycle>	c

Returns

Type	Description
bool

SetCenterPoint(ComWrapper<ICamApiBossProbingCycle>, TST3DPoint)

Declaration

public static void SetCenterPoint(this ComWrapper<ICamApiBossProbingCycle> c, TST3DPoint v)

Parameters

Type	Name	Description
ComWrapper<ICamApiBossProbingCycle>	c
TST3DPoint	v

SetCenterPoint(ComWrapper<ICamApiHoleProbingCycle>, TST3DPoint)

Declaration

public static void SetCenterPoint(this ComWrapper<ICamApiHoleProbingCycle> c, TST3DPoint v)

Parameters

Type	Name	Description
ComWrapper<ICamApiHoleProbingCycle>	c
TST3DPoint	v

SetCenterPoint(ComWrapper<ICamApiHoleProbingProtectedCycle>, TST3DPoint)

Declaration

public static void SetCenterPoint(this ComWrapper<ICamApiHoleProbingProtectedCycle> c, TST3DPoint v)

Parameters

Type	Name	Description
ComWrapper<ICamApiHoleProbingProtectedCycle>	c
TST3DPoint	v

SetCycleVariantIsAngular(ComWrapper<ICamApiBossProbingCycle>, double, int, double)

Switch the cycle to angular (multi-touch) variant.

Declaration

public static void SetCycleVariantIsAngular(this ComWrapper<ICamApiBossProbingCycle> c, double startAngle, int stepCnt, double angularStep)

Parameters

Type	Name	Description
ComWrapper<ICamApiBossProbingCycle>	c
double	startAngle
int	stepCnt
double	angularStep

SetCycleVariantIsAngular(ComWrapper<ICamApiHoleProbingCycle>, double, int, double)

Switch the cycle to angular (multi-touch) variant.

Declaration

public static void SetCycleVariantIsAngular(this ComWrapper<ICamApiHoleProbingCycle> c, double startAngle, int stepCnt, double angularStep)

Parameters

Type	Name	Description
ComWrapper<ICamApiHoleProbingCycle>	c
double	startAngle
int	stepCnt
double	angularStep

SetCycleVariantIsAngular(ComWrapper<ICamApiHoleProbingProtectedCycle>, double, int, double)

Switch the cycle to angular (multi-touch) variant.

Declaration

public static void SetCycleVariantIsAngular(this ComWrapper<ICamApiHoleProbingProtectedCycle> c, double startAngle, int stepCnt, double angularStep)

Parameters

Type	Name	Description
ComWrapper<ICamApiHoleProbingProtectedCycle>	c
double	startAngle
int	stepCnt
double	angularStep

SetCycleVariantIsRectangular(ComWrapper<ICamApiBossProbingCycle>)

Switch the cycle to rectangular (4-touch) variant.

Declaration

public static void SetCycleVariantIsRectangular(this ComWrapper<ICamApiBossProbingCycle> c)

Parameters

Type	Name	Description
ComWrapper<ICamApiBossProbingCycle>	c

SetCycleVariantIsRectangular(ComWrapper<ICamApiHoleProbingCycle>)

Switch the cycle to rectangular (4-touch) variant.

Declaration

public static void SetCycleVariantIsRectangular(this ComWrapper<ICamApiHoleProbingCycle> c)

Parameters

Type	Name	Description
ComWrapper<ICamApiHoleProbingCycle>	c

SetCycleVariantIsRectangular(ComWrapper<ICamApiHoleProbingProtectedCycle>)

Switch the cycle to rectangular (4-touch) variant.

Declaration

public static void SetCycleVariantIsRectangular(this ComWrapper<ICamApiHoleProbingProtectedCycle> c)

Parameters

Type	Name	Description
ComWrapper<ICamApiHoleProbingProtectedCycle>	c

SetDepth(ComWrapper<ICamApiBossProbingCycle>, double)

Declaration

public static void SetDepth(this ComWrapper<ICamApiBossProbingCycle> c, double v)

Parameters

Type	Name	Description
ComWrapper<ICamApiBossProbingCycle>	c
double	v

SetDepth(ComWrapper<ICamApiHoleProbingCycle>, double)

Declaration

public static void SetDepth(this ComWrapper<ICamApiHoleProbingCycle> c, double v)

Parameters

Type	Name	Description
ComWrapper<ICamApiHoleProbingCycle>	c
double	v

SetDepth(ComWrapper<ICamApiHoleProbingProtectedCycle>, double)

Declaration

public static void SetDepth(this ComWrapper<ICamApiHoleProbingProtectedCycle> c, double v)

Parameters

Type	Name	Description
ComWrapper<ICamApiHoleProbingProtectedCycle>	c
double	v

SetDiameter(ComWrapper<ICamApiBossProbingCycle>, double)

Declaration

public static void SetDiameter(this ComWrapper<ICamApiBossProbingCycle> c, double v)

Parameters

Type	Name	Description
ComWrapper<ICamApiBossProbingCycle>	c
double	v

SetDiameter(ComWrapper<ICamApiHoleProbingCycle>, double)

Declaration

public static void SetDiameter(this ComWrapper<ICamApiHoleProbingCycle> c, double v)

Parameters

Type	Name	Description
ComWrapper<ICamApiHoleProbingCycle>	c
double	v

SetDiameter(ComWrapper<ICamApiHoleProbingProtectedCycle>, double)

Declaration

public static void SetDiameter(this ComWrapper<ICamApiHoleProbingProtectedCycle> c, double v)

Parameters

Type	Name	Description
ComWrapper<ICamApiHoleProbingProtectedCycle>	c
double	v

SetSideClearance(ComWrapper<ICamApiBossProbingCycle>, double)

Declaration

public static void SetSideClearance(this ComWrapper<ICamApiBossProbingCycle> c, double v)

Parameters

Type	Name	Description
ComWrapper<ICamApiBossProbingCycle>	c
double	v

SetSideClearance(ComWrapper<ICamApiHoleProbingCycle>, double)

Declaration

public static void SetSideClearance(this ComWrapper<ICamApiHoleProbingCycle> c, double v)

Parameters

Type	Name	Description
ComWrapper<ICamApiHoleProbingCycle>	c
double	v

SetSideClearance(ComWrapper<ICamApiHoleProbingProtectedCycle>, double)

Declaration

public static void SetSideClearance(this ComWrapper<ICamApiHoleProbingProtectedCycle> c, double v)

Parameters

Type	Name	Description
ComWrapper<ICamApiHoleProbingProtectedCycle>	c
double	v

SetStock(ComWrapper<ICamApiBossProbingCycle>, double)

Declaration

public static void SetStock(this ComWrapper<ICamApiBossProbingCycle> c, double v)

Parameters

Type	Name	Description
ComWrapper<ICamApiBossProbingCycle>	c
double	v

SetStock(ComWrapper<ICamApiHoleProbingCycle>, double)

Declaration

public static void SetStock(this ComWrapper<ICamApiHoleProbingCycle> c, double v)

Parameters

Type	Name	Description
ComWrapper<ICamApiHoleProbingCycle>	c
double	v

SetStock(ComWrapper<ICamApiHoleProbingProtectedCycle>, double)

Declaration

public static void SetStock(this ComWrapper<ICamApiHoleProbingProtectedCycle> c, double v)

Parameters

Type	Name	Description
ComWrapper<ICamApiHoleProbingProtectedCycle>	c
double	v

SetTargetPoint(ComWrapper<ICamApiBossProbingCycle>, TST3DPoint)

Declaration

public static void SetTargetPoint(this ComWrapper<ICamApiBossProbingCycle> c, TST3DPoint v)

Parameters

Type	Name	Description
ComWrapper<ICamApiBossProbingCycle>	c
TST3DPoint	v

SetTargetPoint(ComWrapper<ICamApiHoleProbingCycle>, TST3DPoint)

Declaration

public static void SetTargetPoint(this ComWrapper<ICamApiHoleProbingCycle> c, TST3DPoint v)

Parameters

Type	Name	Description
ComWrapper<ICamApiHoleProbingCycle>	c
TST3DPoint	v

SetTargetPoint(ComWrapper<ICamApiHoleProbingProtectedCycle>, TST3DPoint)

Declaration

public static void SetTargetPoint(this ComWrapper<ICamApiHoleProbingProtectedCycle> c, TST3DPoint v)

Parameters

Type	Name	Description
ComWrapper<ICamApiHoleProbingProtectedCycle>	c
TST3DPoint	v

SetTargetVector(ComWrapper<ICamApiBossProbingCycle>, TST3DPoint)

Declaration

public static void SetTargetVector(this ComWrapper<ICamApiBossProbingCycle> c, TST3DPoint v)

Parameters

Type	Name	Description
ComWrapper<ICamApiBossProbingCycle>	c
TST3DPoint	v

SetTargetVector(ComWrapper<ICamApiHoleProbingCycle>, TST3DPoint)

Declaration

public static void SetTargetVector(this ComWrapper<ICamApiHoleProbingCycle> c, TST3DPoint v)

Parameters

Type	Name	Description
ComWrapper<ICamApiHoleProbingCycle>	c
TST3DPoint	v

SetTargetVector(ComWrapper<ICamApiHoleProbingProtectedCycle>, TST3DPoint)

Declaration

public static void SetTargetVector(this ComWrapper<ICamApiHoleProbingProtectedCycle> c, TST3DPoint v)

Parameters

Type	Name	Description
ComWrapper<ICamApiHoleProbingProtectedCycle>	c
TST3DPoint	v

SetTopClearance(ComWrapper<ICamApiBossProbingCycle>, double)

Declaration

public static void SetTopClearance(this ComWrapper<ICamApiBossProbingCycle> c, double v)

Parameters

Type	Name	Description
ComWrapper<ICamApiBossProbingCycle>	c
double	v

SetTopClearance(ComWrapper<ICamApiHoleProbingCycle>, double)

Declaration

public static void SetTopClearance(this ComWrapper<ICamApiHoleProbingCycle> c, double v)

Parameters

Type	Name	Description
ComWrapper<ICamApiHoleProbingCycle>	c
double	v

SetTopClearance(ComWrapper<ICamApiHoleProbingProtectedCycle>, double)

Declaration

public static void SetTopClearance(this ComWrapper<ICamApiHoleProbingProtectedCycle> c, double v)

Parameters

Type	Name	Description
ComWrapper<ICamApiHoleProbingProtectedCycle>	c
double	v

SetTopClearanceEnabled(ComWrapper<ICamApiBossProbingCycle>, bool)

Declaration

public static void SetTopClearanceEnabled(this ComWrapper<ICamApiBossProbingCycle> c, bool v)

Parameters

Type	Name	Description
ComWrapper<ICamApiBossProbingCycle>	c
bool	v

SetTopClearanceEnabled(ComWrapper<ICamApiHoleProbingCycle>, bool)

Declaration

public static void SetTopClearanceEnabled(this ComWrapper<ICamApiHoleProbingCycle> c, bool v)

Parameters

Type	Name	Description
ComWrapper<ICamApiHoleProbingCycle>	c
bool	v

SetTopClearanceEnabled(ComWrapper<ICamApiHoleProbingProtectedCycle>, bool)

Declaration

public static void SetTopClearanceEnabled(this ComWrapper<ICamApiHoleProbingProtectedCycle> c, bool v)

Parameters

Type	Name	Description
ComWrapper<ICamApiHoleProbingProtectedCycle>	c
bool	v