Class ProjectHelper

Helper methods for ICamApiProject

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: CAMAPI.DotnetHelper

Assembly: CAMAPI.DotnetHelper.dll

Syntax

public static class ProjectHelper

Methods

CAMAPIGeomModel(ComWrapper<ICamApiProject>)

Geometrical model

Declaration

public static ComWrapper<ICAMAPIGeometryModel> CAMAPIGeomModel(this ComWrapper<ICamApiProject> projectCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiProject>	projectCom

Returns

Type	Description
ComWrapper<ICAMAPIGeometryModel>

CoordinateSystems(ComWrapper<ICamApiProject>)

List of coordinate systems

Declaration

public static ComWrapper<ICamApiListCoordinateSystem> CoordinateSystems(this ComWrapper<ICamApiProject> projectCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiProject>	projectCom

Returns

Type	Description
ComWrapper<ICamApiListCoordinateSystem>

FeatureFinder(ComWrapper<ICamApiProject>)

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

Declaration

public static ComWrapper<ICamApiFeatureFinder> FeatureFinder(this ComWrapper<ICamApiProject> projectCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiProject>	projectCom

Returns

Type	Description
ComWrapper<ICamApiFeatureFinder>

FilePath(ComWrapper<ICamApiProject>)

Path to project file

Declaration

public static string FilePath(this ComWrapper<ICamApiProject> projectCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiProject>	projectCom

Returns

Type	Description
string

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

Generate NC program (postprocessing). Universal: post type is detected from postProcessorFilePath extension (.dll = dotnet, else sppx). OutputFolder + NcFileName apply to sppx posts; for dotnet the settings (including its own output folder) come from settingsXml, which is written to a temp file and passed as SettingsFilePath. CLData covers all operations.

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamApiProject>	projectCom
string	postProcessorFilePath
string	outputFolder
string	ncFileName
string	settingsXml

GeomImporter(ComWrapper<ICamApiProject>)

Geometrical files importer

Declaration

public static ComWrapper<ICAMAPIGeometryImporter> GeomImporter(this ComWrapper<ICamApiProject> projectCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiProject>	projectCom

Returns

Type	Description
ComWrapper<ICAMAPIGeometryImporter>

Id(ComWrapper<ICamApiProject>)

Unique identifier of project

Declaration

public static string Id(this ComWrapper<ICamApiProject> projectCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiProject>	projectCom

Returns

Type	Description
string

IsModified(ComWrapper<ICamApiProject>)

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

Declaration

public static bool IsModified(this ComWrapper<ICamApiProject> projectCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiProject>	projectCom

Returns

Type	Description
bool

LoadMachineFromXmlProp(ComWrapper<ICamApiProject>)

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<ICamApiProject> projectCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiProject>	projectCom

Machine(ComWrapper<ICamApiProject>)

Get machine instance

Declaration

public static ComWrapper<ICamApiMachine> Machine(this ComWrapper<ICamApiProject> projectCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiProject>	projectCom

Returns

Type	Description
ComWrapper<ICamApiMachine>

MachineInformation(ComWrapper<ICamApiProject>)

Global properties about the project's machine

Declaration

public static ComWrapper<ICamApiMachineInfo> MachineInformation(this ComWrapper<ICamApiProject> projectCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiProject>	projectCom

Returns

Type	Description
ComWrapper<ICamApiMachineInfo>

NCMaker(ComWrapper<ICamApiProject>)

NC maker of project

Declaration

public static ComWrapper<ICamApiNCMaker> NCMaker(this ComWrapper<ICamApiProject> projectCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiProject>	projectCom

Returns

Type	Description
ComWrapper<ICamApiNCMaker>

PLMConnectionId(ComWrapper<ICamApiProject>)

Unique identifier of the PLM connection, if the project was loaded from PLM

Declaration

public static Guid PLMConnectionId(this ComWrapper<ICamApiProject> projectCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiProject>	projectCom

Returns

Type	Description
Guid

PLMItemId(ComWrapper<ICamApiProject>)

Unique identifier of the project inside PLM system, if the project was loaded from PLM

Declaration

public static string PLMItemId(this ComWrapper<ICamApiProject> projectCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiProject>	projectCom

Returns

Type	Description
string

SaveCLDataInfo(ComWrapper<ICamApiProject>, string, ComWrapper<ICamApiTechOperationIterator>?)

Creates new file with CLData and returns the list of operations used to generate it

Declaration

public static ComWrapper<ICamApiNCMakerCLDataInfo> SaveCLDataInfo(this ComWrapper<ICamApiProject> projectCom, string outputFileName, ComWrapper<ICamApiTechOperationIterator>? operationsIterator = null)

Parameters

Type	Name	Description
ComWrapper<ICamApiProject>	projectCom
string	outputFileName
ComWrapper<ICamApiTechOperationIterator>	operationsIterator

Returns

Type	Description
ComWrapper<ICamApiNCMakerCLDataInfo>

SaveClData(ComWrapper<ICamApiProject>, string, ComWrapper<ICamApiTechOperationIterator>?)

Create new file with CLData (will overwrite existing file)

Declaration

public static void SaveClData(this ComWrapper<ICamApiProject> projectCom, string outputFileName, ComWrapper<ICamApiTechOperationIterator>? operationsIterator = null)

Parameters

Type	Name	Description
ComWrapper<ICamApiProject>	projectCom	Project
string	outputFileName	Path to file
ComWrapper<ICamApiTechOperationIterator>	operationsIterator	Iterator of operations to save (may be null)

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

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

Declaration

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

Parameters

Type	Name	Description
ComWrapper<ICamApiProject>	projectCom
Guid	guid
string	filePath
string	typeName

SetOperationTool(ComWrapper<ICamApiProject>, string, string)

Set tool for operation

Declaration

public static void SetOperationTool(this ComWrapper<ICamApiProject> projectCom, string operationID, string toolID)

Parameters

Type	Name	Description
ComWrapper<ICamApiProject>	projectCom	Project
string	operationID	Operation identifier
string	toolID	Tool identifier

SimulationTolerances(ComWrapper<ICamApiProject>)

Simulation tolerance settings of the project

Declaration

public static ComWrapper<ICamApiSimulationTolerances> SimulationTolerances(this ComWrapper<ICamApiProject> projectCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiProject>	projectCom

Returns

Type	Description
ComWrapper<ICamApiSimulationTolerances>

Simulator(ComWrapper<ICamApiProject>)

Manager of simulation of the project

Declaration

public static ComWrapper<ICamApiSimulator> Simulator(this ComWrapper<ICamApiProject> projectCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiProject>	projectCom

Returns

Type	Description
ComWrapper<ICamApiSimulator>

Snapshots(ComWrapper<ICamApiProject>)

List of snapshots

Declaration

public static ComWrapper<IListCamApiSnapshot> Snapshots(this ComWrapper<ICamApiProject> projectCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiProject>	projectCom

Returns

Type	Description
ComWrapper<IListCamApiSnapshot>

Technologist(ComWrapper<ICamApiProject>)

Technology of project

Declaration

public static ComWrapper<ICamApiTechnologist> Technologist(this ComWrapper<ICamApiProject> projectCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiProject>	projectCom

Returns

Type	Description
ComWrapper<ICamApiTechnologist>

ToolsList(ComWrapper<ICamApiProject>)

The list of machining tools used in the project

Declaration

public static ComWrapper<ICamApiMachiningToolsList> ToolsList(this ComWrapper<ICamApiProject> projectCom)

Parameters

Type	Name	Description
ComWrapper<ICamApiProject>	projectCom

Returns

Type	Description
ComWrapper<ICamApiMachiningToolsList>