Class ModelFormerWithPointWeldingItemsHelper

Helper methods for ICamApiModelFormerWithPointWeldingItems.

Template semantics: the ClearanceXxx / EngageXxx / RetractXxx / FixVX properties are read when a weld point is created (via AddWeldItemBefore(ComWrapper<ICamApiModelFormerWithPointWeldingItems>, ComWrapper<ICamApiModelItem>) / AddWeldItemAfter(ComWrapper<ICamApiModelFormerWithPointWeldingItems>, ComWrapper<ICamApiModelItem>)). Changing them later does not retroactively update existing weld points.

Inheritance

object

ModelFormerWithPointWeldingItemsHelper

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 ModelFormerWithPointWeldingItemsHelper

Methods

AddMoveItemAfter(ComWrapper<ICamApiModelFormerWithPointWeldingItems>, ComWrapper<ICamApiModelItem>)

Insert a new move point after the given item.

Declaration

public static ComWrapper<ICamApiPointWeldingMoveItem> AddMoveItemAfter(this ComWrapper<ICamApiModelFormerWithPointWeldingItems> formerCom, ComWrapper<ICamApiModelItem> afterItem)

Parameters

Type	Name	Description
ComWrapper<ICamApiModelFormerWithPointWeldingItems>	formerCom
ComWrapper<ICamApiModelItem>	afterItem

Returns

Type	Description
ComWrapper<ICamApiPointWeldingMoveItem>

AddMoveItemBefore(ComWrapper<ICamApiModelFormerWithPointWeldingItems>, ComWrapper<ICamApiModelItem>)

Insert a new move point before the given item.

Declaration

public static ComWrapper<ICamApiPointWeldingMoveItem> AddMoveItemBefore(this ComWrapper<ICamApiModelFormerWithPointWeldingItems> formerCom, ComWrapper<ICamApiModelItem> beforeItem)

Parameters

Type	Name	Description
ComWrapper<ICamApiModelFormerWithPointWeldingItems>	formerCom
ComWrapper<ICamApiModelItem>	beforeItem

Returns

Type	Description
ComWrapper<ICamApiPointWeldingMoveItem>

AddWeldItemAfter(ComWrapper<ICamApiModelFormerWithPointWeldingItems>, ComWrapper<ICamApiModelItem>)

Insert a new weld point after the given item.

Declaration

public static ComWrapper<ICamApiPointWeldingWeldItem> AddWeldItemAfter(this ComWrapper<ICamApiModelFormerWithPointWeldingItems> formerCom, ComWrapper<ICamApiModelItem> afterItem)

Parameters

Type	Name	Description
ComWrapper<ICamApiModelFormerWithPointWeldingItems>	formerCom
ComWrapper<ICamApiModelItem>	afterItem

Returns

Type	Description
ComWrapper<ICamApiPointWeldingWeldItem>

AddWeldItemBefore(ComWrapper<ICamApiModelFormerWithPointWeldingItems>, ComWrapper<ICamApiModelItem>)

Insert a new weld point before the given item.

Declaration

public static ComWrapper<ICamApiPointWeldingWeldItem> AddWeldItemBefore(this ComWrapper<ICamApiModelFormerWithPointWeldingItems> formerCom, ComWrapper<ICamApiModelItem> beforeItem)

Parameters

Type	Name	Description
ComWrapper<ICamApiModelFormerWithPointWeldingItems>	formerCom
ComWrapper<ICamApiModelItem>	beforeItem

Returns

Type	Description
ComWrapper<ICamApiPointWeldingWeldItem>

ClearItems(ComWrapper<ICamApiModelFormerWithPointWeldingItems>)

Remove all move and weld points.

Declaration

public static void ClearItems(this ComWrapper<ICamApiModelFormerWithPointWeldingItems> formerCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiModelFormerWithPointWeldingItems>	formerCom

ClearanceAngle(ComWrapper<ICamApiModelFormerWithPointWeldingItems>)

Declaration

public static double ClearanceAngle(this ComWrapper<ICamApiModelFormerWithPointWeldingItems> com)

Parameters

Type	Name	Description
ComWrapper<ICamApiModelFormerWithPointWeldingItems>	com

Returns

Type	Description
double

ClearanceLength(ComWrapper<ICamApiModelFormerWithPointWeldingItems>)

Declaration

public static double ClearanceLength(this ComWrapper<ICamApiModelFormerWithPointWeldingItems> com)

Parameters

Type	Name	Description
ComWrapper<ICamApiModelFormerWithPointWeldingItems>	com

Returns

Type	Description
double

ClearanceMotionType(ComWrapper<ICamApiModelFormerWithPointWeldingItems>)

Declaration

public static TModelFormerPointWeldingMotionType ClearanceMotionType(this ComWrapper<ICamApiModelFormerWithPointWeldingItems> com)

Parameters

Type	Name	Description
ComWrapper<ICamApiModelFormerWithPointWeldingItems>	com

Returns

Type	Description
TModelFormerPointWeldingMotionType

ClearancePosType(ComWrapper<ICamApiModelFormerWithPointWeldingItems>)

Declaration

public static TModelFormerPointWeldingPositionType ClearancePosType(this ComWrapper<ICamApiModelFormerWithPointWeldingItems> com)

Parameters

Type	Name	Description
ComWrapper<ICamApiModelFormerWithPointWeldingItems>	com

Returns

Type	Description
TModelFormerPointWeldingPositionType

DeleteItem(ComWrapper<ICamApiModelFormerWithPointWeldingItems>, ComWrapper<ICamApiModelItem>)

Delete a move or weld point. Auto-created clearance/engage/retract sub-points cannot be deleted.

Declaration

public static void DeleteItem(this ComWrapper<ICamApiModelFormerWithPointWeldingItems> formerCom, ComWrapper<ICamApiModelItem> item)

Parameters

Type	Name	Description
ComWrapper<ICamApiModelFormerWithPointWeldingItems>	formerCom
ComWrapper<ICamApiModelItem>	item

EngageAngle(ComWrapper<ICamApiModelFormerWithPointWeldingItems>)

Declaration

public static double EngageAngle(this ComWrapper<ICamApiModelFormerWithPointWeldingItems> com)

Parameters

Type	Name	Description
ComWrapper<ICamApiModelFormerWithPointWeldingItems>	com

Returns

Type	Description
double

EngageLength(ComWrapper<ICamApiModelFormerWithPointWeldingItems>)

Declaration

public static double EngageLength(this ComWrapper<ICamApiModelFormerWithPointWeldingItems> com)

Parameters

Type	Name	Description
ComWrapper<ICamApiModelFormerWithPointWeldingItems>	com

Returns

Type	Description
double

EngageMotionType(ComWrapper<ICamApiModelFormerWithPointWeldingItems>)

Declaration

public static TModelFormerPointWeldingMotionType EngageMotionType(this ComWrapper<ICamApiModelFormerWithPointWeldingItems> com)

Parameters

Type	Name	Description
ComWrapper<ICamApiModelFormerWithPointWeldingItems>	com

Returns

Type	Description
TModelFormerPointWeldingMotionType

EngagePosType(ComWrapper<ICamApiModelFormerWithPointWeldingItems>)

Declaration

public static TModelFormerPointWeldingPositionType EngagePosType(this ComWrapper<ICamApiModelFormerWithPointWeldingItems> com)

Parameters

Type	Name	Description
ComWrapper<ICamApiModelFormerWithPointWeldingItems>	com

Returns

Type	Description
TModelFormerPointWeldingPositionType

FixVX(ComWrapper<ICamApiModelFormerWithPointWeldingItems>)

Declaration

public static bool FixVX(this ComWrapper<ICamApiModelFormerWithPointWeldingItems> com)

Parameters

Type	Name	Description
ComWrapper<ICamApiModelFormerWithPointWeldingItems>	com

Returns

Type	Description
bool

GetMoveItem(ComWrapper<ICamApiModelFormerWithPointWeldingItems>, int)

Get move point by 0-based index (among move points only).

Declaration

public static ComWrapper<ICamApiPointWeldingMoveItem> GetMoveItem(this ComWrapper<ICamApiModelFormerWithPointWeldingItems> formerCom, int index)

Parameters

Type	Name	Description
ComWrapper<ICamApiModelFormerWithPointWeldingItems>	formerCom
int	index

Returns

Type	Description
ComWrapper<ICamApiPointWeldingMoveItem>

GetMoveItemCount(ComWrapper<ICamApiModelFormerWithPointWeldingItems>)

Number of move points.

Declaration

public static int GetMoveItemCount(this ComWrapper<ICamApiModelFormerWithPointWeldingItems> formerCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiModelFormerWithPointWeldingItems>	formerCom

Returns

Type	Description
int

GetWeldItem(ComWrapper<ICamApiModelFormerWithPointWeldingItems>, int)

Get weld point by 0-based index (among weld points only).

Declaration

public static ComWrapper<ICamApiPointWeldingWeldItem> GetWeldItem(this ComWrapper<ICamApiModelFormerWithPointWeldingItems> formerCom, int index)

Parameters

Type	Name	Description
ComWrapper<ICamApiModelFormerWithPointWeldingItems>	formerCom
int	index

Returns

Type	Description
ComWrapper<ICamApiPointWeldingWeldItem>

GetWeldItemCount(ComWrapper<ICamApiModelFormerWithPointWeldingItems>)

Number of weld points.

Declaration

public static int GetWeldItemCount(this ComWrapper<ICamApiModelFormerWithPointWeldingItems> formerCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiModelFormerWithPointWeldingItems>	formerCom

Returns

Type	Description
int

MoveItems(ComWrapper<ICamApiModelFormerWithPointWeldingItems>)

Enumerate all move points in order.

Declaration

public static IEnumerable<ComWrapper<ICamApiPointWeldingMoveItem>> MoveItems(this ComWrapper<ICamApiModelFormerWithPointWeldingItems> formerCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiModelFormerWithPointWeldingItems>	formerCom

Returns

Type	Description
IEnumerable<ComWrapper<ICamApiPointWeldingMoveItem>>

RetractAngle(ComWrapper<ICamApiModelFormerWithPointWeldingItems>)

Declaration

public static double RetractAngle(this ComWrapper<ICamApiModelFormerWithPointWeldingItems> com)

Parameters

Type	Name	Description
ComWrapper<ICamApiModelFormerWithPointWeldingItems>	com

Returns

Type	Description
double

RetractLength(ComWrapper<ICamApiModelFormerWithPointWeldingItems>)

Declaration

public static double RetractLength(this ComWrapper<ICamApiModelFormerWithPointWeldingItems> com)

Parameters

Type	Name	Description
ComWrapper<ICamApiModelFormerWithPointWeldingItems>	com

Returns

Type	Description
double

RetractMotionType(ComWrapper<ICamApiModelFormerWithPointWeldingItems>)

Declaration

public static TModelFormerPointWeldingMotionType RetractMotionType(this ComWrapper<ICamApiModelFormerWithPointWeldingItems> com)

Parameters

Type	Name	Description
ComWrapper<ICamApiModelFormerWithPointWeldingItems>	com

Returns

Type	Description
TModelFormerPointWeldingMotionType

RetractPosType(ComWrapper<ICamApiModelFormerWithPointWeldingItems>)

Declaration

public static TModelFormerPointWeldingPositionType RetractPosType(this ComWrapper<ICamApiModelFormerWithPointWeldingItems> com)

Parameters

Type	Name	Description
ComWrapper<ICamApiModelFormerWithPointWeldingItems>	com

Returns

Type	Description
TModelFormerPointWeldingPositionType

SetClearanceAngle(ComWrapper<ICamApiModelFormerWithPointWeldingItems>, double)

Declaration

public static void SetClearanceAngle(this ComWrapper<ICamApiModelFormerWithPointWeldingItems> com, double value)

Parameters

Type	Name	Description
ComWrapper<ICamApiModelFormerWithPointWeldingItems>	com
double	value

SetClearanceLength(ComWrapper<ICamApiModelFormerWithPointWeldingItems>, double)

Declaration

public static void SetClearanceLength(this ComWrapper<ICamApiModelFormerWithPointWeldingItems> com, double value)

Parameters

Type	Name	Description
ComWrapper<ICamApiModelFormerWithPointWeldingItems>	com
double	value

SetClearanceMotionType(ComWrapper<ICamApiModelFormerWithPointWeldingItems>, TModelFormerPointWeldingMotionType)

Declaration

public static void SetClearanceMotionType(this ComWrapper<ICamApiModelFormerWithPointWeldingItems> com, TModelFormerPointWeldingMotionType value)

Parameters

Type	Name	Description
ComWrapper<ICamApiModelFormerWithPointWeldingItems>	com
TModelFormerPointWeldingMotionType	value

SetClearancePosType(ComWrapper<ICamApiModelFormerWithPointWeldingItems>, TModelFormerPointWeldingPositionType)

Declaration

public static void SetClearancePosType(this ComWrapper<ICamApiModelFormerWithPointWeldingItems> com, TModelFormerPointWeldingPositionType value)

Parameters

Type	Name	Description
ComWrapper<ICamApiModelFormerWithPointWeldingItems>	com
TModelFormerPointWeldingPositionType	value

SetEngageAngle(ComWrapper<ICamApiModelFormerWithPointWeldingItems>, double)

Declaration

public static void SetEngageAngle(this ComWrapper<ICamApiModelFormerWithPointWeldingItems> com, double value)

Parameters

Type	Name	Description
ComWrapper<ICamApiModelFormerWithPointWeldingItems>	com
double	value

SetEngageLength(ComWrapper<ICamApiModelFormerWithPointWeldingItems>, double)

Declaration

public static void SetEngageLength(this ComWrapper<ICamApiModelFormerWithPointWeldingItems> com, double value)

Parameters

Type	Name	Description
ComWrapper<ICamApiModelFormerWithPointWeldingItems>	com
double	value

SetEngageMotionType(ComWrapper<ICamApiModelFormerWithPointWeldingItems>, TModelFormerPointWeldingMotionType)

Declaration

public static void SetEngageMotionType(this ComWrapper<ICamApiModelFormerWithPointWeldingItems> com, TModelFormerPointWeldingMotionType value)

Parameters

Type	Name	Description
ComWrapper<ICamApiModelFormerWithPointWeldingItems>	com
TModelFormerPointWeldingMotionType	value

SetEngagePosType(ComWrapper<ICamApiModelFormerWithPointWeldingItems>, TModelFormerPointWeldingPositionType)

Declaration

public static void SetEngagePosType(this ComWrapper<ICamApiModelFormerWithPointWeldingItems> com, TModelFormerPointWeldingPositionType value)

Parameters

Type	Name	Description
ComWrapper<ICamApiModelFormerWithPointWeldingItems>	com
TModelFormerPointWeldingPositionType	value

SetFixVX(ComWrapper<ICamApiModelFormerWithPointWeldingItems>, bool)

Declaration

public static void SetFixVX(this ComWrapper<ICamApiModelFormerWithPointWeldingItems> com, bool value)

Parameters

Type	Name	Description
ComWrapper<ICamApiModelFormerWithPointWeldingItems>	com
bool	value

SetRetractAngle(ComWrapper<ICamApiModelFormerWithPointWeldingItems>, double)

Declaration

public static void SetRetractAngle(this ComWrapper<ICamApiModelFormerWithPointWeldingItems> com, double value)

Parameters

Type	Name	Description
ComWrapper<ICamApiModelFormerWithPointWeldingItems>	com
double	value

SetRetractLength(ComWrapper<ICamApiModelFormerWithPointWeldingItems>, double)

Declaration

public static void SetRetractLength(this ComWrapper<ICamApiModelFormerWithPointWeldingItems> com, double value)

Parameters

Type	Name	Description
ComWrapper<ICamApiModelFormerWithPointWeldingItems>	com
double	value

SetRetractMotionType(ComWrapper<ICamApiModelFormerWithPointWeldingItems>, TModelFormerPointWeldingMotionType)

Declaration

public static void SetRetractMotionType(this ComWrapper<ICamApiModelFormerWithPointWeldingItems> com, TModelFormerPointWeldingMotionType value)

Parameters

Type	Name	Description
ComWrapper<ICamApiModelFormerWithPointWeldingItems>	com
TModelFormerPointWeldingMotionType	value

SetRetractPosType(ComWrapper<ICamApiModelFormerWithPointWeldingItems>, TModelFormerPointWeldingPositionType)

Declaration

public static void SetRetractPosType(this ComWrapper<ICamApiModelFormerWithPointWeldingItems> com, TModelFormerPointWeldingPositionType value)

Parameters

Type	Name	Description
ComWrapper<ICamApiModelFormerWithPointWeldingItems>	com
TModelFormerPointWeldingPositionType	value

WeldItems(ComWrapper<ICamApiModelFormerWithPointWeldingItems>)

Enumerate all weld points in order.

Declaration

public static IEnumerable<ComWrapper<ICamApiPointWeldingWeldItem>> WeldItems(this ComWrapper<ICamApiModelFormerWithPointWeldingItems> formerCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiModelFormerWithPointWeldingItems>	formerCom

Returns

Type	Description
IEnumerable<ComWrapper<ICamApiPointWeldingWeldItem>>