CAM API
  • CAM API
v20.0.1
Search Results for

    Show / Hide Table of Contents

    Interface ICamIpcMachinesLibrary

    Access to machines library in CAM API

    Namespace: CAMIPC.MachinesLibrary
    Assembly: CAMIPC.MachinesLibrary.dll
    Syntax
    [Guid("90BF22A4-5253-46D1-AF7F-32E92EF5319B")]
    [InterfaceType(ComInterfaceType.InterfaceIsIUnknown)]
    public interface ICamIpcMachinesLibrary

    Properties

    CurrentMachine

    Current project machine (read-only)

    Declaration
    ICamIpcMachineInfo CurrentMachine { get; }
    Property Value
    Type Description
    ICamIpcMachineInfo

    Methods

    AddScanFolder(string)

    Add a user folder to scan for machine schemas. The folder is scanned immediately and persists across CAM restarts. Machines found in it become resolvable by FindMachine and visible in the standard machines window.

    Declaration
    void AddScanFolder(string Path)
    Parameters
    Type Name Description
    string Path

    FindMachine(Guid, string, string)

    Declaration
    ICamIpcMachineInfo FindMachine(Guid Guid, string FilePath, string TypeName)
    Parameters
    Type Name Description
    Guid Guid
    string FilePath
    string TypeName
    Returns
    Type Description
    ICamIpcMachineInfo

    GetInstanceId()

    Get unique identifier of current instance (used in IPC messages)

    Declaration
    string GetInstanceId()
    Returns
    Type Description
    string

    GetMachines()

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

    Declaration
    ICamIpcMachineInfoIterator GetMachines()
    Returns
    Type Description
    ICamIpcMachineInfoIterator

    GetScanFolders()

    Folders currently scanned for machine schemas. Not every machine of the library comes from them - see GetMachines

    Declaration
    IListString GetScanFolders()
    Returns
    Type Description
    IListString

    LoadMachineFromFile(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). The machine becomes resolvable by FindMachine and applicable via SetActiveProjectMachine for the current session. TypeName selects the root machine type; "" picks the first machine type in the file.

    Declaration
    ICamIpcMachineInfo LoadMachineFromFile(string SchemaFilePath, string TypeName)
    Parameters
    Type Name Description
    string SchemaFilePath
    string TypeName
    Returns
    Type Description
    ICamIpcMachineInfo

    RemoveScanFolder(string)

    Remove a previously added user scan folder

    Declaration
    void RemoveScanFolder(string Path)
    Parameters
    Type Name Description
    string Path

    Rescan()

    Re-index all scan folders from the file system, picking up schema files added or changed on disk since the last scan without restarting CAM

    Declaration
    void Rescan()
    In this article