Interface ICamApiMacroCommandsManager

Object to save executing commands as sequence. Doesn't have any methods to return list of commands - implementing class should also implement ICamApiMacroBuildersManager

Namespace: CAMAPI.Macros

Assembly: CAMAPI.Macros.dll

Syntax

[Guid("1F6CAE66-4666-46C0-AFCD-1CF6171DEE5C")]
[InterfaceType(ComInterfaceType.InterfaceIsIUnknown)]
public interface ICamApiMacroCommandsManager

Properties

IsStarted

True while a recording session is active (between Start and Stop). Lets a UI or an external client query the recording state instead of tracking it locally.

Declaration

bool IsStarted { get; }

Property Value

Type	Description
bool

Methods

AddMachineState(out TResultStatus)

Declaration

void AddMachineState(out TResultStatus ret)

Parameters

Type	Name	Description
TResultStatus	ret

AddRecognizeFeature(out TResultStatus)

Declaration

void AddRecognizeFeature(out TResultStatus ret)

Parameters

Type	Name	Description
TResultStatus	ret

AddStrategyState(out TResultStatus)

Declaration

void AddStrategyState(out TResultStatus ret)

Parameters

Type	Name	Description
TResultStatus	ret

AddWorkpieceState(out TResultStatus)

Declaration

void AddWorkpieceState(out TResultStatus ret)

Parameters

Type	Name	Description
TResultStatus	ret

CreateCommandData(TMacroCommandType)

Declaration

ICamApiMacroCommandDataBuilder CreateCommandData(TMacroCommandType CommandType)

Parameters

Type	Name	Description
TMacroCommandType	CommandType

Returns

Type	Description
ICamApiMacroCommandDataBuilder

GetCommandSchema()

Get the schema provider — describes the field keys each command type expects.

Declaration

ICamApiMacroCommandSchema GetCommandSchema()

Returns

Type	Description
ICamApiMacroCommandSchema

RegisterCommand(ICamApiMacroCommandData)

Record a single macro command. CommandType in data identifies the operation; all field keys are defined per CommandType and are stable across versions.

Declaration

void RegisterCommand(ICamApiMacroCommandData data)

Parameters

Type	Name	Description
ICamApiMacroCommandData	data

Start(out TResultStatus)

Declaration

void Start(out TResultStatus ret)

Parameters

Type	Name	Description
TResultStatus	ret

Stop(out TResultStatus)

Declaration

void Stop(out TResultStatus ret)

Parameters

Type	Name	Description
TResultStatus	ret