Class MachinesLibraryHelper

Helper functions for ICamIpcMachinesLibrary

Inheritance

object

MachinesLibraryHelper

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 MachinesLibraryHelper

Methods

AddScanFolder(ComWrapper<ICamIpcMachinesLibrary>, string)

Add a user folder to scan for machine schemas (scanned immediately, persists across restarts)

Declaration

public static void AddScanFolder(this ComWrapper<ICamIpcMachinesLibrary> libCom, string path)

Parameters

Type	Name	Description
ComWrapper<ICamIpcMachinesLibrary>	libCom
string	path

CurrentMachine(ComWrapper<ICamIpcMachinesLibrary>)

Current project machine (read-only)

Declaration

public static ComWrapper<ICamIpcMachineInfo> CurrentMachine(this ComWrapper<ICamIpcMachinesLibrary> libCom)

Parameters

Type	Name	Description
ComWrapper<ICamIpcMachinesLibrary>	libCom

Returns

Type	Description
ComWrapper<ICamIpcMachineInfo>

EnumerateMachines(ComWrapper<ICamIpcMachinesLibrary>)

Enumerate all machines currently known to the library (indexed scan folders, registered files and machines of recently opened projects)

Declaration

public static IEnumerable<ComWrapper<ICamIpcMachineInfo>> EnumerateMachines(this ComWrapper<ICamIpcMachinesLibrary> libCom)

Parameters

Type	Name	Description
ComWrapper<ICamIpcMachinesLibrary>	libCom

Returns

Type	Description
IEnumerable<ComWrapper<ICamIpcMachineInfo>>

FindMachine(ComWrapper<ICamIpcMachinesLibrary>, Guid, string, string)

Try to find best matching machine by guid, optional filePath and typeName

Declaration

public static ComWrapper<ICamIpcMachineInfo> FindMachine(this ComWrapper<ICamIpcMachinesLibrary> libCom, Guid guid, string filePath, string typeName)

Parameters

Type	Name	Description
ComWrapper<ICamIpcMachinesLibrary>	libCom
Guid	guid
string	filePath
string	typeName

Returns

Type	Description
ComWrapper<ICamIpcMachineInfo>

LoadMachineFromFile(ComWrapper<ICamIpcMachinesLibrary>, string, string)

Load machine info directly from a schema file, bypassing the machines search tree. The file is read even when it is not registered in any scan folder and even when it has no MachineRegistrator block (MachineMaker/DMC export). typeName selects the root machine type; "" picks the first machine type in the file.

Declaration

public static ComWrapper<ICamIpcMachineInfo> LoadMachineFromFile(this ComWrapper<ICamIpcMachinesLibrary> libCom, string schemaFilePath, string typeName)

Parameters

Type	Name	Description
ComWrapper<ICamIpcMachinesLibrary>	libCom
string	schemaFilePath
string	typeName

Returns

Type	Description
ComWrapper<ICamIpcMachineInfo>

RemoveScanFolder(ComWrapper<ICamIpcMachinesLibrary>, string)

Remove a previously added user scan folder

Declaration

public static void RemoveScanFolder(this ComWrapper<ICamIpcMachinesLibrary> libCom, string path)

Parameters

Type	Name	Description
ComWrapper<ICamIpcMachinesLibrary>	libCom
string	path

Rescan(ComWrapper<ICamIpcMachinesLibrary>)

Re-index all scan folders from the file system without restarting ENCY

Declaration

public static void Rescan(this ComWrapper<ICamIpcMachinesLibrary> libCom)

Parameters

Type	Name	Description
ComWrapper<ICamIpcMachinesLibrary>	libCom

ScanFolders(ComWrapper<ICamIpcMachinesLibrary>)

Folders currently scanned for machine schemas. Not every machine of the library comes from them - see EnumerateMachines(ComWrapper<ICamIpcMachinesLibrary>)

Declaration

public static ComWrapper<IListString> ScanFolders(this ComWrapper<ICamIpcMachinesLibrary> libCom)

Parameters

Type	Name	Description
ComWrapper<ICamIpcMachinesLibrary>	libCom

Returns

Type	Description
ComWrapper<IListString>