Interface ICamApiMachineCLDReceiver

Machine-side command receiver. An aspect of the same object the solver receives as ICamApiCLDReceiver, found via QueryInterface. Present only when the host feeds the solver into the MCD former (machine CLData); nil on the geometric CLData path. Feeds, spindle, coolant, delay, compensations, current plane, comments and BeginItem/EndItem grouping stay on ICamApiCLDReceiver and are not duplicated here. Frames are appended in call order into the body section of the operation toolpath.

Namespace: CAMAPI.MCDFormerTypes

Assembly: CAMAPI.MCDFormerTypes.dll

Syntax

[Guid("58744EF8-5AE5-44C7-9600-E11B671EE5A7")]
[InterfaceType(ComInterfaceType.InterfaceIsIUnknown)]
public interface ICamApiMachineCLDReceiver

Properties

MachineEvaluator

The live machine evaluator of the former: kinematics, axis state, robot configuration. Valid for the duration of the solver call only; must not be stored.

Declaration

ICamApiMachineEvaluator MachineEvaluator { get; }

Property Value

Type	Description
ICamApiMachineEvaluator

Methods

AddAxisBrake(int, bool)

Declaration

void AddAxisBrake(int AxisIndex, bool Applied)

Parameters

Type	Name	Description
int	AxisIndex
bool	Applied

AddCallSub(int)

Declaration

void AddCallSub(int SubID)

Parameters

Type	Name	Description
int	SubID

AddClamp(int, bool)

Declaration

void AddClamp(int ClampID, bool Clamped)

Parameters

Type	Name	Description
int	ClampID
bool	Clamped

AddFrom(TST3DPoint)

Declaration

void AddFrom(TST3DPoint FromPoint)

Parameters

Type	Name	Description
TST3DPoint	FromPoint

AddGoHome(TST3DPoint)

Declaration

void AddGoHome(TST3DPoint HomePoint)

Parameters

Type	Name	Description
TST3DPoint	HomePoint

AddMotion(int, double)

Declaration

void AddMotion(int AxisIndex, double Value)

Parameters

Type	Name	Description
int	AxisIndex
double	Value

AddOrigin(TST3DMatrix, TCamApiLocalCSPositioningMode)

Declaration

void AddOrigin(TST3DMatrix M, TCamApiLocalCSPositioningMode PositioningMode)

Parameters

Type	Name	Description
TST3DMatrix	M
TCamApiLocalCSPositioningMode	PositioningMode

AddOriginByShift(TST3DMatrix)

Declaration

void AddOriginByShift(TST3DMatrix ShiftMatrix)

Parameters

Type	Name	Description
TST3DMatrix	ShiftMatrix

AddPPFunParam(int, double)

Declaration

void AddPPFunParam(int Index, double Value)

Parameters

Type	Name	Description
int	Index
double	Value

AddPartNo(string)

Append a program-name command (PARTNO).

Declaration

void AddPartNo(string Name)

Parameters

Type	Name	Description
string	Name

AddRapid()

Switch the following moves to the rapid feed (RAPID). The feed state of the evaluator is updated, so a later OutEvaluatorState emits the rapid frame.

Declaration

void AddRapid()

AddRotaryTable(bool, double, bool, int)

Declaration

void AddRotaryTable(bool Incremental, double Position, bool CounterClockwise, int Plane)

Parameters

Type	Name	Description
bool	Incremental
double	Position
bool	CounterClockwise
int	Plane

AddSafePos(int, TST3DPoint)

Declaration

void AddSafePos(int PointNumber, TST3DPoint SafePoint)

Parameters

Type	Name	Description
int	PointNumber
TST3DPoint	SafePoint

AddSelWorkpiece(string)

Append an active-workpiece command (SELWORKPIECE) for the holder with the given identifier. An empty identifier keeps the workpiece the machine evaluator holds.

Declaration

void AddSelWorkpiece(string WorkpieceHolderID)

Parameters

Type	Name	Description
string	WorkpieceHolderID

AddStop()

Append an unconditional program stop (STOP). The optional stop is AddOpStop on ICamApiCLDReceiver.

Declaration

void AddStop()

AddSyncAxes(bool, string, string)

Declaration

void AddSyncAxes(bool IsOn, string AxisID1, string AxisID2)

Parameters

Type	Name	Description
bool	IsOn
string	AxisID1
string	AxisID2

AddTakeover(int, string)

Declaration

void AddTakeover(int PartIndex, string WorkpieceHolderID)

Parameters

Type	Name	Description
int	PartIndex
string	WorkpieceHolderID

AddThread(int, int, double, double)

Declaration

void AddThread(int Orient, int LeadType, double Step, double StartAngle)

Parameters

Type	Name	Description
int	Orient
int	LeadType
double	Step
double	StartAngle

CloseMultiMotion()

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

Declaration

void CloseMultiMotion()

ClosePPFun()

Append the PPFUN command opened by OpenPPFun.

Declaration

void ClosePPFun()

EndMakeWorkPath()

Tell the host that nothing more will be appended, so the calculation waiting for this receiver can go on. This is the end of the same work a solver does inside ICamApiTechOperationSolver.MakeWorkPath - only there the end is the return from the call, and an application that got the receiver through the machine CLData event has no such return to be seen: the event is delivered asynchronously, and the calculation waits for this call instead of for the delivery. Not calling it is not fatal: the host stops waiting on its own timeout and keeps whatever was appended by then.

Declaration

void EndMakeWorkPath()

LoadTool(int)

Declaration

void LoadTool(int ToolNumber)

Parameters

Type	Name	Description
int	ToolNumber

OpenMultiMotion(TCamApiGotoMode)

Declaration

void OpenMultiMotion(TCamApiGotoMode mode)

Parameters

Type	Name	Description
TCamApiGotoMode	mode

OpenPPFun(int)

Declaration

void OpenPPFun(int SubCode)

Parameters

Type	Name	Description
int	SubCode

OutEvaluatorState(TCamApiGotoMode)

Declaration

void OutEvaluatorState(TCamApiGotoMode mode)

Parameters

Type	Name	Description
TCamApiGotoMode	mode

OutInterpolation(bool)

Declaration

void OutInterpolation(bool Enable)

Parameters

Type	Name	Description
bool	Enable

ResetOrigin()

Drop the local coordinate system appended last and go back to the previous one.

Declaration

void ResetOrigin()

SetInterpolationMode(TCamApiInterpolationMode)

Declaration

void SetInterpolationMode(TCamApiInterpolationMode mode)

Parameters

Type	Name	Description
TCamApiInterpolationMode	mode

SetTCPM(bool)

Declaration

void SetTCPM(bool IsOn)

Parameters

Type	Name	Description
bool	IsOn