com.ur.urcap.api.domain.feature

Interface Feature

All Known Subinterfaces:

BaseFeature, FeatureLine, FeaturePlane, FeaturePoint, ToolFeature

@ProviderType
public interface Feature

This base interface represents all types of features available in PolyScope

Since:

1.0.0

Method Summary

Modifier and Type	Method and Description
String	getName() Note: The feature can be renamed at any time
Pose	getPose() Returns the Cartesian location of the feature
boolean	isDefined() Returns whether the position of the feature has been fully defined/specified.
boolean	isJoggable()
boolean	isResolvable() A feature cannot be guaranteed to be present in PolyScope.
boolean	isVariable() Returns whether the feature can be used as a variable in the program.

Method Detail

getName

String getName()

Note: The feature can be renamed at any time

Returns:

The name of the feature

isDefined

boolean isDefined()

Returns whether the position of the feature has been fully defined/specified.

Returns:

true if the feature is defined, false otherwise.

isVariable

boolean isVariable()

Returns whether the feature can be used as a variable in the program.

Returns:

true if the feature is variable, false otherwise.

isJoggable

boolean isJoggable()

getPose

Pose getPose()

Returns the Cartesian location of the feature

Returns:

A pose representing the Cartesian location of the feature

Since:

1.6.0

isResolvable

boolean isResolvable()

A feature cannot be guaranteed to be present in PolyScope. This method can be used to determine, if the feature is present.

The feature will not be present, if the end user loads a different installation which does not contain the feature, or if the feature is removed by the end user or the URCap that added the feature.

Returns:

true if this feature is present in PolyScope, otherwise false.

Since:

1.9.0