Class MachineCLDReceiverHelper

Helper methods for ICamIpcMachineCLDReceiver — the machine-side aspect of the IPC CLData receiver.

NOT REACHABLE over IPC yet: the receiver lives only for the duration of a solver call, and a solver is an in-process CAMAPI plugin, so an external application is never handed one. Mirrored for the G-code interpreter, which will run on the same commands. From a plugin use CAMAPI.DotnetHelper.MachineCLDReceiverHelper instead.

Inheritance

object

MachineCLDReceiverHelper

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 MachineCLDReceiverHelper

Methods

AddAxisBrake(ComWrapper<ICamIpcMachineCLDReceiver>, int, bool)

Apply or release the brake of the axis at the given index (AXESBRAKE).

Declaration

public static void AddAxisBrake(this ComWrapper<ICamIpcMachineCLDReceiver> receiverCom, int axisIndex, bool applied)

Parameters

Type	Name	Description
ComWrapper<ICamIpcMachineCLDReceiver>	receiverCom
int	axisIndex
bool	applied

AddCallSub(ComWrapper<ICamIpcMachineCLDReceiver>, int)

Append a call of the subroutine with the given identifier (CALLSUB).

Declaration

public static void AddCallSub(this ComWrapper<ICamIpcMachineCLDReceiver> receiverCom, int subId)

Parameters

Type	Name	Description
ComWrapper<ICamIpcMachineCLDReceiver>	receiverCom
int	subId

AddClamp(ComWrapper<ICamIpcMachineCLDReceiver>, int, bool)

Append a clamp command (CLAMP): true clamps, false releases.

Declaration

public static void AddClamp(this ComWrapper<ICamIpcMachineCLDReceiver> receiverCom, int clampId, bool clamped)

Parameters

Type	Name	Description
ComWrapper<ICamIpcMachineCLDReceiver>	receiverCom
int	clampId
bool	clamped

AddFrom(ComWrapper<ICamIpcMachineCLDReceiver>, TST3DPoint)

Append a start-point command (FROM) at the given point.

Declaration

public static void AddFrom(this ComWrapper<ICamIpcMachineCLDReceiver> receiverCom, TST3DPoint fromPoint)

Parameters

Type	Name	Description
ComWrapper<ICamIpcMachineCLDReceiver>	receiverCom
TST3DPoint	fromPoint

AddGoHome(ComWrapper<ICamIpcMachineCLDReceiver>, TST3DPoint)

Append a go-home command (GOHOME) to the given point in machine coordinates.

Declaration

public static void AddGoHome(this ComWrapper<ICamIpcMachineCLDReceiver> receiverCom, TST3DPoint homePoint)

Parameters

Type	Name	Description
ComWrapper<ICamIpcMachineCLDReceiver>	receiverCom
TST3DPoint	homePoint

AddMotion(ComWrapper<ICamIpcMachineCLDReceiver>, int, double)

Set the value of one machine axis in the open frame.

Declaration

public static void AddMotion(this ComWrapper<ICamIpcMachineCLDReceiver> receiverCom, int axisIndex, double value)

Parameters

Type	Name	Description
ComWrapper<ICamIpcMachineCLDReceiver>	receiverCom
int	axisIndex
double	value

AddOrigin(ComWrapper<ICamIpcMachineCLDReceiver>, TST3DMatrix, TCamApiLocalCSPositioningMode)

Append a local coordinate system (ORIGIN) given by its matrix.

Declaration

public static void AddOrigin(this ComWrapper<ICamIpcMachineCLDReceiver> receiverCom, TST3DMatrix m, TCamApiLocalCSPositioningMode positioningMode)

Parameters

Type	Name	Description
ComWrapper<ICamIpcMachineCLDReceiver>	receiverCom
TST3DMatrix	m
TCamApiLocalCSPositioningMode	positioningMode

AddOriginByShift(ComWrapper<ICamIpcMachineCLDReceiver>, TST3DMatrix)

Append a local coordinate system (ORIGIN) given as a shift of the current one (G52).

Declaration

public static void AddOriginByShift(this ComWrapper<ICamIpcMachineCLDReceiver> receiverCom, TST3DMatrix shiftMatrix)

Parameters

Type	Name	Description
ComWrapper<ICamIpcMachineCLDReceiver>	receiverCom
TST3DMatrix	shiftMatrix

AddPPFun(ComWrapper<ICamIpcMachineCLDReceiver>, int, IReadOnlyDictionary<int, double>)

Append a postprocessor-function command (PPFUN) with the given subcode and parameters, indexed from 1 as the postprocessor numbers them.

Declaration

public static void AddPPFun(this ComWrapper<ICamIpcMachineCLDReceiver> receiverCom, int subCode, IReadOnlyDictionary<int, double> parameters)

Parameters

Type	Name	Description
ComWrapper<ICamIpcMachineCLDReceiver>	receiverCom
int	subCode
IReadOnlyDictionary<int, double>	parameters

AddPartNo(ComWrapper<ICamIpcMachineCLDReceiver>, string)

Append a program-name command (PARTNO).

Declaration

public static void AddPartNo(this ComWrapper<ICamIpcMachineCLDReceiver> receiverCom, string name)

Parameters

Type	Name	Description
ComWrapper<ICamIpcMachineCLDReceiver>	receiverCom
string	name

AddRapid(ComWrapper<ICamIpcMachineCLDReceiver>)

Switch the following moves to the rapid feed (RAPID).

Declaration

public static void AddRapid(this ComWrapper<ICamIpcMachineCLDReceiver> receiverCom)

Parameters

Type	Name	Description
ComWrapper<ICamIpcMachineCLDReceiver>	receiverCom

AddRotaryTable(ComWrapper<ICamIpcMachineCLDReceiver>, bool, double, bool, int)

Append a rotary-table positioning command (ROTABLE) for the given plane.

Declaration

public static void AddRotaryTable(this ComWrapper<ICamIpcMachineCLDReceiver> receiverCom, bool incremental, double position, bool counterClockwise, int plane)

Parameters

Type	Name	Description
ComWrapper<ICamIpcMachineCLDReceiver>	receiverCom
bool	incremental
double	position
bool	counterClockwise
int	plane

AddSafePos(ComWrapper<ICamIpcMachineCLDReceiver>, int, TST3DPoint)

Append a safe-position command (SAFPOS).

Declaration

public static void AddSafePos(this ComWrapper<ICamIpcMachineCLDReceiver> receiverCom, int pointNumber, TST3DPoint safePoint)

Parameters

Type	Name	Description
ComWrapper<ICamIpcMachineCLDReceiver>	receiverCom
int	pointNumber
TST3DPoint	safePoint

AddSelWorkpiece(ComWrapper<ICamIpcMachineCLDReceiver>, string)

Append an active-workpiece command (SELWORKPIECE) for the given holder.

Declaration

public static void AddSelWorkpiece(this ComWrapper<ICamIpcMachineCLDReceiver> receiverCom, string workpieceHolderId)

Parameters

Type	Name	Description
ComWrapper<ICamIpcMachineCLDReceiver>	receiverCom
string	workpieceHolderId

AddStop(ComWrapper<ICamIpcMachineCLDReceiver>)

Append an unconditional program stop (STOP).

Declaration

public static void AddStop(this ComWrapper<ICamIpcMachineCLDReceiver> receiverCom)

Parameters

Type	Name	Description
ComWrapper<ICamIpcMachineCLDReceiver>	receiverCom

AddSyncAxes(ComWrapper<ICamIpcMachineCLDReceiver>, bool, string, string)

Turn synchronization of the two axes on or off (SYNCAXES).

Declaration

public static void AddSyncAxes(this ComWrapper<ICamIpcMachineCLDReceiver> receiverCom, bool isOn, string axisId1, string axisId2)

Parameters

Type	Name	Description
ComWrapper<ICamIpcMachineCLDReceiver>	receiverCom
bool	isOn
string	axisId1
string	axisId2

AddTakeover(ComWrapper<ICamIpcMachineCLDReceiver>, int, string)

Append a workpiece-takeover command (TAKEOVER).

Declaration

public static void AddTakeover(this ComWrapper<ICamIpcMachineCLDReceiver> receiverCom, int partIndex, string workpieceHolderId)

Parameters

Type	Name	Description
ComWrapper<ICamIpcMachineCLDReceiver>	receiverCom
int	partIndex
string	workpieceHolderId

AddThread(ComWrapper<ICamIpcMachineCLDReceiver>, int, int, double, double)

Append a single-pass thread command (THREAD).

Declaration

public static void AddThread(this ComWrapper<ICamIpcMachineCLDReceiver> receiverCom, int orient, int leadType, double step, double startAngle)

Parameters

Type	Name	Description
ComWrapper<ICamIpcMachineCLDReceiver>	receiverCom
int	orient
int	leadType
double	step
double	startAngle

CloseMultiMotion(ComWrapper<ICamIpcMachineCLDReceiver>)

Close the frame opened by OpenMultiMotion and append it to the toolpath.

Declaration

public static void CloseMultiMotion(this ComWrapper<ICamIpcMachineCLDReceiver> receiverCom)

Parameters

Type	Name	Description
ComWrapper<ICamIpcMachineCLDReceiver>	receiverCom

EndMakeWorkPath(ComWrapper<ICamIpcMachineCLDReceiver>)

Tell ENCY that nothing more will be appended, so the calculation waiting for this receiver can go on. Call it as the last thing in the event handler.

Declaration

public static void EndMakeWorkPath(this ComWrapper<ICamIpcMachineCLDReceiver> receiverCom)

Parameters

Type	Name	Description
ComWrapper<ICamIpcMachineCLDReceiver>	receiverCom

LoadTool(ComWrapper<ICamIpcMachineCLDReceiver>, int)

Append a tool-load command for the tool with the given number.

Declaration

public static void LoadTool(this ComWrapper<ICamIpcMachineCLDReceiver> receiverCom, int toolNumber)

Parameters

Type	Name	Description
ComWrapper<ICamIpcMachineCLDReceiver>	receiverCom
int	toolNumber

MachineEvaluator(ComWrapper<ICamIpcMachineCLDReceiver>)

The live machine evaluator of the former.

Declaration

public static ComWrapper<ICamIpcMachineEvaluator> MachineEvaluator(this ComWrapper<ICamIpcMachineCLDReceiver> receiverCom)

Parameters

Type	Name	Description
ComWrapper<ICamIpcMachineCLDReceiver>	receiverCom

Returns

Type	Description
ComWrapper<ICamIpcMachineEvaluator>

OpenMultiMotion(ComWrapper<ICamIpcMachineCLDReceiver>, TCamApiGotoMode)

Begin a frame whose axis values are supplied by the caller via AddMotion.

Declaration

public static void OpenMultiMotion(this ComWrapper<ICamIpcMachineCLDReceiver> receiverCom, TCamApiGotoMode mode)

Parameters

Type	Name	Description
ComWrapper<ICamIpcMachineCLDReceiver>	receiverCom
TCamApiGotoMode	mode

OutEvaluatorState(ComWrapper<ICamIpcMachineCLDReceiver>, TCamApiGotoMode)

Append one frame built from the current state of the machine evaluator.

Declaration

public static void OutEvaluatorState(this ComWrapper<ICamIpcMachineCLDReceiver> receiverCom, TCamApiGotoMode mode)

Parameters

Type	Name	Description
ComWrapper<ICamIpcMachineCLDReceiver>	receiverCom
TCamApiGotoMode	mode

OutInterpolation(ComWrapper<ICamIpcMachineCLDReceiver>, bool)

Append the switch of the control system to the mode asked for (INTERP).

Declaration

public static void OutInterpolation(this ComWrapper<ICamIpcMachineCLDReceiver> receiverCom, bool enable)

Parameters

Type	Name	Description
ComWrapper<ICamIpcMachineCLDReceiver>	receiverCom
bool	enable

ResetOrigin(ComWrapper<ICamIpcMachineCLDReceiver>)

Drop the local coordinate system appended last.

Declaration

public static void ResetOrigin(this ComWrapper<ICamIpcMachineCLDReceiver> receiverCom)

Parameters

Type	Name	Description
ComWrapper<ICamIpcMachineCLDReceiver>	receiverCom

SetInterpolationMode(ComWrapper<ICamIpcMachineCLDReceiver>, TCamApiInterpolationMode)

Ask for the interpolation mode the following moves are output in.

Declaration

public static void SetInterpolationMode(this ComWrapper<ICamIpcMachineCLDReceiver> receiverCom, TCamApiInterpolationMode mode)

Parameters

Type	Name	Description
ComWrapper<ICamIpcMachineCLDReceiver>	receiverCom
TCamApiInterpolationMode	mode

SetTCPM(ComWrapper<ICamIpcMachineCLDReceiver>, bool)

Turn the tool centre point management of the control system on or off (RTCP).

Declaration

public static void SetTCPM(this ComWrapper<ICamIpcMachineCLDReceiver> receiverCom, bool isOn)

Parameters

Type	Name	Description
ComWrapper<ICamIpcMachineCLDReceiver>	receiverCom
bool	isOn