Interface ICamApiTechOperation
Assembly: CAMAPI.TechOperation.dll
Syntax
[Guid("C0384D7A-9E7C-4867-87AA-42642AF3186C")]
[InterfaceType(ComInterfaceType.InterfaceIsIUnknown)]
public interface ICamApiTechOperation
Properties
ApproachCalculated
The approach move of the operation is calculated
Declaration
bool ApproachCalculated { get; }
Property Value
ApproachRule
Approach move before operation start
Declaration
string ApproachRule { get; set; }
Property Value
Calculated
The operation toolpath is calculated
Declaration
Property Value
ChannelIndex
Zero-based index of the simulator channel this operation is assigned to.
Always 0 on single-channel machines.
Declaration
int ChannelIndex { get; }
Property Value
Enabled
The operation is blocked for calculation or not
Declaration
Property Value
FullName
Slash divided full name of technology operation including parent groups
Declaration
Property Value
Id
Get unique identifier of technology operation
Declaration
Property Value
IsCollisionError
"Collision of machine nodes" — kinematic nodes of the machine (spindle
head, table, columns, etc.) intersect during motion.
Declaration
bool IsCollisionError { get; }
Property Value
IsCompensationError
"Radius compensation value is too much" — the tool is stopped with an
alarm because requested radius (G41/G42) compensation exceeds the limit.
Declaration
bool IsCompensationError { get; }
Property Value
IsError
Error in calculating toolpath or simulation
Declaration
Property Value
IsGougeError
"Gouge of the part" — the cutter cuts into the part outside the
intended toolpath region (overcut).
Declaration
bool IsGougeError { get; }
Property Value
IsGroup
Returns true if the operation is any kind of groups and can have child operations
Declaration
Property Value
IsHolderError
"Contact workpiece with holder" — the tool holder (collet/chuck body),
not the cutting edge, touches the workpiece.
Declaration
bool IsHolderError { get; }
Property Value
IsMachiningResultCalculated
The machining result is calculated for this operation
Declaration
bool IsMachiningResultCalculated { get; }
Property Value
IsPlungeError
"The ramp angle too high" — the tool plunges into the material at an
angle steeper than what the cutting strategy allows.
Declaration
bool IsPlungeError { get; }
Property Value
IsRapidError
"Contact with workpiece on rapid feed" — the tool engages the workpiece
while moving at rapid feed rate instead of working feed (unsafe motion).
Declaration
bool IsRapidError { get; }
Property Value
"Tool overload" — engagement load (cutting force/torque) on the tool
exceeds the configured limit; risks tool breakage.
Declaration
bool IsToolOverloadError { get; }
Property Value
IsTravelError
"Axis travel over the limits" — a machine axis is commanded to move
beyond its physical software limit (out of the work envelope).
Declaration
bool IsTravelError { get; }
Property Value
IsTurnDirectionError
"Inappropriate tool and spindle rotation direction" — the orientation
of the cutter does not match the configured spindle rotation direction.
Declaration
bool IsTurnDirectionError { get; }
Property Value
LCS
Local coordinate system for current operation
Declaration
Property Value
Machine
Declaration
ICamApiMachine Machine { get; }
Property Value
MachineConfiguration
Machine configuration for the operation
Declaration
ICamApiMachineConfiguration MachineConfiguration { get; }
Property Value
McdTree
Primary MCD tree of the operation — the toolpath computed by the technologist
projected onto the machine kinematics. Returns nil if the operation is not
calculated or is a group (HasToolpath = false).
Declaration
ICamApiMcdTree McdTree { get; }
Property Value
Object to manage model formers of fixture
Declaration
ICamApiModelFormer ModelFormerFixtures { get; }
Property Value
Object to manage model formers of job assignment
Declaration
ICamApiModelFormer ModelFormerJobAssignment { get; }
Property Value
Object to manage model formers of part
Declaration
ICamApiModelFormer ModelFormerPart { get; }
Property Value
Object to manage model formers of restrictions
Declaration
ICamApiModelFormer ModelFormerRestrictions { get; }
Property Value
Object to manage model formers of workpiece
Declaration
ICamApiModelFormer ModelFormerWorkpiece { get; }
Property Value
Name
Get name of technology operation
Declaration
string Name { get; set; }
Property Value
NeedDeleteChips
Whether chips need to be deleted before this operation
Declaration
bool NeedDeleteChips { get; }
Property Value
Notes
User notes of the technology operation (free-form multi-line text)
Declaration
string Notes { get; set; }
Property Value
OperationTag
Invisible textual Tag of operation. Empty by default. You (external code developer) can use it
for your own purpose.
Declaration
string OperationTag { get; set; }
Property Value
OperationType
Type identifier of the technology operation
Declaration
string OperationType { get; }
Property Value
PartIndex
Index of the Part inside Technologist to which this operation relates
Declaration
Property Value
RecoveryMcdTree
Recovery MCD tree of the operation — toolpath restored from post-processed
NC text via reverse interpretation, used when simulating by G-code.
Returns nil when the recovery toolpath is not available.
Declaration
ICamApiMcdTree RecoveryMcdTree { get; }
Property Value
OBSOLETE - the toolpath reset lock is application-wide, not per operation.
Use ICamApiTechnologist.ResetToolpathLocked instead. Kept for binary compatibility:
the getter reports the application-wide value, the setter does nothing.
Declaration
bool ResetToolpathLocked { get; set; }
Property Value
ReturnCalculated
The return move of the operation is calculated
Declaration
bool ReturnCalculated { get; }
Property Value
ReturnRule
Return move after operation end
Declaration
string ReturnRule { get; set; }
Property Value
True when the operation has a captured calculated-input snapshot, its current inputs
differ from it, AND the toolpath is lagging behind those inputs, i.e.
RevertToCalculatedInputs would bring the operation back in step with its toolpath.
With the application-wide toolpath lock off an edit resets the toolpath at once, so
there is nothing to revert to and this stays False. Drives the Revert button.
Declaration
bool RevertToCalculatedInputsAvailable { get; }
Property Value
SetupStageIndex
Index of the Setup stage inside Technologist to which this operation relates
Declaration
int SetupStageIndex { get; }
Property Value
Simulated
The operation is simulated
Declaration
Property Value
Technologist
Owning Technologist of the operation. You can try to cast it to (ICamApiTechnologist)
Declaration
ICamApiTechOperationOwner Technologist { get; }
Property Value
Machining tool of the operation. You can cast different interfaces to it depend on exact tool type
Declaration
ICamApiMachiningTool ToolEntity { get; }
Property Value
Units
Measurements of the operation
Declaration
TSTSystemUnits Units { get; }
Property Value
WorkpieceCoordinateSystem
Workpiece coordinate system of the operation
Declaration
ICamApiWorkpieceCoordinateSystem WorkpieceCoordinateSystem { get; }
Property Value
XMLProp
Value in XML-file, describing operation. Call LoadFromXmlProp to apply changes to the operation
Declaration
IST_XMLPropPointer XMLProp { get; }
Property Value
Methods
Declaration
void ExportToolpath(ICamApiExportToolpathReceiver ToolpathReceiver, out TResultStatus ResultStatus)
Parameters
GetApproachRuleIsCustom(out ICamApiApproachReturnRule, out TResultStatus)
Declaration
bool GetApproachRuleIsCustom(out ICamApiApproachReturnRule Rule, out TResultStatus ResultStatus)
Parameters
Returns
GetBlocksStatistics(out TCamApiTechOperationBlocksStatistics, out TResultStatus)
Declaration
void GetBlocksStatistics(out TCamApiTechOperationBlocksStatistics Statistics, out TResultStatus ResultStatus)
Parameters
GetCoolantTubeInfo(int, out TResultStatus)
Declaration
TCamApiCoolantTubeInfo GetCoolantTubeInfo(int TubeIndex, out TResultStatus ResultStatus)
Parameters
Returns
GetCoolantTubeState(int, out TResultStatus)
Declaration
bool GetCoolantTubeState(int TubeIndex, out TResultStatus ResultStatus)
Parameters
Returns
GetCoolantTubesCount()
Get the number of coolant tubes available on the current machine (up to 20).
Declaration
int GetCoolantTubesCount()
Returns
Declaration
TCamApiFeedInfo GetFeedValue(TFeedTypeFlag FeedType, out TResultStatus ResultStatus)
Parameters
Returns
GetFirstChildOperation(TCamApiReorderingMode)
Declaration
ICamApiTechOperation GetFirstChildOperation(TCamApiReorderingMode ReorderingMode)
Parameters
Returns
GetLengthStatistics(out TCamApiTechOperationLengthStatistics, out TResultStatus)
Declaration
void GetLengthStatistics(out TCamApiTechOperationLengthStatistics Statistics, out TResultStatus ResultStatus)
Parameters
GetNextSiblingOperation(TCamApiReorderingMode)
Declaration
ICamApiTechOperation GetNextSiblingOperation(TCamApiReorderingMode ReorderingMode)
Parameters
Returns
GetOperationDefaults()
Op-computed parameter defaults as a JSON path-value map. These are values the operation
materialises at creation that diverge from the schema/formula default. Empty when none.
Declaration
string GetOperationDefaults()
Returns
GetParentOperation(TCamApiReorderingMode)
Declaration
ICamApiTechOperation GetParentOperation(TCamApiReorderingMode ReorderingMode)
Parameters
Returns
GetPropIterator(string, out TResultStatus)
Declaration
IST_CustomPropIterator GetPropIterator(string PageID, out TResultStatus ResultStatus)
Parameters
Returns
GetReturnRuleIsCustom(out ICamApiApproachReturnRule, out TResultStatus)
Declaration
bool GetReturnRuleIsCustom(out ICamApiApproachReturnRule Rule, out TResultStatus ResultStatus)
Parameters
Returns
GetSpindleState()
Get spindle speed and rotation information for the operation.
Declaration
TCamApiSpindleState GetSpindleState()
Returns
GetStocks(out TCamApiTechOperationStocks, out TResultStatus)
Declaration
void GetStocks(out TCamApiTechOperationStocks Stocks, out TResultStatus ResultStatus)
Parameters
GetTimeStatistics(out TCamApiTechOperationTimeStatistics, out TResultStatus)
Declaration
void GetTimeStatistics(out TCamApiTechOperationTimeStatistics Statistics, out TResultStatus ResultStatus)
Parameters
GetUserParameters(out TResultStatus)
Declaration
ICamApiUserParametersList GetUserParameters(out TResultStatus ResultStatus)
Parameters
Returns
GetVolumeStatistics(out TCamApiTechOperationVolumeStatistics, out TResultStatus)
Declaration
void GetVolumeStatistics(out TCamApiTechOperationVolumeStatistics Statistics, out TResultStatus ResultStatus)
Parameters
Returns true if the operation has its own toolpath and it could be exported using ExportToolpath.
Groups has no toolpath at all.
If the operation is not Calculated, HasToolpath is false.
Declaration
Returns
InitMachineEvaluator(ICamApiMachineEvaluator, out TResultStatus)
Declaration
void InitMachineEvaluator(ICamApiMachineEvaluator MachineEvaluator, out TResultStatus ResultStatus)
Parameters
Declaration
bool IsInputPathRevertable(string Path, out TResultStatus ResultStatus)
Parameters
Returns
LoadFromXmlProp(IST_XMLPropPointer, out TResultStatus)
Declaration
void LoadFromXmlProp(IST_XMLPropPointer XMLProp, out TResultStatus ResultStatus)
Parameters
RegisterHandler(string, ICamApiEventHandler, IListString, out TResultStatus)
Declaration
void RegisterHandler(string HandlerIdent, ICamApiEventHandler Handler, IListString Events, out TResultStatus ResultStatus)
Parameters
Declaration
void RevertInputPathToCalculatedInputs(string Path, out TResultStatus ResultStatus)
Parameters
Declaration
void RevertToCalculatedInputs(out TResultStatus ResultStatus)
Parameters
SaveToXmlProp(out IST_XMLPropPointer, out TResultStatus)
Declaration
void SaveToXmlProp(out IST_XMLPropPointer XMLProp, out TResultStatus ResultStatus)
Parameters
SetApproachRuleIsCustom(ICamApiApproachReturnRule, out TResultStatus)
Declaration
void SetApproachRuleIsCustom(ICamApiApproachReturnRule Rule, out TResultStatus ResultStatus)
Parameters
SetCoolantTubeState(int, bool, out TResultStatus)
Declaration
void SetCoolantTubeState(int TubeIndex, bool State, out TResultStatus ResultStatus)
Parameters
Declaration
void SetFeedOutputMeasurement(TFeedTypeFlag FeedType, TCamApiFeedMeasurement OutputMeasurement, out TResultStatus ResultStatus)
Parameters
Declaration
void SetFeedValue(TFeedTypeFlag FeedType, TCamApiFeedMeasurement InputMeasurement, double Value, out TResultStatus ResultStatus)
Parameters
SetReturnRuleIsCustom(ICamApiApproachReturnRule, out TResultStatus)
Declaration
void SetReturnRuleIsCustom(ICamApiApproachReturnRule Rule, out TResultStatus ResultStatus)
Parameters
SetSpindleGearBoxRange(int)
Declaration
void SetSpindleGearBoxRange(int Range)
Parameters
| Type |
Name |
Description |
| int |
Range |
|
SetSpindleMaxRPMValue(double)
Declaration
void SetSpindleMaxRPMValue(double MaxRPMValue)
Parameters
| Type |
Name |
Description |
| double |
MaxRPMValue |
|
SetSpindleRotationByDefault()
Reset spindle rotation to default value
Declaration
void SetSpindleRotationByDefault()
SetSpindleRotationDirection(TCamApiSpindleRotationDirection)
Declaration
void SetSpindleRotationDirection(TCamApiSpindleRotationDirection direction)
Parameters
SetSpindleRotationsToCSS(double)
Declaration
void SetSpindleRotationsToCSS(double SurfaceSpeedValue)
Parameters
| Type |
Name |
Description |
| double |
SurfaceSpeedValue |
|
SetSpindleRotationsToOff()
Set spindle rotation mode to off
Declaration
void SetSpindleRotationsToOff()
SetSpindleRotationsToRPM(double)
Declaration
void SetSpindleRotationsToRPM(double RPMValue)
Parameters
| Type |
Name |
Description |
| double |
RPMValue |
|
UnregisterHandler(string, out TResultStatus)
Declaration
void UnregisterHandler(string HandlerIdent, out TResultStatus ResultStatus)
Parameters