Class BossHoleProbingCycleHelper

Helper methods for ICamIpcBossProbingCycle, ICamIpcHoleProbingCycle and ICamIpcHoleProbingProtectedCycle.

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: CAMIPC.DotnetHelper

Assembly: CAMIPC.DotnetHelper.dll

Syntax

public static class BossHoleProbingCycleHelper

Methods

GetCenterPoint(ComWrapper<ICamIpcBossProbingCycle>)

Center point of the boss in world coordinates.

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcBossProbingCycle>	c

Returns

Type	Description
TST3DPoint

GetCenterPoint(ComWrapper<ICamIpcHoleProbingCycle>)

Center point of the hole in world coordinates.

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcHoleProbingCycle>	c

Returns

Type	Description
TST3DPoint

GetCenterPoint(ComWrapper<ICamIpcHoleProbingProtectedCycle>)

Center point of the hole in world coordinates.

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcHoleProbingProtectedCycle>	c

Returns

Type	Description
TST3DPoint

GetCycleVariantIsAngular(ComWrapper<ICamIpcBossProbingCycle>, 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<ICamIpcBossProbingCycle> c, out double startAngle, out int stepCnt, out double angularStep)

Parameters

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

Returns

Type	Description
bool

GetCycleVariantIsAngular(ComWrapper<ICamIpcHoleProbingCycle>, 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<ICamIpcHoleProbingCycle> c, out double startAngle, out int stepCnt, out double angularStep)

Parameters

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

Returns

Type	Description
bool

GetCycleVariantIsAngular(ComWrapper<ICamIpcHoleProbingProtectedCycle>, 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<ICamIpcHoleProbingProtectedCycle> c, out double startAngle, out int stepCnt, out double angularStep)

Parameters

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

Returns

Type	Description
bool

GetCycleVariantIsRectangular(ComWrapper<ICamIpcBossProbingCycle>)

Returns true if the cycle is in rectangular variant.

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcBossProbingCycle>	c

Returns

Type	Description
bool

GetCycleVariantIsRectangular(ComWrapper<ICamIpcHoleProbingCycle>)

Returns true if the cycle is in rectangular variant.

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcHoleProbingCycle>	c

Returns

Type	Description
bool

GetCycleVariantIsRectangular(ComWrapper<ICamIpcHoleProbingProtectedCycle>)

Returns true if the cycle is in rectangular variant.

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcHoleProbingProtectedCycle>	c

Returns

Type	Description
bool

GetDepth(ComWrapper<ICamIpcBossProbingCycle>)

Probing depth (Z travel during measurement).

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcBossProbingCycle>	c

Returns

Type	Description
double

GetDepth(ComWrapper<ICamIpcHoleProbingCycle>)

Probing depth (Z travel during measurement).

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcHoleProbingCycle>	c

Returns

Type	Description
double

GetDepth(ComWrapper<ICamIpcHoleProbingProtectedCycle>)

Probing depth (Z travel during measurement).

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcHoleProbingProtectedCycle>	c

Returns

Type	Description
double

GetDiameter(ComWrapper<ICamIpcBossProbingCycle>)

Nominal diameter of the boss.

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcBossProbingCycle>	c

Returns

Type	Description
double

GetDiameter(ComWrapper<ICamIpcHoleProbingCycle>)

Nominal diameter of the hole.

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcHoleProbingCycle>	c

Returns

Type	Description
double

GetDiameter(ComWrapper<ICamIpcHoleProbingProtectedCycle>)

Nominal diameter of the hole.

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcHoleProbingProtectedCycle>	c

Returns

Type	Description
double

GetSideClearance(ComWrapper<ICamIpcBossProbingCycle>)

Lateral clearance distance from the boss surface.

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcBossProbingCycle>	c

Returns

Type	Description
double

GetSideClearance(ComWrapper<ICamIpcHoleProbingCycle>)

Lateral clearance distance from the hole wall.

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcHoleProbingCycle>	c

Returns

Type	Description
double

GetSideClearance(ComWrapper<ICamIpcHoleProbingProtectedCycle>)

Lateral clearance distance from the hole wall.

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcHoleProbingProtectedCycle>	c

Returns

Type	Description
double

GetStock(ComWrapper<ICamIpcBossProbingCycle>)

Material allowance (stock) on the boss surface.

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcBossProbingCycle>	c

Returns

Type	Description
double

GetStock(ComWrapper<ICamIpcHoleProbingCycle>)

Material allowance (stock) on the hole surface.

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcHoleProbingCycle>	c

Returns

Type	Description
double

GetStock(ComWrapper<ICamIpcHoleProbingProtectedCycle>)

Material allowance (stock) on the hole surface.

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcHoleProbingProtectedCycle>	c

Returns

Type	Description
double

GetTargetPoint(ComWrapper<ICamIpcBossProbingCycle>)

First probe touch target point in world coordinates.

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcBossProbingCycle>	c

Returns

Type	Description
TST3DPoint

GetTargetPoint(ComWrapper<ICamIpcHoleProbingCycle>)

First probe touch target point in world coordinates.

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcHoleProbingCycle>	c

Returns

Type	Description
TST3DPoint

GetTargetPoint(ComWrapper<ICamIpcHoleProbingProtectedCycle>)

First probe touch target point in world coordinates.

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcHoleProbingProtectedCycle>	c

Returns

Type	Description
TST3DPoint

GetTargetVector(ComWrapper<ICamIpcBossProbingCycle>)

Probe approach direction vector.

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcBossProbingCycle>	c

Returns

Type	Description
TST3DPoint

GetTargetVector(ComWrapper<ICamIpcHoleProbingCycle>)

Probe approach direction vector.

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcHoleProbingCycle>	c

Returns

Type	Description
TST3DPoint

GetTargetVector(ComWrapper<ICamIpcHoleProbingProtectedCycle>)

Probe approach direction vector.

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcHoleProbingProtectedCycle>	c

Returns

Type	Description
TST3DPoint

GetTopClearance(ComWrapper<ICamIpcBossProbingCycle>)

Clearance distance above the top of the boss.

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcBossProbingCycle>	c

Returns

Type	Description
double

GetTopClearance(ComWrapper<ICamIpcHoleProbingCycle>)

Clearance distance above the hole entry.

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcHoleProbingCycle>	c

Returns

Type	Description
double

GetTopClearance(ComWrapper<ICamIpcHoleProbingProtectedCycle>)

Clearance distance above the hole entry.

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcHoleProbingProtectedCycle>	c

Returns

Type	Description
double

GetTopClearanceEnabled(ComWrapper<ICamIpcBossProbingCycle>)

Whether the top clearance move is enabled.

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcBossProbingCycle>	c

Returns

Type	Description
bool

GetTopClearanceEnabled(ComWrapper<ICamIpcHoleProbingCycle>)

Whether the top clearance move is enabled.

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcHoleProbingCycle>	c

Returns

Type	Description
bool

GetTopClearanceEnabled(ComWrapper<ICamIpcHoleProbingProtectedCycle>)

Whether the top clearance move is enabled.

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcHoleProbingProtectedCycle>	c

Returns

Type	Description
bool

SetCenterPoint(ComWrapper<ICamIpcBossProbingCycle>, TST3DPoint)

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcBossProbingCycle>	c
TST3DPoint	v

SetCenterPoint(ComWrapper<ICamIpcHoleProbingCycle>, TST3DPoint)

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcHoleProbingCycle>	c
TST3DPoint	v

SetCenterPoint(ComWrapper<ICamIpcHoleProbingProtectedCycle>, TST3DPoint)

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcHoleProbingProtectedCycle>	c
TST3DPoint	v

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

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

Declaration

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

Parameters

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

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

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

Declaration

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

Parameters

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

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

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

Declaration

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

Parameters

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

SetCycleVariantIsRectangular(ComWrapper<ICamIpcBossProbingCycle>)

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

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcBossProbingCycle>	c

SetCycleVariantIsRectangular(ComWrapper<ICamIpcHoleProbingCycle>)

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

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcHoleProbingCycle>	c

SetCycleVariantIsRectangular(ComWrapper<ICamIpcHoleProbingProtectedCycle>)

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

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcHoleProbingProtectedCycle>	c

SetDepth(ComWrapper<ICamIpcBossProbingCycle>, double)

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcBossProbingCycle>	c
double	v

SetDepth(ComWrapper<ICamIpcHoleProbingCycle>, double)

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcHoleProbingCycle>	c
double	v

SetDepth(ComWrapper<ICamIpcHoleProbingProtectedCycle>, double)

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcHoleProbingProtectedCycle>	c
double	v

SetDiameter(ComWrapper<ICamIpcBossProbingCycle>, double)

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcBossProbingCycle>	c
double	v

SetDiameter(ComWrapper<ICamIpcHoleProbingCycle>, double)

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcHoleProbingCycle>	c
double	v

SetDiameter(ComWrapper<ICamIpcHoleProbingProtectedCycle>, double)

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcHoleProbingProtectedCycle>	c
double	v

SetSideClearance(ComWrapper<ICamIpcBossProbingCycle>, double)

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcBossProbingCycle>	c
double	v

SetSideClearance(ComWrapper<ICamIpcHoleProbingCycle>, double)

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcHoleProbingCycle>	c
double	v

SetSideClearance(ComWrapper<ICamIpcHoleProbingProtectedCycle>, double)

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcHoleProbingProtectedCycle>	c
double	v

SetStock(ComWrapper<ICamIpcBossProbingCycle>, double)

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcBossProbingCycle>	c
double	v

SetStock(ComWrapper<ICamIpcHoleProbingCycle>, double)

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcHoleProbingCycle>	c
double	v

SetStock(ComWrapper<ICamIpcHoleProbingProtectedCycle>, double)

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcHoleProbingProtectedCycle>	c
double	v

SetTargetPoint(ComWrapper<ICamIpcBossProbingCycle>, TST3DPoint)

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcBossProbingCycle>	c
TST3DPoint	v

SetTargetPoint(ComWrapper<ICamIpcHoleProbingCycle>, TST3DPoint)

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcHoleProbingCycle>	c
TST3DPoint	v

SetTargetPoint(ComWrapper<ICamIpcHoleProbingProtectedCycle>, TST3DPoint)

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcHoleProbingProtectedCycle>	c
TST3DPoint	v

SetTargetVector(ComWrapper<ICamIpcBossProbingCycle>, TST3DPoint)

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcBossProbingCycle>	c
TST3DPoint	v

SetTargetVector(ComWrapper<ICamIpcHoleProbingCycle>, TST3DPoint)

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcHoleProbingCycle>	c
TST3DPoint	v

SetTargetVector(ComWrapper<ICamIpcHoleProbingProtectedCycle>, TST3DPoint)

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcHoleProbingProtectedCycle>	c
TST3DPoint	v

SetTopClearance(ComWrapper<ICamIpcBossProbingCycle>, double)

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcBossProbingCycle>	c
double	v

SetTopClearance(ComWrapper<ICamIpcHoleProbingCycle>, double)

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcHoleProbingCycle>	c
double	v

SetTopClearance(ComWrapper<ICamIpcHoleProbingProtectedCycle>, double)

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcHoleProbingProtectedCycle>	c
double	v

SetTopClearanceEnabled(ComWrapper<ICamIpcBossProbingCycle>, bool)

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcBossProbingCycle>	c
bool	v

SetTopClearanceEnabled(ComWrapper<ICamIpcHoleProbingCycle>, bool)

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcHoleProbingCycle>	c
bool	v

SetTopClearanceEnabled(ComWrapper<ICamIpcHoleProbingProtectedCycle>, bool)

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamIpcHoleProbingProtectedCycle>	c
bool	v