Class ProjectHelper

Helper functions for ICamIpcProject

Inheritance

object

ProjectHelper

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 ProjectHelper

Methods

FeatureFinder(ComWrapper<ICamIpcProject>)

Feature finder — provides access to recognized features of the current project

Declaration

public static ComWrapper<ICamIpcFeatureFinder> FeatureFinder(this ComWrapper<ICamIpcProject> project)

Parameters

Type	Name	Description
ComWrapper<ICamIpcProject>	project

Returns

Type	Description
ComWrapper<ICamIpcFeatureFinder>

FilePath(ComWrapper<ICamIpcProject>)

Path to the project file — the file the user opened. A project on an external source (network path, removable drive, cloud folder) is copied to a temp folder and saved back to the source, but the path reported here stays the source one

Declaration

public static string FilePath(this ComWrapper<ICamIpcProject> project)

Parameters

Type	Name	Description
ComWrapper<ICamIpcProject>	project

Returns

Type	Description
string

GenerateNCProgram(ComWrapper<ICamIpcProject>, string, string, string, string)

Generate NC program (postprocessing) the same way the postprocessing window does: CLData covers the operations included in the NC program, operations excluded from it are skipped. Post type is detected from postProcessorFilePath extension (.dll = dotnet, else sppx)

Declaration

public static void GenerateNCProgram(this ComWrapper<ICamIpcProject> project, string postProcessorFilePath, string outputFolder, string ncFileName, string settingsXml)

Parameters

Type	Name	Description
ComWrapper<ICamIpcProject>	project
string	postProcessorFilePath
string	outputFolder
string	ncFileName
string	settingsXml

GeomImporter(ComWrapper<ICamIpcProject>)

Geometrical files importer

Declaration

public static ComWrapper<ICamIpcGeometryImporter> GeomImporter(this ComWrapper<ICamIpcProject> project)

Parameters

Type	Name	Description
ComWrapper<ICamIpcProject>	project

Returns

Type	Description
ComWrapper<ICamIpcGeometryImporter>

GeomModel(ComWrapper<ICamIpcProject>)

Geometrical model

Declaration

public static ComWrapper<ICamIpcGeometryModel> GeomModel(this ComWrapper<ICamIpcProject> project)

Parameters

Type	Name	Description
ComWrapper<ICamIpcProject>	project

Returns

Type	Description
ComWrapper<ICamIpcGeometryModel>

Id(ComWrapper<ICamIpcProject>)

Unique identifier of project

Declaration

public static string Id(this ComWrapper<ICamIpcProject> project)

Parameters

Type	Name	Description
ComWrapper<ICamIpcProject>	project

Returns

Type	Description
string

IsModified(ComWrapper<ICamIpcProject>)

True if the project has unsaved changes (live check, same condition that triggers the save prompt)

Declaration

public static bool IsModified(this ComWrapper<ICamIpcProject> project)

Parameters

Type	Name	Description
ComWrapper<ICamIpcProject>	project

Returns

Type	Description
bool

LoadMachineFromXmlProp(ComWrapper<ICamIpcProject>)

Rebuild the project machine from its current XML properties — the apply step for edits made through Machine.XMLProp. Also rebuilds the state derived from the machine.

Declaration

public static void LoadMachineFromXmlProp(this ComWrapper<ICamIpcProject> project)

Parameters

Type	Name	Description
ComWrapper<ICamIpcProject>	project

Machine(ComWrapper<ICamIpcProject>)

Machine of the project — kinematics, axes, tool and workpiece connectors

Declaration

public static ComWrapper<ICamIpcMachine> Machine(this ComWrapper<ICamIpcProject> project)

Parameters

Type	Name	Description
ComWrapper<ICamIpcProject>	project

Returns

Type	Description
ComWrapper<ICamIpcMachine>

NCMaker(ComWrapper<ICamIpcProject>)

NC maker of project

Declaration

public static ComWrapper<ICamIpcNCMaker> NCMaker(this ComWrapper<ICamIpcProject> project)

Parameters

Type	Name	Description
ComWrapper<ICamIpcProject>	project

Returns

Type	Description
ComWrapper<ICamIpcNCMaker>

PLMConnectionId(ComWrapper<ICamIpcProject>)

Identifier of the PLM connection the project came from; Guid.Empty when there is no PLM origin.

Declaration

public static Guid PLMConnectionId(this ComWrapper<ICamIpcProject> project)

Parameters

Type	Name	Description
ComWrapper<ICamIpcProject>	project

Returns

Type	Description
Guid

PLMItemId(ComWrapper<ICamIpcProject>)

Identifier of the project inside the PLM system it was loaded from; empty string when the project has no PLM origin. Use PLMConnectionId to tell which PLM system it belongs to.

Declaration

public static string PLMItemId(this ComWrapper<ICamIpcProject> project)

Parameters

Type	Name	Description
ComWrapper<ICamIpcProject>	project

Returns

Type	Description
string

SaveCLDataInfo(ComWrapper<ICamIpcProject>, string, ComWrapper<ICamIpcTechOperationIterator>?)

Create new file with CLData over the given operations and get information about it. The result is what NCMaker.GenerateNC takes. The file must have the inpcld extension

Declaration

public static ComWrapper<ICamIpcNCMakerCLDataInfo> SaveCLDataInfo(this ComWrapper<ICamIpcProject> project, string outputFileName, ComWrapper<ICamIpcTechOperationIterator>? operationsIteratorCom = null)

Parameters

Type	Name	Description
ComWrapper<ICamIpcProject>	project
string	outputFileName
ComWrapper<ICamIpcTechOperationIterator>	operationsIteratorCom

Returns

Type	Description
ComWrapper<ICamIpcNCMakerCLDataInfo>

SetMachine(ComWrapper<ICamIpcProject>, Guid, string, string)

Set machine for the project by guid, file path and type name

Declaration

public static void SetMachine(this ComWrapper<ICamIpcProject> project, Guid guid, string filePath, string typeName)

Parameters

Type	Name	Description
ComWrapper<ICamIpcProject>	project
Guid	guid
string	filePath
string	typeName

Simulator(ComWrapper<ICamIpcProject>)

Manager of simulation of the project

Declaration

public static ComWrapper<ICamIpcSimulator> Simulator(this ComWrapper<ICamIpcProject> project)

Parameters

Type	Name	Description
ComWrapper<ICamIpcProject>	project

Returns

Type	Description
ComWrapper<ICamIpcSimulator>

Snapshots(ComWrapper<ICamIpcProject>)

List of snapshots

Declaration

public static ComWrapper<IListCamIpcSnapshot> Snapshots(this ComWrapper<ICamIpcProject> project)

Parameters

Type	Name	Description
ComWrapper<ICamIpcProject>	project

Returns

Type	Description
ComWrapper<IListCamIpcSnapshot>

Technologist(ComWrapper<ICamIpcProject>)

Technology of project

Declaration

public static ComWrapper<ICamIpcTechnologist> Technologist(this ComWrapper<ICamIpcProject> project)

Parameters

Type	Name	Description
ComWrapper<ICamIpcProject>	project

Returns

Type	Description
ComWrapper<ICamIpcTechnologist>