Package com.onshape.api.requests

Class PartsGetMassPropertiesRequest.Builder

java.lang.Object

com.onshape.api.requests.PartsGetMassPropertiesRequest.Builder

Enclosing class:

PartsGetMassPropertiesRequest

public static final class PartsGetMassPropertiesRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
PartsGetMassPropertiesResponse	call(OnshapeDocument document, String partid)	Calls getMassProperties method, Get the mass properties of a part; parts must have density in order to have mass.
PartsGetMassPropertiesResponse	call(String did, WVM wvmType, String wvm, String eid, String partid)	Calls getMassProperties method, Get the mass properties of a part; parts must have density in order to have mass.
String	configuration()	Get Configuration string
PartsGetMassPropertiesRequest.Builder	configuration(String value)	Set Configuration string
Boolean	inferMetadataOwner()	Get If the referenced part is a Standard Content part, specifying a value of true causes the API to look for metadata owned by the owner of the referencing linkDocument prior to calculating mass properties.
PartsGetMassPropertiesRequest.Builder	inferMetadataOwner(Boolean value)	Set If the referenced part is a Standard Content part, specifying a value of true causes the API to look for metadata owned by the owner of the referencing linkDocument prior to calculating mass properties.
String	linkDocumentId()	Get Id of document that links to the document being accessed.
PartsGetMassPropertiesRequest.Builder	linkDocumentId(String value)	Set Id of document that links to the document being accessed.

Methods inherited from class java.lang.Object

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

Method Detail

inferMetadataOwner

public final Boolean inferMetadataOwner()

Get If the referenced part is a Standard Content part, specifying a value of true causes the API to look for metadata owned by the owner of the referencing linkDocument prior to calculating mass properties. If Standard Content metadata is found and it contains a material assignment, the density from that material is applied to the mass properties calculation.

Returns:

If the referenced part is a Standard Content part, specifying a value of true causes the API to look for metadata owned by the owner of the referencing linkDocument prior to calculating mass properties. If Standard Content metadata is found and it contains a material assignment, the density from that material is applied to the mass properties calculation.

inferMetadataOwner

public final PartsGetMassPropertiesRequest.Builder inferMetadataOwner(Boolean value)

Set If the referenced part is a Standard Content part, specifying a value of true causes the API to look for metadata owned by the owner of the referencing linkDocument prior to calculating mass properties. If Standard Content metadata is found and it contains a material assignment, the density from that material is applied to the mass properties calculation.

Parameters:

value - If the referenced part is a Standard Content part, specifying a value of true causes the API to look for metadata owned by the owner of the referencing linkDocument prior to calculating mass properties. If Standard Content metadata is found and it contains a material assignment, the density from that material is applied to the mass properties calculation.

Returns:

the Builder object.

linkDocumentId

public final String linkDocumentId()

Get Id of document that links to the document being accessed. This may provide additional access rights to the document. Allowed only with version (v) path parameter.

Returns:

Id of document that links to the document being accessed. This may provide additional access rights to the document. Allowed only with version (v) path parameter.

linkDocumentId

public final PartsGetMassPropertiesRequest.Builder linkDocumentId(String value)

Set Id of document that links to the document being accessed. This may provide additional access rights to the document. Allowed only with version (v) path parameter.

Parameters:

value - Id of document that links to the document being accessed. This may provide additional access rights to the document. Allowed only with version (v) path parameter.

Returns:

the Builder object.

configuration

public final String configuration()

Get Configuration string

Returns:

Configuration string

configuration

public final PartsGetMassPropertiesRequest.Builder configuration(String value)

Set Configuration string

Parameters:

value - Configuration string

Returns:

the Builder object.

call

public final PartsGetMassPropertiesResponse call(String did,
                                                 WVM wvmType,
                                                 String wvm,
                                                 String eid,
                                                 String partid)
                                          throws OnshapeException

Calls getMassProperties method, Get the mass properties of a part; parts must have density in order to have mass. For properties that come in sets of three, the first set is the calculated value, and the second and third are minimum and maximum possible values considering tolerance.

Parameters:

did - Document ID

wvmType - Type of Workspace, Version or Microversion

wvm - Workspace (w), Version (v) or Microversion (m) ID

eid - Element ID

partid - Part ID (must be URL encoded)

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error

call

public final PartsGetMassPropertiesResponse call(OnshapeDocument document,
                                                 String partid)
                                          throws OnshapeException

Calls getMassProperties method, Get the mass properties of a part; parts must have density in order to have mass. For properties that come in sets of three, the first set is the calculated value, and the second and third are minimum and maximum possible values considering tolerance.

Parameters:

document - Document object from Onshape URL.

partid - Part ID (must be URL encoded)

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error