Class MachineEvaluatorHelper

Helper methods for ICamIpcMachineEvaluator.

Obtained either from ICamIpcMachine.CreateEvaluator (a standalone kinematic solver) or from ICamIpcMcdChannel.GetMachineEvaluator (the live evaluator of the simulation cursor). For the live evaluator use the read methods (AbsoluteMatrix(ComWrapper<ICamIpcMachineEvaluator>), CurrentWorkpieceCSWorldMatrix(ComWrapper<ICamIpcMachineEvaluator>)) to query the current tool position; the mutating methods (SetNextPos(ComWrapper<ICamIpcMachineEvaluator>, bool), CalcNextPos5D(ComWrapper<ICamIpcMachineEvaluator>, TST5DPoint, bool, bool, bool), SetTcpmEnabled(ComWrapper<ICamIpcMachineEvaluator>, bool)) act on the live simulation machine state.

Inheritance

object

MachineEvaluatorHelper

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 MachineEvaluatorHelper

Methods

AbsoluteMatrix(ComWrapper<ICamIpcMachineEvaluator>)

Tool control-point matrix in the workpiece (geometric) coordinate system.

Declaration

public static TST3DMatrix AbsoluteMatrix(this ComWrapper<ICamIpcMachineEvaluator> evalCom)

Parameters

Type	Name	Description
ComWrapper<ICamIpcMachineEvaluator>	evalCom

Returns

Type	Description
TST3DMatrix

ActiveSpindleIndex(ComWrapper<ICamIpcMachineEvaluator>)

Index of the currently active spindle, or -1 if no spindle is active.

Declaration

public static int ActiveSpindleIndex(this ComWrapper<ICamIpcMachineEvaluator> evalCom)

Parameters

Type	Name	Description
ComWrapper<ICamIpcMachineEvaluator>	evalCom

Returns

Type	Description
int

AxisCount(ComWrapper<ICamIpcMachineEvaluator>)

Number of axes in the machine schema. Axes are shared across all channels; per-channel state of an axis is read with AxisValue(ComWrapper<ICamIpcMachineEvaluator>, int).

Declaration

public static int AxisCount(this ComWrapper<ICamIpcMachineEvaluator> evalCom)

Parameters

Type	Name	Description
ComWrapper<ICamIpcMachineEvaluator>	evalCom

Returns

Type	Description
int

AxisInfo(ComWrapper<ICamIpcMachineEvaluator>, int)

Static info about the axis at the given index (0..AxisCount-1).

Declaration

public static TCamApiMachineAxisInfo AxisInfo(this ComWrapper<ICamIpcMachineEvaluator> evalCom, int index)

Parameters

Type	Name	Description
ComWrapper<ICamIpcMachineEvaluator>	evalCom
int	index

Returns

Type	Description
TCamApiMachineAxisInfo

AxisValue(ComWrapper<ICamIpcMachineEvaluator>, int)

Live value of the axis at the given index (0..AxisCount-1) for the current simulation frame.

Declaration

public static double AxisValue(this ComWrapper<ICamIpcMachineEvaluator> evalCom, int index)

Parameters

Type	Name	Description
ComWrapper<ICamIpcMachineEvaluator>	evalCom
int	index

Returns

Type	Description
double

CalcNextPos(ComWrapper<ICamIpcMachineEvaluator>, TST5DPoint, bool, bool, bool)

Calculate machine position by 5D point and AngleAroundTool. Apply with SetNextPos(ComWrapper<ICamIpcMachineEvaluator>, bool). Returns true if a solution was found.

Declaration

public static bool CalcNextPos(this ComWrapper<ICamIpcMachineEvaluator> evalCom, TST5DPoint p, bool alternate, bool checkAllVariants, bool ignoreRailsLimits)

Parameters

Type	Name	Description
ComWrapper<ICamIpcMachineEvaluator>	evalCom
TST5DPoint	p
bool	alternate
bool	checkAllVariants
bool	ignoreRailsLimits

Returns

Type	Description
bool

CalcNextPos5D(ComWrapper<ICamIpcMachineEvaluator>, TST5DPoint, bool, bool, bool)

Calculate machine position by 5D point. Apply the result with SetNextPos(ComWrapper<ICamIpcMachineEvaluator>, bool). Returns true if a solution was found.

Declaration

public static bool CalcNextPos5D(this ComWrapper<ICamIpcMachineEvaluator> evalCom, TST5DPoint p, bool alternate, bool checkAllVariants, bool ignoreRailsLimits)

Parameters

Type	Name	Description
ComWrapper<ICamIpcMachineEvaluator>	evalCom
TST5DPoint	p
bool	alternate
bool	checkAllVariants
bool	ignoreRailsLimits

Returns

Type	Description
bool

CalcNextPos6D(ComWrapper<ICamIpcMachineEvaluator>, TST3DMatrix, bool, bool)

Calculate machine position by 6D point (matrix). Apply with SetNextPos(ComWrapper<ICamIpcMachineEvaluator>, bool). Returns true if a solution was found.

Declaration

public static bool CalcNextPos6D(this ComWrapper<ICamIpcMachineEvaluator> evalCom, TST3DMatrix matrix, bool alternate, bool checkAllVariants)

Parameters

Type	Name	Description
ComWrapper<ICamIpcMachineEvaluator>	evalCom
TST3DMatrix	matrix
bool	alternate
bool	checkAllVariants

Returns

Type	Description
bool

ChannelCount(ComWrapper<ICamIpcMachineEvaluator>)

Number of simulation channels addressed by ChannelFeed(ComWrapper<ICamIpcMachineEvaluator>, int).

Declaration

public static int ChannelCount(this ComWrapper<ICamIpcMachineEvaluator> evalCom)

Parameters

Type	Name	Description
ComWrapper<ICamIpcMachineEvaluator>	evalCom

Returns

Type	Description
int

ChannelFeed(ComWrapper<ICamIpcMachineEvaluator>, int)

Current feedrate state of the channel at the given index (0..ChannelCount-1).

Declaration

public static TCamApiChannelFeedState ChannelFeed(this ComWrapper<ICamIpcMachineEvaluator> evalCom, int channelIndex)

Parameters

Type	Name	Description
ComWrapper<ICamIpcMachineEvaluator>	evalCom
int	channelIndex

Returns

Type	Description
TCamApiChannelFeedState

CurrentWorkpieceCSID(ComWrapper<ICamIpcMachineEvaluator>)

Current workpiece CS (G54) identifier, "G54" for example.

Declaration

public static string CurrentWorkpieceCSID(this ComWrapper<ICamIpcMachineEvaluator> evalCom)

Parameters

Type	Name	Description
ComWrapper<ICamIpcMachineEvaluator>	evalCom

Returns

Type	Description
string

CurrentWorkpieceCSMatrix(ComWrapper<ICamIpcMachineEvaluator>)

Current workpiece CS (G54) matrix relative to the workpiece connector.

Declaration

public static TST3DMatrix CurrentWorkpieceCSMatrix(this ComWrapper<ICamIpcMachineEvaluator> evalCom)

Parameters

Type	Name	Description
ComWrapper<ICamIpcMachineEvaluator>	evalCom

Returns

Type	Description
TST3DMatrix

CurrentWorkpieceCSWorldMatrix(ComWrapper<ICamIpcMachineEvaluator>)

Current workpiece CS (G54) matrix relative to the world CS (WCS). Depends on TCPM mode.

Declaration

public static TST3DMatrix CurrentWorkpieceCSWorldMatrix(this ComWrapper<ICamIpcMachineEvaluator> evalCom)

Parameters

Type	Name	Description
ComWrapper<ICamIpcMachineEvaluator>	evalCom

Returns

Type	Description
TST3DMatrix

GeomToNc(ComWrapper<ICamIpcMachineEvaluator>, TST3DMatrix)

Convert a matrix from the geometric coordinate system to the NC coordinate system.

Declaration

public static TST3DMatrix GeomToNc(this ComWrapper<ICamIpcMachineEvaluator> evalCom, TST3DMatrix matrix)

Parameters

Type	Name	Description
ComWrapper<ICamIpcMachineEvaluator>	evalCom
TST3DMatrix	matrix

Returns

Type	Description
TST3DMatrix

NcToGeom(ComWrapper<ICamIpcMachineEvaluator>, TST3DMatrix)

Convert a matrix from the NC coordinate system to the geometric coordinate system.

Declaration

public static TST3DMatrix NcToGeom(this ComWrapper<ICamIpcMachineEvaluator> evalCom, TST3DMatrix matrix)

Parameters

Type	Name	Description
ComWrapper<ICamIpcMachineEvaluator>	evalCom
TST3DMatrix	matrix

Returns

Type	Description
TST3DMatrix

SetNextPos(ComWrapper<ICamIpcMachineEvaluator>, bool)

Set the machine to the position computed by the previous CalcNextPos* call.

Declaration

public static void SetNextPos(this ComWrapper<ICamIpcMachineEvaluator> evalCom, bool rotaryOnly)

Parameters

Type	Name	Description
ComWrapper<ICamIpcMachineEvaluator>	evalCom
bool	rotaryOnly

SetTcpmEnabled(ComWrapper<ICamIpcMachineEvaluator>, bool)

Enable or disable the Tool center point management (TCPM) mode.

Declaration

public static void SetTcpmEnabled(this ComWrapper<ICamIpcMachineEvaluator> evalCom, bool value)

Parameters

Type	Name	Description
ComWrapper<ICamIpcMachineEvaluator>	evalCom
bool	value

SpindleCount(ComWrapper<ICamIpcMachineEvaluator>)

Number of spindles in the machine schema.

Declaration

public static int SpindleCount(this ComWrapper<ICamIpcMachineEvaluator> evalCom)

Parameters

Type	Name	Description
ComWrapper<ICamIpcMachineEvaluator>	evalCom

Returns

Type	Description
int

SpindleSpeed(ComWrapper<ICamIpcMachineEvaluator>, int)

Current speed state of the spindle at the given index (0..SpindleCount-1).

Declaration

public static TCamApiSpindleSpeedState SpindleSpeed(this ComWrapper<ICamIpcMachineEvaluator> evalCom, int spindleIndex)

Parameters

Type	Name	Description
ComWrapper<ICamIpcMachineEvaluator>	evalCom
int	spindleIndex

Returns

Type	Description
TCamApiSpindleSpeedState

TcpmEnabled(ComWrapper<ICamIpcMachineEvaluator>)

Current state of the Tool center point management (TCPM) mode.

Declaration

public static bool TcpmEnabled(this ComWrapper<ICamIpcMachineEvaluator> evalCom)

Parameters

Type	Name	Description
ComWrapper<ICamIpcMachineEvaluator>	evalCom

Returns

Type	Description
bool

WorldWorkpieceConnectorMatrix(ComWrapper<ICamIpcMachineEvaluator>, int)

World position of the workpiece connector with the specified index.

Declaration

public static TST3DMatrix WorldWorkpieceConnectorMatrix(this ComWrapper<ICamIpcMachineEvaluator> evalCom, int workpieceConnectorIndex)

Parameters

Type	Name	Description
ComWrapper<ICamIpcMachineEvaluator>	evalCom
int	workpieceConnectorIndex

Returns

Type	Description
TST3DMatrix