Class CommonTurningModelItemHelper

Helper methods for ICamApiCommonTurningModelItem.

Inheritance

object

CommonTurningModelItemHelper

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 CommonTurningModelItemHelper

Methods

FirstTurningItem(ComWrapper<ICamApiModelFormer>)

Find the first ICamApiCommonTurningModelItem in a model former. Returns a null wrapper (IsNull == true) when none is present.

Declaration

public static ComWrapper<ICamApiCommonTurningModelItem> FirstTurningItem(this ComWrapper<ICamApiModelFormer> mfCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiModelFormer>	mfCom

Returns

Type	Description
ComWrapper<ICamApiCommonTurningModelItem>

GetActiveCycleAs<T>(ComWrapper<ICamApiCommonTurningModelItem>)

Read the active cycle and cast it to the requested cycle interface (Profile, OffsetRoughing, RoughingAdvanced, Roughing, Zigzag, Common, Leads, OverrideFeeds). Returns null when the active cycle does not implement T.

Declaration

public static ComWrapper<T> GetActiveCycleAs<T>(this ComWrapper<ICamApiCommonTurningModelItem> itemCom) where T : class

Parameters

Type	Name	Description
ComWrapper<ICamApiCommonTurningModelItem>	itemCom

Returns

Type	Description
ComWrapper<T>

Type Parameters

Name	Description
T

GetCommon(ComWrapper<ICamApiCommonTurningModelItem>)

Common tab parameters (MachiningSide, RoundingRadius, ToolAngles, etc.). Always valid regardless of active cycle type.

Declaration

public static ComWrapper<ICamApiLatheCycleCommon> GetCommon(this ComWrapper<ICamApiCommonTurningModelItem> itemCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiCommonTurningModelItem>	itemCom

Returns

Type	Description
ComWrapper<ICamApiLatheCycleCommon>

GetLeads(ComWrapper<ICamApiCommonTurningModelItem>)

Leads tab parameters (Approach, Engage, Retract). Always valid regardless of active cycle type.

Declaration

public static ComWrapper<ICamApiLatheCycleLeads> GetLeads(this ComWrapper<ICamApiCommonTurningModelItem> itemCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiCommonTurningModelItem>	itemCom

Returns

Type	Description
ComWrapper<ICamApiLatheCycleLeads>

GetOverrideFeeds(ComWrapper<ICamApiCommonTurningModelItem>)

Override feeds parameters. Always valid regardless of active cycle type.

Declaration

public static ComWrapper<ICamApiLatheCycleOverrideFeeds> GetOverrideFeeds(this ComWrapper<ICamApiCommonTurningModelItem> itemCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiCommonTurningModelItem>	itemCom

Returns

Type	Description
ComWrapper<ICamApiLatheCycleOverrideFeeds>

LastTurningItem(ComWrapper<ICamApiModelFormer>)

Find the last ICamApiCommonTurningModelItem in a model former.

Declaration

public static ComWrapper<ICamApiCommonTurningModelItem> LastTurningItem(this ComWrapper<ICamApiModelFormer> mfCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiModelFormer>	mfCom

Returns

Type	Description
ComWrapper<ICamApiCommonTurningModelItem>

SetActiveCycle(ComWrapper<ICamApiCommonTurningModelItem>, TLatheContourCycleType)

Switch the active cycle. ActiveCycle is rebuilt to the new type with default values. Accepts: lcctProfile, lcctOffsetLegacy, lcctOffsetRoughing, lcctRoughingAdvanced, lcctRoughing, lcctZigzag.

Declaration

public static void SetActiveCycle(this ComWrapper<ICamApiCommonTurningModelItem> itemCom, TLatheContourCycleType cycleType)

Parameters

Type	Name	Description
ComWrapper<ICamApiCommonTurningModelItem>	itemCom
TLatheContourCycleType	cycleType