All Frameworks  Object Hierarchy  This Framework  Indexes

Distance (Object)

Represents the Distance object.
The Distance object is a specification of a distance computation between products or groups of products.

Property Index

Accuracy
Returns or sets the accuracy value for the computation.
AnnotatedViews
Returns the AnnotatedViews collection of the distance.
ComputationType
Returns or sets the computation type for the computation.
FirstGroup
Returns or sets the first group used by the computation.
FirstProduct
Returns the product belonging to the first group that realizes the minimum distance.
IsDefined
Returns a diagnosis on the distance.
Marker3Ds
Returns the Marker3Ds collection of the distance.
MaximumDistance
Returns or sets the maximum distance value for the computation (valid only for band analysis).
MeasureType
Returns or sets the type of distance that will be calculated.
MinimumDistance
Returns or sets the minimum distance value for the computation (valid only for band analysis).
SecondGroup
Returns or sets the second group used by the computation.
SecondProduct
Returns the product belonging to the second group that realizes the minimum distance.
Value
Returns the distance value.

Method Index

Compute
Computes the distance.
GetFirstPointCoordinates
Retrieves the coordinates of the point belonging to the first product, which realizes the distance.
GetSecondPointCoordinates
Retrieves the coordinates of the point belonging to the second product, which realizes the distance.

Properties


o Property Accuracy() As
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.
o Property AnnotatedViews() As (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
o Property ComputationType() As
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
o Property FirstGroup() As
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
o Property FirstProduct() As (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
o Property IsDefined() As (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
o Property Marker3Ds() As (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
o Property MaximumDistance() As
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.
o Property MeasureType() As
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
o Property MinimumDistance() As
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.
o Property SecondGroup() As
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
o Property SecondProduct() As (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
o Property Value() As (Read Only)
Returns the distance value.
Example:
This example retrieves the value of NewDistance Distance. 
    Dim MinimumValue As double
    MinimumValue = NewDistance.Value

Methods


o Sub Compute()
Computes the distance.
Example:
This example computes the distance of NewDistance Distance. 
    NewDistance.Compute
o Sub GetFirstPointCoordinates( 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
o Sub GetSecondPointCoordinates( 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

Copyright © 2003, Dassault Systèmes. All rights reserved.