AssembliesGeneralPropertiesBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# AssembliesGeneralPropertiesBuilder Class

class `NXOpen.Assemblies.``AssembliesGeneralPropertiesBuilder`

  Bases: `NXOpen.Builder`

  Represents an `NXOpen.Assemblies.AssembliesGeneralPropertiesBuilder` to be used for changing the general properties of a component.

  To create a new instance of this class, use `NXOpen.PropertiesManager.CreateAssembliesGeneralPropertiesBuilder()`

  Default values.

  Property | Value
  --- | ---
  Hidden | No
  IntegerQuantity | 0
  Layer | 0
  LayerOption | OriginalLayer
  NonGeometric | 0
  QuantityType | Number
  RealQuantity | 0
  ReferenceComponent | No
  SpecificColor | 0
  SpecificPartialShade | 0
  SpecificTranslucency | 0

  New in version NX8.0.0.

# Properties

Property | Description
--- | ---
Hidden | Returns or sets the hidden option.
IntegerQuantity | Returns or sets the integer quantity.
Layer | Returns or sets the layer.
LayerOption | Returns or sets the layer option.
NonGeometric | Returns or sets the non geometric flag.
QuantityType | Returns or sets the quantity type.
RealQuantity | Returns or sets the real quantity.
ReferenceComponent | Returns or sets the reference-only component flag.
SelectedObjects | Returns the selected object(s) list.
SpecificColor | Returns or sets the specific color flag.
SpecificPartialShade | Returns or sets the specific partial shade flag.
SpecificTranslucency | Returns or sets the specific translucency flag.
Tag | Returns the Tag for this object.

# Methods

Method | Description
--- | ---
Commit | Commits any edits that have been applied to the builder.
Destroy | Deletes the builder, and cleans up any objects created by the builder.
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit.
GetObject | Returns the object currently being edited by this builder.
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results.
SynchronizeAttributes | Synchronize the attributes on the components
SynchronizeDisplay | Synchronize the display on the components
SynchronizeLayers | Synchronize the layers on the components
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Enumerations

AssembliesGeneralPropertiesBuilderHiddenOptions Enumeration | Options for managing the hidden property on the components
AssembliesGeneralPropertiesBuilderLayerOptions Enumeration | Layer options for the components
AssembliesGeneralPropertiesBuilderQuantityOptions Enumeration | Options for assigning the quantity on the components
AssembliesGeneralPropertiesBuilderReferenceComponentOptions Enumeration | Options for setting the reference-only property on the components

# Property Detail

## Hidden

`AssembliesGeneralPropertiesBuilder.``Hidden`

  Returns or sets the hidden option.

  The hidden option will be “Yes” if all the objects are hidden, “No” if all the objects are not hidden, and “Mixed” if there is a combination.

  `-------------------------------------`

  Getter Method

  Signature `Hidden`

  Returns: |
  Return type: | `NXOpen.Assemblies.AssembliesGeneralPropertiesBuilderHiddenOptions`

  New in version NX8.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `Hidden`

  Parameters: | hidden (`NXOpen.Assemblies.AssembliesGeneralPropertiesBuilderHiddenOptions`) –

  New in version NX8.0.0.

  License requirements: None.

## IntegerQuantity

`AssembliesGeneralPropertiesBuilder.``IntegerQuantity`

  Returns or sets the integer quantity.

  This value will be used if the Quantity Type is set to Number and the DB_UNITS attribute is not set.

  `-------------------------------------`

  Getter Method

  Signature `IntegerQuantity`

  Returns: |
  Return type: | int

  New in version NX8.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `IntegerQuantity`

  Parameters: | integerQuantity (int) –

  New in version NX8.0.0.

  License requirements: None.

## Layer

`AssembliesGeneralPropertiesBuilder.``Layer`

  Returns or sets the layer.

  Used if the layer option is set to specified.

  `-------------------------------------`

  Getter Method

  Signature `Layer`

  Returns: |
  Return type: | int

  New in version NX8.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `Layer`

  Parameters: | layer (int) –

  New in version NX8.0.0.

  License requirements: None.

## LayerOption

`AssembliesGeneralPropertiesBuilder.``LayerOption`

  Returns or sets the layer option.

  If specified layer is set, then the layer will be used.

  `-------------------------------------`

  Getter Method

  Signature `LayerOption`

  Returns: |
  Return type: | `NXOpen.Assemblies.AssembliesGeneralPropertiesBuilderLayerOptions`

  New in version NX8.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `LayerOption`

  Parameters: | layerOption (`NXOpen.Assemblies.AssembliesGeneralPropertiesBuilderLayerOptions`) –

  New in version NX8.0.0.

  License requirements: None.

## NonGeometric

`AssembliesGeneralPropertiesBuilder.``NonGeometric`

  Returns or sets the non geometric flag.

  Sets the components to either geometric or non-geometric.

  `-------------------------------------`

  Getter Method

  Signature `NonGeometric`

  Returns: |
  Return type: | bool

  New in version NX8.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `NonGeometric`

  Parameters: | nonGeometric (bool) –

  New in version NX8.0.0.

  License requirements: None.

## QuantityType

`AssembliesGeneralPropertiesBuilder.``QuantityType`

  Returns or sets the quantity type.

  If the quantity type is set to number than either the integer quantity or the real quantity values will be used. Otherwise the quantity will be set to as-required.

  `-------------------------------------`

  Getter Method

  Signature `QuantityType`

  Returns: |
  Return type: | `NXOpen.Assemblies.AssembliesGeneralPropertiesBuilderQuantityOptions`

  New in version NX8.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `QuantityType`

  Parameters: | quantityType (`NXOpen.Assemblies.AssembliesGeneralPropertiesBuilderQuantityOptions`) –

  New in version NX8.0.0.

  License requirements: None.

## RealQuantity

`AssembliesGeneralPropertiesBuilder.``RealQuantity`

  Returns or sets the real quantity.

  This value will be used if the Quantity Type is set to Number and the DB_UNITS attribute has been set.

  `-------------------------------------`

  Getter Method

  Signature `RealQuantity`

  Returns: |
  Return type: | float

  New in version NX8.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `RealQuantity`

  Parameters: | realQuantity (float) –

  New in version NX8.0.0.

  License requirements: None.

## ReferenceComponent

`AssembliesGeneralPropertiesBuilder.``ReferenceComponent`

  Returns or sets the reference-only component flag.

  This option determines whether the components will be reference-only or not.

  `-------------------------------------`

  Getter Method

  Signature `ReferenceComponent`

  Returns: |
  Return type: | `NXOpen.Assemblies.AssembliesGeneralPropertiesBuilderReferenceComponentOptions`

  New in version NX8.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `ReferenceComponent`

  Parameters: | referenceComponent (`NXOpen.Assemblies.AssembliesGeneralPropertiesBuilderReferenceComponentOptions`) –

  New in version NX8.0.0.

  License requirements: None.

## SelectedObjects

`AssembliesGeneralPropertiesBuilder.``SelectedObjects`

  Returns the selected object(s) list.

  This is the active list of components that will be modified by any changes.

  `-------------------------------------`

  Getter Method

  Signature `SelectedObjects`

  Returns: |
  Return type: | `NXOpen.Assemblies.SelectComponentList`

  New in version NX8.0.0.

  License requirements: None.

## SpecificColor

`AssembliesGeneralPropertiesBuilder.``SpecificColor`

  Returns or sets the specific color flag.

  The explicit color display property will be discarded from all components.

  `-------------------------------------`

  Getter Method

  Signature `SpecificColor`

  Returns: |
  Return type: | bool

  New in version NX8.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `SpecificColor`

  Parameters: | specificColor (bool) –

  New in version NX8.0.0.

  License requirements: None.

## SpecificPartialShade

`AssembliesGeneralPropertiesBuilder.``SpecificPartialShade`

  Returns or sets the specific partial shade flag.

  The explicit partial shade display property will be discarded from all components.

  `-------------------------------------`

  Getter Method

  Signature `SpecificPartialShade`

  Returns: |
  Return type: | bool

  New in version NX8.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `SpecificPartialShade`

  Parameters: | specificPartialShade (bool) –

  New in version NX8.0.0.

  License requirements: None.

## SpecificTranslucency

`AssembliesGeneralPropertiesBuilder.``SpecificTranslucency`

  Returns or sets the specific translucency flag.

  The explicit translucency display property will be discarded from all components.

  `-------------------------------------`

  Getter Method

  Signature `SpecificTranslucency`

  Returns: |
  Return type: | bool

  New in version NX8.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `SpecificTranslucency`

  Parameters: | specificTranslucency (bool) –

  New in version NX8.0.0.

  License requirements: None.

# Method Detail

## SynchronizeAttributes

`AssembliesGeneralPropertiesBuilder.``SynchronizeAttributes`

  Synchronize the attributes on the components

  Signature `SynchronizeAttributes()`

  New in version NX8.0.0.

  License requirements: None.

## SynchronizeDisplay

`AssembliesGeneralPropertiesBuilder.``SynchronizeDisplay`

  Synchronize the display on the components

  Signature `SynchronizeDisplay()`

  New in version NX8.0.0.

  License requirements: None.

## SynchronizeLayers

`AssembliesGeneralPropertiesBuilder.``SynchronizeLayers`

  Synchronize the layers on the components

  Signature `SynchronizeLayers()`

  New in version NX8.0.0.

  License requirements: None.

## Validate

`AssembliesGeneralPropertiesBuilder.``Validate`

  Validate whether the inputs to the component are sufficient for commit to be called.

  If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.

  Signature `Validate()`

  Returns: | Was self validation successful
  Return type: | bool

  New in version NX3.0.1.

  License requirements: None.