Class ApplicationHelper

Helper functions for ICamIpcApplication

Inheritance

object

ApplicationHelper

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 ApplicationHelper

Methods

Close(ComWrapper<ICamIpcApplication>, bool)

Close CAM application

Declaration

public static ComWrapper<IListString> Close(this ComWrapper<ICamIpcApplication> app, bool asyncMode)

Parameters

Type	Name	Description
ComWrapper<ICamIpcApplication>	app
bool	asyncMode

Returns

Type	Description
ComWrapper<IListString>

CreateListener(ComWrapper<ICamIpcApplication>)

Create listener for events from CAM application

Declaration

public static ComWrapper<ICamIpcEventListener> CreateListener(this ComWrapper<ICamIpcApplication> app)

Parameters

Type	Name	Description
ComWrapper<ICamIpcApplication>	app

Returns

Type	Description
ComWrapper<ICamIpcEventListener>

ExecutablePath(ComWrapper<ICamIpcApplication>)

Path to executable file

Declaration

public static string ExecutablePath(this ComWrapper<ICamIpcApplication> app)

Parameters

Type	Name	Description
ComWrapper<ICamIpcApplication>	app

Returns

Type	Description
string

ExportCurrentProject(ComWrapper<ICamIpcApplication>, string, bool)

Export current project

Declaration

public static void ExportCurrentProject(this ComWrapper<ICamIpcApplication> app, string targetFileName, bool overwrite)

Parameters

Type	Name	Description
ComWrapper<ICamIpcApplication>	app
string	targetFileName
bool	overwrite

ExtensionManager(ComWrapper<ICamIpcApplication>)

Returns the extension manager

Declaration

public static ComWrapper<IIpcExtensionManager> ExtensionManager(this ComWrapper<ICamIpcApplication> app)

Parameters

Type	Name	Description
ComWrapper<ICamIpcApplication>	app

Returns

Type	Description
ComWrapper<IIpcExtensionManager>

GetDefaultListener(ComWrapper<ICamIpcApplication>)

Return instance of default listener for events from CAM application

Declaration

public static ComWrapper<ICamIpcEventListener> GetDefaultListener(this ComWrapper<ICamIpcApplication> app)

Parameters

Type	Name	Description
ComWrapper<ICamIpcApplication>	app

Returns

Type	Description
ComWrapper<ICamIpcEventListener>

GetLogFilePath(ComWrapper<ICamIpcApplication>)

Return path to log file of CAM application

Declaration

public static string GetLogFilePath(this ComWrapper<ICamIpcApplication> app)

Parameters

Type	Name	Description
ComWrapper<ICamIpcApplication>	app

Returns

Type	Description
string

GetMainFormTimeOut(ComWrapper<ICamIpcApplication>, int)

Return main form of CAM application with timeout

Declaration

public static ComWrapper<ICamIpcApplicationMainForm> GetMainFormTimeOut(this ComWrapper<ICamIpcApplication> app, int timeout)

Parameters

Type	Name	Description
ComWrapper<ICamIpcApplication>	app
int	timeout

Returns

Type	Description
ComWrapper<ICamIpcApplicationMainForm>

GetMainWorkMode(ComWrapper<ICamIpcApplication>)

Return main work mode of CAM application

Declaration

public static TMainWorkMode GetMainWorkMode(this ComWrapper<ICamIpcApplication> app)

Parameters

Type	Name	Description
ComWrapper<ICamIpcApplication>	app

Returns

Type	Description
TMainWorkMode

GetPort(ComWrapper<ICamIpcApplication>)

Get IPC port of CAM application

Declaration

public static int GetPort(this ComWrapper<ICamIpcApplication> app)

Parameters

Type	Name	Description
ComWrapper<ICamIpcApplication>	app

Returns

Type	Description
int

IsAlive(ComWrapper<ICamIpcApplication>)

Is instance of CAM application running and can answer on IPC requests

Declaration

public static bool IsAlive(this ComWrapper<ICamIpcApplication> app)

Parameters

Type	Name	Description
ComWrapper<ICamIpcApplication>	app

Returns

Type	Description
bool

IsBusy(ComWrapper<ICamIpcApplication>)

Is instance of CAM is in process of answering on any IPC request

Declaration

public static bool IsBusy(this ComWrapper<ICamIpcApplication> app)

Parameters

Type	Name	Description
ComWrapper<ICamIpcApplication>	app

Returns

Type	Description
bool

IsWindowed(ComWrapper<ICamIpcApplication>)

Instance is windowed or not

Declaration

public static bool IsWindowed(this ComWrapper<ICamIpcApplication> app)

Parameters

Type	Name	Description
ComWrapper<ICamIpcApplication>	app

Returns

Type	Description
bool

MachinesLibrary(ComWrapper<ICamIpcApplication>)

Manager over library of machines of CAM system

Declaration

public static ComWrapper<ICamIpcMachinesLibrary> MachinesLibrary(this ComWrapper<ICamIpcApplication> app)

Parameters

Type	Name	Description
ComWrapper<ICamIpcApplication>	app

Returns

Type	Description
ComWrapper<ICamIpcMachinesLibrary>

MachiningToolsManager(ComWrapper<ICamIpcApplication>)

Return the machining tools manager

Declaration

public static ComWrapper<ICamIpcMachiningToolsManager> MachiningToolsManager(this ComWrapper<ICamIpcApplication> app)

Parameters

Type	Name	Description
ComWrapper<ICamIpcApplication>	app

Returns

Type	Description
ComWrapper<ICamIpcMachiningToolsManager>

MacroManager(ComWrapper<ICamIpcApplication>)

Object to manage all macros inside CAM application

Declaration

public static ComWrapper<ICamIpcMacroManager> MacroManager(this ComWrapper<ICamIpcApplication> app)

Parameters

Type	Name	Description
ComWrapper<ICamIpcApplication>	app

Returns

Type	Description
ComWrapper<ICamIpcMacroManager>

MainForm(ComWrapper<ICamIpcApplication>)

Main window handle

Declaration

public static ComWrapper<ICamIpcApplicationMainForm> MainForm(this ComWrapper<ICamIpcApplication> app)

Parameters

Type	Name	Description
ComWrapper<ICamIpcApplication>	app

Returns

Type	Description
ComWrapper<ICamIpcApplicationMainForm>

OpenProject(ComWrapper<ICamIpcApplication>, string, bool)

Open project

Declaration

public static void OpenProject(this ComWrapper<ICamIpcApplication> app, string fileName, bool addToReOpen)

Parameters

Type	Name	Description
ComWrapper<ICamIpcApplication>	app
string	fileName
bool	addToReOpen

OpenProjectFromPLM(ComWrapper<ICamIpcApplication>, string, string)

Open project from PLM

Declaration

public static void OpenProjectFromPLM(this ComWrapper<ICamIpcApplication> app, string plmItemId, string connectionId)

Parameters

Type	Name	Description
ComWrapper<ICamIpcApplication>	app
string	plmItemId
string	connectionId

PLMManager(ComWrapper<ICamIpcApplication>)

Return the PLM manager

Declaration

public static ComWrapper<IIpcPLMManager> PLMManager(this ComWrapper<ICamIpcApplication> app)

Parameters

Type	Name	Description
ComWrapper<ICamIpcApplication>	app

Returns

Type	Description
ComWrapper<IIpcPLMManager>

Paths(ComWrapper<ICamIpcApplication>)

Access to paths, used in CAM application

Declaration

public static ComWrapper<ICamIpcPaths> Paths(this ComWrapper<ICamIpcApplication> app)

Parameters

Type	Name	Description
ComWrapper<ICamIpcApplication>	app

Returns

Type	Description
ComWrapper<ICamIpcPaths>

ProcessId(ComWrapper<ICamIpcApplication>)

Return process ID of CAM application

Declaration

public static int ProcessId(this ComWrapper<ICamIpcApplication> app)

Parameters

Type	Name	Description
ComWrapper<ICamIpcApplication>	app

Returns

Type	Description
int

Project(ComWrapper<ICamIpcApplication>)

Return the active project

Declaration

public static ComWrapper<ICamIpcProject> Project(this ComWrapper<ICamIpcApplication> app)

Parameters

Type	Name	Description
ComWrapper<ICamIpcApplication>	app

Returns

Type	Description
ComWrapper<ICamIpcProject>

RegisterHandler(ComWrapper<ICamIpcApplication>, string, ICamIpcEventHandler, ICamIpcEventListener)

Register handler for events from CAM application

Declaration

public static void RegisterHandler(this ComWrapper<ICamIpcApplication> app, string handlerIdent, ICamIpcEventHandler handler, ICamIpcEventListener listener)

Parameters

Type	Name	Description
ComWrapper<ICamIpcApplication>	app
string	handlerIdent
ICamIpcEventHandler	handler
ICamIpcEventListener	listener

RegisterWorkingThread(ComWrapper<ICamIpcApplication>, int)

Register working thread in CAM application

Declaration

public static void RegisterWorkingThread(this ComWrapper<ICamIpcApplication> app, int threadHandle)

Parameters

Type	Name	Description
ComWrapper<ICamIpcApplication>	app
int	threadHandle

SaveCurrentProject(ComWrapper<ICamIpcApplication>, string)

Save current project

Declaration

public static void SaveCurrentProject(this ComWrapper<ICamIpcApplication> app, string fileName)

Parameters

Type	Name	Description
ComWrapper<ICamIpcApplication>	app
string	fileName

SetActiveProjectMachine(ComWrapper<ICamIpcApplication>, ICamIpcMachineInfo)

Set active project machine

Declaration

public static void SetActiveProjectMachine(this ComWrapper<ICamIpcApplication> app, ICamIpcMachineInfo machineInfo)

Parameters

Type	Name	Description
ComWrapper<ICamIpcApplication>	app
ICamIpcMachineInfo	machineInfo

SetMainWorkMode(ComWrapper<ICamIpcApplication>, TMainWorkMode)

Set main work mode of CAM application

Declaration

public static void SetMainWorkMode(this ComWrapper<ICamIpcApplication> app, TMainWorkMode workMode)

Parameters

Type	Name	Description
ComWrapper<ICamIpcApplication>	app
TMainWorkMode	workMode

StartAsyncWork(ComWrapper<ICamIpcApplication>)

Start async work in CAM application

Declaration

public static void StartAsyncWork(this ComWrapper<ICamIpcApplication> app)

Parameters

Type	Name	Description
ComWrapper<ICamIpcApplication>	app

StopAsyncWork(ComWrapper<ICamIpcApplication>)

Stop async work in CAM application

Declaration

public static void StopAsyncWork(this ComWrapper<ICamIpcApplication> app)

Parameters

Type	Name	Description
ComWrapper<ICamIpcApplication>	app

UnregisterHandler(ComWrapper<ICamIpcApplication>, string)

Unregister handler for events from CAM application

Declaration

public static void UnregisterHandler(this ComWrapper<ICamIpcApplication> app, string handlerIdent)

Parameters

Type	Name	Description
ComWrapper<ICamIpcApplication>	app
string	handlerIdent

UnregisterWorkingThread(ComWrapper<ICamIpcApplication>, int)

Unregister working thread in CAM application

Declaration

public static void UnregisterWorkingThread(this ComWrapper<ICamIpcApplication> app, int threadHandle)

Parameters

Type	Name	Description
ComWrapper<ICamIpcApplication>	app
int	threadHandle

UserTechOperationList(ComWrapper<ICamIpcApplication>)

List of user operations available to be created in the current technologist

Declaration

public static ComWrapper<ICamIpcUserTechOperationList> UserTechOperationList(this ComWrapper<ICamIpcApplication> app)

Parameters

Type	Name	Description
ComWrapper<ICamIpcApplication>	app

Returns

Type	Description
ComWrapper<ICamIpcUserTechOperationList>

UtilityManager(ComWrapper<ICamIpcApplication>)

Return the utility manager

Declaration

public static ComWrapper<ICamIpcUtilityManager> UtilityManager(this ComWrapper<ICamIpcApplication> app)

Parameters

Type	Name	Description
ComWrapper<ICamIpcApplication>	app

Returns

Type	Description
ComWrapper<ICamIpcUtilityManager>

WaitForStarted(ComWrapper<ICamIpcApplication>, int)

Wait for CAM application to start

Declaration

public static void WaitForStarted(this ComWrapper<ICamIpcApplication> app, int timeout)

Parameters

Type	Name	Description
ComWrapper<ICamIpcApplication>	app
int	timeout