pycatia.space_analyses_interfaces.distance

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-06-11 12:40:47.360445

Warning

The notes denoted “CAA V5 Visual Basic Help” are to be used as reference only. They are there as a guide as to how the visual basic / catscript functions work and thus help debugging in pycatia.

class pycatia.space_analyses_interfaces.distance.Distance(com_object)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

System.IUnknown

System.IDispatch

System.CATBaseUnknown

System.CATBaseDispatch

System.AnyObject

Distance

Represents the Distance object.

The Distance object is a specification of a distance computation between

products or groups of products.

property accuracy: float

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

o Property Accuracy() As double

Returns or sets the accuracy value for the computation.

The accuracy value must be greater than 0.

Example:

The first example retrieves the accuracy value of NewDistance

Distance.

Dim AccuracyValue As double

AccuracyValue = NewDistance.Accuracy

The second example sets the accuracy value of NewDistance

Distance.

NewDistance.Accuracy = 10.

Return type:

float

property annotated_views: AnnotatedViews

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

o Property AnnotatedViews() As AnnotatedViews (Read Only)

Returns the AnnotatedViews collection of the distance.

Example:

This example retrieves the AnnotatedViews collection of

NewDistance Distance.

Dim TheAnnotatedViewsList As AnnotatedViews

Set TheAnnotatedViewsList = NewDistance.AnnotatedViews

Return type:

AnnotatedViews

property computation_type: int

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

o Property ComputationType() As CatDistanceComputationType

Returns or sets the computation type for the computation.

Example:

The first example retrieves the computation type of NewDistance

Distance.

Dim ComputationType As CatDistanceComputationType

ComputationType = NewDistance.ComputationType

The second example sets the computation type of NewDistance

Distance.

NewDistance.ComputationType = CatDistanceComputationTypeInsideOne

Return type:

int

compute() → None

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub Compute()

Computes the distance.

Example:

This example computes the distance of NewDistance

Distance.

NewDistance.Compute

Return type:

None

property first_group: Group

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

o Property FirstGroup() As Group

Returns or sets the first group used by the computation.

Example:

The first example retrieves the first group of NewDistance

Distance.

Dim FirstGroup As Group

Set FirstGroup = NewDistance.FirstGroup

The second example sets the first group of NewDistance

Distance.

Dim FirstGroup As Group

NewDistance.FirstGroup = FirstGroup

Return type:

Group

property first_product: Product

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

o Property FirstProduct() As Product (Read Only)

Returns the product belonging to the first group that realizes the minimum

distance.

Example:

This example retrieves the first product involved in the

NewDistance Distance.

Dim AProduct As Product

Set AProduct = NewDistance.FirstProduct

Return type:

Product

get_first_point_coordinates() → tuple

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub GetFirstPointCoordinates(CATSafeArrayVariant

oCoordinates)

Retrieves the coordinates of the point belonging to the first product,

which realizes the distance.

Parameters:

oCoordinates

The coordinates of the point

oCoordinates(0) is the X coordinate

oCoordinates(1) is the Y coordinate

oCoordinates(2) is the Z coordinate

Example:

This example retrieves the coordinates of the first point in

NewDistance Distance.

Dim Coordinates (2)

NewDistance.GetFirstPointCoordinates Coordinates

Return type:

tuple

get_second_point_coordinates() → tuple

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384))

o Sub GetSecondPointCoordinates(CATSafeArrayVariant

oCoordinates)

Retrieves the coordinates of the point belonging to the second product,

which realizes the distance.

Parameters:

oCoordinates

The coordinates of the point

oCoordinates(0) is the X coordinate

oCoordinates(1) is the Y coordinate

oCoordinates(2) is the Z coordinate

Example:

This example retrieves the coordinates of the first point in

NewDistance Distance.

Dim Coordinates (2)

NewDistance.GetSecondPointCoordinates Coordinates

Return type:

None

property is_defined: int

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

o Property IsDefined() As long (Read Only)

Returns a diagnosis on the distance.

The diagnosis can take two values:

= 0: the distance is undefined (for example only one product) and the results are invalid.

= 1: the distance is defined and all results are valid.

Example:

This example retrieves the diagnosis on NewDistance

Distance.

If NewDistance.IsDefined = 1 Then

Return type:

int

property marker_3ds: Marker3Ds

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

o Property Marker3Ds() As Marker3Ds (Read Only)

Returns the Marker3Ds collection of the distance.

Example:

This example retrieves the Marker3Ds collection of NewDistance

Distance.

Dim TheMarker3DsList As Marker3Ds

Set TheMarker3DsList = NewDistance.Marker3Ds

Return type:

Marker3Ds

property maximum_distance: float

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

o Property MaximumDistance() As double

Returns or sets the maximum distance value for the computation (valid only

for band analysis).

The maximum distance value must be greater than 0.

Example:

The first example retrieves the maximum distance value of

NewDistance Distance.

Dim MaximumValue As double

MaximumValue = NewDistance.MaximumDistance

The second example sets the maximum distance value of

NewDistance Distance.

NewDistance.MaximumDistance = 10.

Return type:

float

property measure_type: int

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

o Property MeasureType() As CatDistanceMeasureType

Returns or sets the type of distance that will be

calculated.

Example:

The first example retrieves the type of NewDistance

Distance.

Dim MeasureType As CatDistanceMeasureType

MeasureType = NewDistance.MeasureType

The second example sets the Type of NewDistance

Distance.

NewDistance.MeasureType = CatDistanceMeasureTypeMinimum

Returns:

enum cat_distance_measure_type

Return type:

int

property minimum_distance: float

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

o Property MinimumDistance() As double

Returns or sets the minimum distance value for the computation (valid only

for band analysis).

The minimum distance value must be greater than 0.

Example:

The first example retrieves the minimum distance value of

NewDistance Distance.

Dim MinimumValue As double

MinimumValue = NewDistance.MinimumDistance

The second example sets the minimum distance value of

NewDistance Distance.

NewDistance.MinimumDistance = 10.

Return type:

float

property second_group: Group

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

o Property SecondGroup() As Group

Returns or sets the second group used by the computation.

Example:

The first example retrieves the second group of NewDistance

Distance.

Dim SecondGroup As Group

Set SecondGroup = NewDistance.SecondGroup

The second example sets the second group of NewDistance

Distance.

Dim SecondGroup As Group

NewDistance.SecondGroup = SecondGroup

Return type:

Group

property second_product: Product

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

o Property SecondProduct() As Product (Read Only)

Returns the product belonging to the second group that realizes the minimum

distance.

Example:

This example retrieves the coordinates in the NewDistance

Distance.

Dim AProduct As Product

Set AProduct = NewDistance.SecondProduct

Return type:

Product

property value: float

Note

CAA V5 Visual Basic Help (2020-07-06 14:02:20.222384)

o Property Value() As double (Read Only)

Returns the distance value.

Example:

This example retrieves the value of NewDistance

Distance.

Dim MinimumValue As double

MinimumValue = NewDistance.Value

Return type:

float