CAM API
  • CAM API
v20.0.1
Search Results for

    Show / Hide Table of Contents

    Interface ICamApiMachineEvaluator

    Machine evaluator - stores state of machine and can solve kinematic problems

    Namespace: CAMAPI.Machine
    Assembly: CAMAPI.Machine.dll
    Syntax
    [Guid("B14BEFD9-E63F-4E87-BA5B-0AEC1AA97F46")]
    [InterfaceType(ComInterfaceType.InterfaceIsIUnknown)]
    public interface ICamApiMachineEvaluator

    Properties

    ActiveSpindleIndex

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

    Declaration
    int ActiveSpindleIndex { get; }
    Property Value
    Type Description
    int

    AxisCount

    Number of axes in the machine schema. Axes are shared across all channels; per-channel state of an axis can be read with GetAxisValue.

    Declaration
    int AxisCount { get; }
    Property Value
    Type Description
    int

    ChannelCount

    Number of simulation channels addressed by ChannelFeed.

    Declaration
    int ChannelCount { get; }
    Property Value
    Type Description
    int

    IsRobot

    Whether the machine schema is a robot (robot flips and rails apply).

    Declaration
    bool IsRobot { get; }
    Property Value
    Type Description
    bool

    NextPosOutOfLimits

    True when the position found by the last CalcNextPos call is unreachable: either no solution was found, or an axis, a robot joint or a positioner axis is beyond its limit. This is the same check that turns an axis value red in the machine control panel.

    Declaration
    bool NextPosOutOfLimits { get; }
    Property Value
    Type Description
    bool

    RailCount

    Number of redundant robot rail axes.

    Declaration
    int RailCount { get; }
    Property Value
    Type Description
    int

    SpindleCount

    Number of spindles in the machine schema.

    Declaration
    int SpindleCount { get; }
    Property Value
    Type Description
    int

    TCPMEnabled

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

    Declaration
    bool TCPMEnabled { get; set; }
    Property Value
    Type Description
    bool

    Methods

    CalcNextPos(TST5DPoint, bool, bool, bool)

    Declaration
    bool CalcNextPos(TST5DPoint p, bool Alternate, bool CheckAllVariants, bool IgnoreRailsLimits)
    Parameters
    Type Name Description
    TST5DPoint p
    bool Alternate
    bool CheckAllVariants
    bool IgnoreRailsLimits
    Returns
    Type Description
    bool

    CalcNextPos5D(TST5DPoint, bool, bool, bool)

    Declaration
    bool CalcNextPos5D(TST5DPoint p, bool Alternate, bool CheckAllVariants, bool IgnoreRailsLimits)
    Parameters
    Type Name Description
    TST5DPoint p
    bool Alternate
    bool CheckAllVariants
    bool IgnoreRailsLimits
    Returns
    Type Description
    bool

    CalcNextPos6D(TST3DMatrix, bool, bool)

    Declaration
    bool CalcNextPos6D(TST3DMatrix p, bool Alternate, bool CheckAllVariants)
    Parameters
    Type Name Description
    TST3DMatrix p
    bool Alternate
    bool CheckAllVariants
    Returns
    Type Description
    bool

    GeomToNC(TST3DMatrix)

    Declaration
    TST3DMatrix GeomToNC(TST3DMatrix matrix)
    Parameters
    Type Name Description
    TST3DMatrix matrix
    Returns
    Type Description
    TST3DMatrix

    GetAbsoluteMatrix()

    Get the absolute position of the current tool's coordinate system relative to the current workpiece coordinate system

    Declaration
    TST3DMatrix GetAbsoluteMatrix()
    Returns
    Type Description
    TST3DMatrix

    GetAxisDefined(int)

    Declaration
    bool GetAxisDefined(int Index)
    Parameters
    Type Name Description
    int Index
    Returns
    Type Description
    bool

    GetAxisInfo(int)

    Declaration
    TCamApiMachineAxisInfo GetAxisInfo(int Index)
    Parameters
    Type Name Description
    int Index
    Returns
    Type Description
    TCamApiMachineAxisInfo

    GetAxisValue(int)

    Declaration
    double GetAxisValue(int Index)
    Parameters
    Type Name Description
    int Index
    Returns
    Type Description
    double

    GetChannelFeed(int)

    Declaration
    TCamApiChannelFeedState GetChannelFeed(int ChannelIndex)
    Parameters
    Type Name Description
    int ChannelIndex
    Returns
    Type Description
    TCamApiChannelFeedState

    GetCurrentWorkpieceCSID()

    Returns the current workpiece CS (G54) identifier, "G54" for example.

    Declaration
    string GetCurrentWorkpieceCSID()
    Returns
    Type Description
    string

    GetCurrentWorkpieceCSMatrix()

    Returns the current workpiece CS (G54) matrix relative to the workpiece connector.

    Declaration
    TST3DMatrix GetCurrentWorkpieceCSMatrix()
    Returns
    Type Description
    TST3DMatrix

    GetCurrentWorkpieceCSWorldMatrix()

    Returns the current workpiece CS (G54) matrix relative to the world CS. The result depends on TCPM mode.

    Declaration
    TST3DMatrix GetCurrentWorkpieceCSWorldMatrix()
    Returns
    Type Description
    TST3DMatrix

    GetFlip(TCamApiRobotFlip)

    Declaration
    bool GetFlip(TCamApiRobotFlip Flip)
    Parameters
    Type Name Description
    TCamApiRobotFlip Flip
    Returns
    Type Description
    bool

    GetRailControlMode(int)

    Declaration
    TCamApiRailControlMode GetRailControlMode(int Index)
    Parameters
    Type Name Description
    int Index
    Returns
    Type Description
    TCamApiRailControlMode

    GetSpindleSpeed(int)

    Declaration
    TCamApiSpindleSpeedState GetSpindleSpeed(int SpindleIndex)
    Parameters
    Type Name Description
    int SpindleIndex
    Returns
    Type Description
    TCamApiSpindleSpeedState

    GetWorldWorkpieceConnectorMatrix(int)

    Declaration
    TST3DMatrix GetWorldWorkpieceConnectorMatrix(int WorkpieceConnectorIndex)
    Parameters
    Type Name Description
    int WorkpieceConnectorIndex
    Returns
    Type Description
    TST3DMatrix

    NCToGeom(TST3DMatrix)

    Declaration
    TST3DMatrix NCToGeom(TST3DMatrix matrix)
    Parameters
    Type Name Description
    TST3DMatrix matrix
    Returns
    Type Description
    TST3DMatrix

    PutNextPosInLimits()

    Bring the position computed by CalcNextPos into the axis travel limits, choosing full turns for periodic axes. Returns false if no in-limits solution exists.

    Declaration
    bool PutNextPosInLimits()
    Returns
    Type Description
    bool

    SetAxisDefined(int, bool)

    Declaration
    void SetAxisDefined(int Index, bool Defined)
    Parameters
    Type Name Description
    int Index
    bool Defined

    SetAxisValue(int, double)

    Declaration
    void SetAxisValue(int Index, double Value)
    Parameters
    Type Name Description
    int Index
    double Value

    SetFlip(TCamApiRobotFlip, bool)

    Declaration
    void SetFlip(TCamApiRobotFlip Flip, bool Value)
    Parameters
    Type Name Description
    TCamApiRobotFlip Flip
    bool Value

    SetNextPos(bool)

    Declaration
    void SetNextPos(bool RotaryOnly)
    Parameters
    Type Name Description
    bool RotaryOnly

    SetRailControlMode(int, TCamApiRailControlMode)

    Declaration
    void SetRailControlMode(int Index, TCamApiRailControlMode Mode)
    Parameters
    Type Name Description
    int Index
    TCamApiRailControlMode Mode
    In this article