@inweb/client
    Preparing search index...

    Class ClashTest

    Provides properties and methods for obtaining information about a file/assembly clash detection test.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    headers path

    Accessors

    clearance createdAt data id lastModifiedAt name owner selectionSetA selectionSetB selectionTypeA selectionTypeB status tolerance

    Methods

    checkout delete getReport save update waitForDone

    Constructors

    • Parameters

      • data: any

        Raw test data received from the server. For more information, see Open Cloud Assemblies API.

      • path: string

        The clash test API path of the file/assembly that owns the test.

      • httpClient: IHttpClient

        HTTP client instance used to send requests to the REST API server.

      Returns ClashTest

    Properties

    headers: HeadersInit

    Endpoint-specific HTTP headers for the GET, POST, PUT and DELETE requests. You can add custom headers at any time.

    path: string

    Endpoint API path relative to the REST API server URL.

    Accessors

    • get clearance(): boolean

      The type of the clashes that the test detects:

      • true - Clearance clash. A clash in which the object A may or may not intersect with object B, but comes within a distance of less than the tolerance.
      • false - Hard clash. A clash in which the object A intersects with object B by a distance of more than the tolerance.

      Returns boolean

    • get createdAt(): string

      Test creation time (UTC) in the format specified in ISO 8601.

      Returns string

    • get id(): string

      Unique test ID.

      Returns string

    • get lastModifiedAt(): string

      Test last update (UTC) time in the format specified in ISO 8601.

      Returns string

    • get name(): string

      Test name.

      Returns string

    • get selectionSetA(): string[]

      First selection set for clash detection. Objects from selectionSetA will be tested against each others by objects from the selectionSetB during the test.

      Returns string[]

    • get selectionSetB(): string[]

      Second selection set for clash detection. Objects from selectionSetB will be tested against each others by objects from the selectionSetA during the test.

      Returns string[]

    • get selectionTypeA(): string

      The type of first selection set for clash detection. Can be one of:

      • all - All file/assembly objects.
      • handle - Objects with original handles specified in the selectionSetA.
      • models - All objects of the models with original handles specified in the selectionSetA.
      • searchquery - Objects retrieved by the search queries specified in selectionSetA.

      Returns string

    • get selectionTypeB(): string

      The type of second selection set for clash detection. Can be one of:

      • all - All file/assembly objects.
      • handle - Objects with original handles specified in the selectionSetB.
      • models - All objects of the models with original handles specified in the selectionSetB.
      • searchquery - Objects retrieved by the search queries specified in selectionSetB.

      Returns string

    • get status(): string

      Test status. Can be none, waiting, inprogress, done or failed.

      Returns string

    • get tolerance(): number

      The distance of separation between objects at which test begins detecting clashes.

      Returns number

    Methods

    • Reloads test data from the server.

      Returns Promise<ClashTest>

    • Deletes a test and its results report from the server.

      Returns Promise<any>

      Returns the raw data of a deleted test. For more information, see Open Cloud Assemblies API.

    • Returns a list of detected clashes for this test.

      Returns Promise<IClashItem[]>

    • Saves test properties changes to the server. Call this method to update test data on the server after any property changes.

      Returns Promise<ClashTest>

    • Waits for test to complete. Test is done when it changes to done or failed status.

      Parameters

      • Optionalparams: {
            interval?: number;
            onCheckout?: (test: ClashTest, ready: boolean) => boolean;
            signal?: AbortSignal;
            timeout?: number;
        }

        An object containing waiting parameters.

        • Optionalinterval?: number

          The time, in milliseconds, the function should delay in between checking test status.

        • OptionalonCheckout?: (test: ClashTest, ready: boolean) => boolean

          Waiting progress callback. Return true to cancel waiting.

        • Optionalsignal?: AbortSignal

          An AbortController signal, which can be used to abort waiting as desired.

        • Optionaltimeout?: number

          The time, in milliseconds that the function should wait test. If test is not complete during this time, the TimeoutError exception will be thrown.

      Returns Promise<ClashTest>

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods