Class MacroManagerHelper

Helper methods for ICamIpcMacroManager (IPC mirror of ICamApiMacroManager).

Inheritance

object

MacroManagerHelper

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 MacroManagerHelper

Methods

AddMacro(ComWrapper<ICamIpcMacroManager>, ComWrapper<ICamIpcMacroInfo>)

Register a prebuilt macro in the system.

Declaration

public static void AddMacro(this ComWrapper<ICamIpcMacroManager> managerCom, ComWrapper<ICamIpcMacroInfo> macro)

Parameters

Type	Name	Description
ComWrapper<ICamIpcMacroManager>	managerCom
ComWrapper<ICamIpcMacroInfo>	macro

Count(ComWrapper<ICamIpcMacroManager>)

Number of macros registered in the system

Declaration

public static int Count(this ComWrapper<ICamIpcMacroManager> managerCom)

Parameters

Type	Name	Description
ComWrapper<ICamIpcMacroManager>	managerCom

Returns

Type	Description
int

CreateMacroInstance(ComWrapper<ICamIpcMacroManager>)

Create a new empty macro instance (fill it and pass to AddMacro).

Declaration

public static ComWrapper<ICamIpcMacroInfo> CreateMacroInstance(this ComWrapper<ICamIpcMacroManager> managerCom)

Parameters

Type	Name	Description
ComWrapper<ICamIpcMacroManager>	managerCom

Returns

Type	Description
ComWrapper<ICamIpcMacroInfo>

Execute(ComWrapper<ICamIpcMacroManager>, string, string)

Execute macro by id. paramsJson is a JSON dictionary of user-overridden values: {"stepIndex": {"key": "value"}} (empty = run with recorded defaults).

Declaration

public static void Execute(this ComWrapper<ICamIpcMacroManager> managerCom, string id, string paramsJson = "")

Parameters

Type	Name	Description
ComWrapper<ICamIpcMacroManager>	managerCom
string	id
string	paramsJson

ExportMacro(ComWrapper<ICamIpcMacroManager>, string, string)

Export the macro with the given id into a self-contained .dmcr archive at targetPath.

Declaration

public static void ExportMacro(this ComWrapper<ICamIpcMacroManager> managerCom, string id, string targetPath)

Parameters

Type	Name	Description
ComWrapper<ICamIpcMacroManager>	managerCom
string	id
string	targetPath

GetMacro(ComWrapper<ICamIpcMacroManager>, int)

Get macro metadata by its index (0-based)

Declaration

public static ComWrapper<ICamIpcMacroInfo> GetMacro(this ComWrapper<ICamIpcMacroManager> managerCom, int index)

Parameters

Type	Name	Description
ComWrapper<ICamIpcMacroManager>	managerCom
int	index

Returns

Type	Description
ComWrapper<ICamIpcMacroInfo>

GetMacroBuilder(ComWrapper<ICamIpcMacroManager>)

The macro builder (create settings, feed commands, build).

Declaration

public static ComWrapper<ICamIpcMacroBuilder> GetMacroBuilder(this ComWrapper<ICamIpcMacroManager> managerCom)

Parameters

Type	Name	Description
ComWrapper<ICamIpcMacroManager>	managerCom

Returns

Type	Description
ComWrapper<ICamIpcMacroBuilder>

GetMacroById(ComWrapper<ICamIpcMacroManager>, string)

Get macro metadata by its unique ident

Declaration

public static ComWrapper<ICamIpcMacroInfo> GetMacroById(this ComWrapper<ICamIpcMacroManager> managerCom, string id)

Parameters

Type	Name	Description
ComWrapper<ICamIpcMacroManager>	managerCom
string	id

Returns

Type	Description
ComWrapper<ICamIpcMacroInfo>

ImportMacro(ComWrapper<ICamIpcMacroManager>, string)

Import a macro from a .dmcr archive (overwrites any macro with the same id). Returns the registered macro.

Declaration

public static ComWrapper<ICamIpcMacroInfo> ImportMacro(this ComWrapper<ICamIpcMacroManager> managerCom, string sourcePath)

Parameters

Type	Name	Description
ComWrapper<ICamIpcMacroManager>	managerCom
string	sourcePath

Returns

Type	Description
ComWrapper<ICamIpcMacroInfo>

NotifyMacroStep(ComWrapper<ICamIpcMacroManager>, int)

Declaration

public static void NotifyMacroStep(this ComWrapper<ICamIpcMacroManager> managerCom, int stepIndex)

Parameters

Type	Name	Description
ComWrapper<ICamIpcMacroManager>	managerCom
int	stepIndex

OpenInEditor(ComWrapper<ICamIpcMacroManager>, ComWrapper<ICamIpcMacroInfo>)

Declaration

public static void OpenInEditor(this ComWrapper<ICamIpcMacroManager> managerCom, ComWrapper<ICamIpcMacroInfo> macro)

Parameters

Type	Name	Description
ComWrapper<ICamIpcMacroManager>	managerCom
ComWrapper<ICamIpcMacroInfo>	macro

RemoveMacro(ComWrapper<ICamIpcMacroManager>, string, bool)

Declaration

public static void RemoveMacro(this ComWrapper<ICamIpcMacroManager> managerCom, string id, bool deleteSources)

Parameters

Type	Name	Description
ComWrapper<ICamIpcMacroManager>	managerCom
string	id
bool	deleteSources