Interface ICamApiProject

CAM project

Namespace: CAMAPI.Project

Assembly: CAMAPI.Project.dll

Syntax

[Guid("24317BEC-9E60-41CC-9A7A-59B7E167FDA0")]
[InterfaceType(ComInterfaceType.InterfaceIsIUnknown)]
public interface ICamApiProject

Properties

CAMAPIGeomModel

Geometrical model

Declaration

ICAMAPIGeometryModel CAMAPIGeomModel { get; }

Property Value

Type	Description
ICAMAPIGeometryModel

CoordinateSystems

List of coordinate systems

Declaration

ICamApiListCoordinateSystem CoordinateSystems { get; }

Property Value

Type	Description
ICamApiListCoordinateSystem

FeatureFinder

Feature finder of the project

Declaration

ICamApiFeatureFinder FeatureFinder { get; }

Property Value

Type	Description
ICamApiFeatureFinder

FilePath

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

string FilePath { get; }

Property Value

Type	Description
string

GeomImporter

Geometrical files importer

Declaration

ICAMAPIGeometryImporter GeomImporter { get; }

Property Value

Type	Description
ICAMAPIGeometryImporter

Id

Unique identifier of project

Declaration

string Id { get; }

Property Value

Type	Description
string

IsModified

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

Declaration

bool IsModified { get; }

Property Value

Type	Description
bool

Machine

Get machine instance

Declaration

ICamApiMachine Machine { get; }

Property Value

Type	Description
ICamApiMachine

MachineInformation

Global properties about the project's machine

Declaration

ICamApiMachineInfo MachineInformation { get; }

Property Value

Type	Description
ICamApiMachineInfo

NCMaker

NC maker of project

Declaration

ICamApiNCMaker NCMaker { get; }

Property Value

Type	Description
ICamApiNCMaker

PLMConnectionId

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

Declaration

Guid PLMConnectionId { get; }

Property Value

Type	Description
Guid

PLMItemId

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

Declaration

string PLMItemId { get; }

Property Value

Type	Description
string

SimulationTolerances

Simulation tolerance settings of the project

Declaration

ICamApiSimulationTolerances SimulationTolerances { get; }

Property Value

Type	Description
ICamApiSimulationTolerances

Simulator

Manager of simulation of the project

Declaration

ICamApiSimulator Simulator { get; }

Property Value

Type	Description
ICamApiSimulator

Snapshots

List of snapshots

Declaration

IListCamApiSnapshot Snapshots { get; }

Property Value

Type	Description
IListCamApiSnapshot

Technologist

Technology of project

Declaration

ICamApiTechnologist Technologist { get; }

Property Value

Type	Description
ICamApiTechnologist

ToolsList

The list of machining tools used in the project

Declaration

ICamApiMachiningToolsList ToolsList { get; }

Property Value

Type	Description
ICamApiMachiningToolsList

Methods

LoadMachineFromXmlProp(out TResultStatus)

Declaration

void LoadMachineFromXmlProp(out TResultStatus ResultStatus)

Parameters

Type	Name	Description
TResultStatus	ResultStatus

RegisterHandler(string, ICamApiEventHandler, IListString, out TResultStatus)

Declaration

void RegisterHandler(string HandlerIdent, ICamApiEventHandler Handler, IListString Events, out TResultStatus ResultStatus)

Parameters

Type	Name	Description
string	HandlerIdent
ICamApiEventHandler	Handler
IListString	Events
TResultStatus	ResultStatus

SaveCLDataInfo(string, ICamApiTechOperationIterator, out TResultStatus)

Declaration

ICamApiNCMakerCLDataInfo SaveCLDataInfo(string OutputFileName, ICamApiTechOperationIterator OperationsIterator, out TResultStatus ret)

Parameters

Type	Name	Description
string	OutputFileName
ICamApiTechOperationIterator	OperationsIterator
TResultStatus	ret

Returns

Type	Description
ICamApiNCMakerCLDataInfo

SaveClData(string, ICamApiTechOperationIterator, out TResultStatus)

Declaration

void SaveClData(string OutputFileName, ICamApiTechOperationIterator OperationsIterator, out TResultStatus ResultStatus)

Parameters

Type	Name	Description
string	OutputFileName
ICamApiTechOperationIterator	OperationsIterator
TResultStatus	ResultStatus

SetMachine(Guid, string, string, out TResultStatus)

Declaration

void SetMachine(Guid Guid, string FilePath, string TypeName, out TResultStatus ResultStatus)

Parameters

Type	Name	Description
Guid	Guid
string	FilePath
string	TypeName
TResultStatus	ResultStatus

SetOperationTool(string, string, out TResultStatus)

Declaration

void SetOperationTool(string OperationID, string ToolID, out TResultStatus ResultStatus)

Parameters

Type	Name	Description
string	OperationID
string	ToolID
TResultStatus	ResultStatus

UnregisterHandler(string, out TResultStatus)

Declaration

void UnregisterHandler(string HandlerIdent, out TResultStatus ResultStatus)

Parameters

Type	Name	Description
string	HandlerIdent
TResultStatus	ResultStatus