Interface ICamIpcApplication
Instance of CAM application
Assembly: CAMIPC.Application.dll
Syntax
[Guid("5E2B8B0E-4B0A-4B7E-8B0A-5B4B7E8B0A5E")]
[InterfaceType(ComInterfaceType.InterfaceIsIUnknown)]
public interface ICamIpcApplication
Properties
ExecutablePath
Declaration
string ExecutablePath { get; }
Property Value
IsAlive
Is instance of CAM application running and can answer on IPC requests
Declaration
Property Value
IsAsyncWorkStarted
Is StartAsyncWork in effect, i.e. is this application listening for the
verdicts of its asynchronous commands right now.
Meant for code that needs the verdicts but does not own the lifetime -
a helper wrapping one call has to leave the listener exactly as it found
it, and stopping one the application started itself would cut it off from
its own answers.
Declaration
bool IsAsyncWorkStarted { get; }
Property Value
IsBusy
Is instance of CAM is in process of answering on any IPC request
Declaration
Property Value
IsMainFormReady
Is the main window created and published over IPC, i.e. will reading
MainForm succeed right now.
Deliberately narrower than IsAlive. IsAlive only reports that the CAM
application object exists and has Started; the main form is handed to the
IPC wrapper separately and later, so IsAlive can be True while MainForm is
still unavailable. Callers about to touch MainForm should test this and
never use IsAlive as a proxy for it.
Always False for a console instance, which has no main form at all.
Unlike WaitForStarted this neither blocks nor has side effects - it is a
plain state query, safe to poll.
Declared last on purpose - related to MainForm in meaning, but not placed
next to it. The interface keeps its IID, so members are addressed by
vtable slot and a new one may only be appended. Sitting beside MainForm,
this shifted every following slot and broke every caller built against
the previous layout. Add new members here, at the end.
Declaration
bool IsMainFormReady { get; }
Property Value
IsWindowed
Instance is windowed or not
Declaration
Property Value
LastActionIdleSeconds
Seconds elapsed since the last user input (mouse/keyboard) in the session
that runs the CAM application
Declaration
double LastActionIdleSeconds { get; }
Property Value
MachinesLibrary
Manager over library of machines of CAM system
Declaration
ICamIpcMachinesLibrary MachinesLibrary { get; }
Property Value
MacroManager
Object to manage all macros inside CAM application
Declaration
ICamIpcMacroManager MacroManager { get; }
Property Value
MainForm
Declaration
ICamIpcApplicationMainForm MainForm { get; }
Property Value
Paths
Access to paths, used in CAM application
Declaration
ICamIpcPaths Paths { get; }
Property Value
ProcessId
Declaration
Property Value
UserTechOperationList
List of user operations available to be created in the current technologist
Declaration
ICamIpcUserTechOperationList UserTechOperationList { get; }
Property Value
Methods
AskCamAgent(string, bool, int, ref TExecuteContext)
Declaration
string AskCamAgent(string message, bool interruptOnError, int timeoutMs, ref TExecuteContext ExecuteContext)
Parameters
Returns
Close(bool, out TResultStatus)
Declaration
IListString Close(bool AsyncMode, out TResultStatus ResultStatus)
Parameters
Returns
CreateListener(ref TExecuteContext)
Declaration
ICamIpcEventListener CreateListener(ref TExecuteContext ExecuteContext)
Parameters
Returns
ExportCurrentProject(string, bool, ref TExecuteContext)
Declaration
void ExportCurrentProject(string TargetFileName, bool Overwrite, ref TExecuteContext ExecuteContext)
Parameters
GetActiveProject(ref TExecuteContext)
Declaration
ICamIpcProject GetActiveProject(ref TExecuteContext ExecuteContext)
Parameters
Returns
GetDefaultListener()
Return instance of default listener for events from CAM application
Declaration
ICamIpcEventListener GetDefaultListener()
Returns
GetExtensionManager(ref TExecuteContext)
Declaration
IIpcExtensionManager GetExtensionManager(ref TExecuteContext ExecuteContext)
Parameters
Returns
GetLogFilePath(ref TExecuteContext)
Declaration
string GetLogFilePath(ref TExecuteContext ExecuteContext)
Parameters
Returns
GetMachiningToolsManager(ref TExecuteContext)
Declaration
ICamIpcMachiningToolsManager GetMachiningToolsManager(ref TExecuteContext ExecuteContext)
Parameters
Returns
GetMainFormTimeOut(int)
Declaration
ICamIpcApplicationMainForm GetMainFormTimeOut(int timeout)
Parameters
| Type |
Name |
Description |
| int |
timeout |
|
Returns
GetMainWorkMode(ref TExecuteContext)
Declaration
TMainWorkMode GetMainWorkMode(ref TExecuteContext ExecuteContext)
Parameters
Returns
GetPLMManager(ref TExecuteContext)
Declaration
IIpcPLMManager GetPLMManager(ref TExecuteContext ExecuteContext)
Parameters
Returns
GetPort(out TResultStatus)
Declaration
int GetPort(out TResultStatus ResultStatus)
Parameters
Returns
GetTheme(ref TExecuteContext)
Declaration
ICamIpcTheme GetTheme(ref TExecuteContext ExecuteContext)
Parameters
Returns
GetUtilityManager(ref TExecuteContext)
Declaration
ICamIpcUtilityManager GetUtilityManager(ref TExecuteContext ExecuteContext)
Parameters
Returns
ImportToolsFromFile(IListString, string, ref TExecuteContext)
Declaration
IListString ImportToolsFromFile(IListString FileNames, string OperationID, ref TExecuteContext ExecuteContext)
Parameters
Returns
ImportToolsFromPLM(string, IListString, string, string, ref TExecuteContext)
Declaration
IListString ImportToolsFromPLM(string ExtensionTypeId, IListString ItemIds, string ConnectionId, string OperationID, ref TExecuteContext ExecuteContext)
Parameters
Returns
OpenProject(string, bool, ref TExecuteContext)
Declaration
void OpenProject(string FileName, bool AddToReOpen, ref TExecuteContext ExecuteContext)
Parameters
OpenProjectFromPLM(string, string, ref TExecuteContext)
Declaration
void OpenProjectFromPLM(string PLMItemId, string ConnectionId, ref TExecuteContext ExecuteContext)
Parameters
RegisterHandler(string, ICamIpcEventHandler, ICamIpcEventListener, ref TExecuteContext)
Declaration
void RegisterHandler(string HandlerIdent, ICamIpcEventHandler Handler, ICamIpcEventListener Listener, ref TExecuteContext ExecuteContext)
Parameters
RegisterWorkingThread(int, out TResultStatus)
Declaration
void RegisterWorkingThread(int ThreadHandle, out TResultStatus ResultStatus)
Parameters
SaveCurrentProject(string, ref TExecuteContext)
Declaration
void SaveCurrentProject(string FileName, ref TExecuteContext ExecuteContext)
Parameters
SetActiveProjectMachine(ICamIpcMachineInfo, ref TExecuteContext)
Declaration
void SetActiveProjectMachine(ICamIpcMachineInfo MachineInfo, ref TExecuteContext ExecuteContext)
Parameters
SetMainWorkMode(TMainWorkMode, ref TExecuteContext)
Declaration
void SetMainWorkMode(TMainWorkMode WorkMode, ref TExecuteContext ExecuteContext)
Parameters
StartAsyncWork(out TResultStatus)
Declaration
void StartAsyncWork(out TResultStatus ResultStatus)
Parameters
StopAsyncWork(out TResultStatus)
Declaration
void StopAsyncWork(out TResultStatus ResultStatus)
Parameters
UnregisterHandler(string, ref TExecuteContext)
Declaration
void UnregisterHandler(string HandlerIdent, ref TExecuteContext ExecuteContext)
Parameters
UnregisterWorkingThread(int, out TResultStatus)
Declaration
void UnregisterWorkingThread(int ThreadHandle, out TResultStatus ResultStatus)
Parameters
WaitForAsyncWork(int, out TResultStatus)
Declaration
void WaitForAsyncWork(int timeout, out TResultStatus ResultStatus)
Parameters
WaitForStarted(int, out TResultStatus)
Declaration
void WaitForStarted(int timeout, out TResultStatus ResultStatus)
Parameters