Package com.onshape.api.requests

Class AssembliesTransformOccurrencesRequest.Builder

java.lang.Object

com.onshape.api.requests.AssembliesTransformOccurrencesRequest.Builder

Enclosing class:

AssembliesTransformOccurrencesRequest

public static final class AssembliesTransformOccurrencesRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
AssembliesTransformOccurrencesResponse	call(OnshapeDocument document)	Calls transformOccurrences method, Transform a list of assembly occurrences.
AssembliesTransformOccurrencesResponse	call(String did, String wid, String eid)	Calls transformOccurrences method, Transform a list of assembly occurrences.
Boolean	isRelative()	Get Whether the transform is relative or absolute.
AssembliesTransformOccurrencesRequest.Builder	isRelative(Boolean value)	Set Whether the transform is relative or absolute.
AssembliesTransformOccurrencesRequestOccurrences[]	occurrences()	Get A list of occurrences to transform.
AssembliesTransformOccurrencesRequest.Builder	occurrences(AssembliesTransformOccurrencesRequestOccurrences[] value)	Set A list of occurrences to transform.
Number[]	transform()	Get The transform to apply to the occurrences.
AssembliesTransformOccurrencesRequest.Builder	transform(Number[] value)	Set The transform to apply to the occurrences.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

occurrences

public final AssembliesTransformOccurrencesRequestOccurrences[] occurrences()

Get A list of occurrences to transform.

Returns:

A list of occurrences to transform.

occurrences

public final AssembliesTransformOccurrencesRequest.Builder occurrences(AssembliesTransformOccurrencesRequestOccurrences[] value)

Set A list of occurrences to transform.

Parameters:

value - A list of occurrences to transform.

Returns:

the Builder object.

transform

public final Number[] transform()

Get The transform to apply to the occurrences. Must be 9, 12, or 16 elements in length, representing a 3x3, 4x3 or 4x4 matrix, respectively. All translation matrix components are in meters.

Returns:

The transform to apply to the occurrences. Must be 9, 12, or 16 elements in length, representing a 3x3, 4x3 or 4x4 matrix, respectively. All translation matrix components are in meters.

transform

public final AssembliesTransformOccurrencesRequest.Builder transform(Number[] value)

Set The transform to apply to the occurrences. Must be 9, 12, or 16 elements in length, representing a 3x3, 4x3 or 4x4 matrix, respectively. All translation matrix components are in meters.

Parameters:

value - The transform to apply to the occurrences. Must be 9, 12, or 16 elements in length, representing a 3x3, 4x3 or 4x4 matrix, respectively. All translation matrix components are in meters.

Returns:

the Builder object.

isRelative

public final Boolean isRelative()

Get Whether the transform is relative or absolute. Each occurrence in an assembly has a transform that positions it relative to the top-most assembly. An absolute transform operation sets the transform of the occurrence and each child occurrence to the specified transform. A relative transform operation combines the specified transform with the existing transform of the occurrence and with each child occurrence transform.

Returns:

Whether the transform is relative or absolute. Each occurrence in an assembly has a transform that positions it relative to the top-most assembly. An absolute transform operation sets the transform of the occurrence and each child occurrence to the specified transform. A relative transform operation combines the specified transform with the existing transform of the occurrence and with each child occurrence transform.

isRelative

public final AssembliesTransformOccurrencesRequest.Builder isRelative(Boolean value)

Set Whether the transform is relative or absolute. Each occurrence in an assembly has a transform that positions it relative to the top-most assembly. An absolute transform operation sets the transform of the occurrence and each child occurrence to the specified transform. A relative transform operation combines the specified transform with the existing transform of the occurrence and with each child occurrence transform.

Parameters:

value - Whether the transform is relative or absolute. Each occurrence in an assembly has a transform that positions it relative to the top-most assembly. An absolute transform operation sets the transform of the occurrence and each child occurrence to the specified transform. A relative transform operation combines the specified transform with the existing transform of the occurrence and with each child occurrence transform.

Returns:

the Builder object.

call

public final AssembliesTransformOccurrencesResponse call(String did,
                                                         String wid,
                                                         String eid)
                                                  throws OnshapeException

Calls transformOccurrences method, Transform a list of assembly occurrences.

Parameters:

did - Document ID

wid - Workspace ID

eid - Element ID

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error

call

public final AssembliesTransformOccurrencesResponse call(OnshapeDocument document)
                                                  throws OnshapeException

Calls transformOccurrences method, Transform a list of assembly occurrences.

Parameters:

document - Document object from Onshape URL.

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error