CablewaysBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# CablewaysBuilder Class

class `NXOpen.Routing.Electrical.``CablewaysBuilder`

  Bases: `NXOpen.Builder`

  Represents `NXOpen.Routing.Electrical.CablewaysBuilder`.

  To create a new instance of this class, use `NXOpen.Routing.RouteManager.CreateCablewaysBuilder()`

  Default values.

  Property | Value
  --- | ---
  AllowNewCables | 0
  AllowOverFill | 0
  CableTrayArea.Value | 0
  CableTrayMaximumHeight.Value | 0
  CabletrayHeight.Value | 0
  CabletrayWidth.Value | 0
  FillPercentage.Value | 0
  SpecifiedFillPercentage.Value | 0

  New in version NX7.5.0.

# Properties

Property | Description
--- | ---
AllowNewCables | Returns or sets the allow new cables toggle
AllowOverFill | Returns or sets the Allow Overfill toggle
CableTrayArea | Returns the cabletray area expression
CableTrayMaximumHeight | Returns the cabletray maximum height expression
CabletrayHeight | Returns the cabletray height expression
CabletrayWidth | Returns the cabletray width expression
FillPercentage | Returns the fill percentage expression
RouteObjectCollector | Returns the route object collector
SpecifiedFillPercentage | Returns the specified fill percentage expression
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.
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Property Detail

## AllowNewCables

`CablewaysBuilder.``AllowNewCables`

  Returns or sets the allow new cables toggle

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

  Getter Method

  Signature `AllowNewCables`

  Returns: |
  Return type: | bool

  New in version NX7.5.0.

  License requirements: routing_cabling (“Routing Cabling”)

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

  Setter Method

  Signature `AllowNewCables`

  Parameters: | allowNewCables (bool) –

  New in version NX7.5.0.

  License requirements: routing_cabling (“Routing Cabling”)

## AllowOverFill

`CablewaysBuilder.``AllowOverFill`

  Returns or sets the Allow Overfill toggle

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

  Getter Method

  Signature `AllowOverFill`

  Returns: |
  Return type: | bool

  New in version NX11.0.1.

  License requirements: routing_cabling (“Routing Cabling”)

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

  Setter Method

  Signature `AllowOverFill`

  Parameters: | allowOverfill (bool) –

  New in version NX11.0.1.

  License requirements: routing_cabling (“Routing Cabling”)

## CableTrayArea

`CablewaysBuilder.``CableTrayArea`

  Returns the cabletray area expression

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

  Getter Method

  Signature `CableTrayArea`

  Returns: |
  Return type: | `NXOpen.Expression`

  New in version NX11.0.1.

  License requirements: routing_cabling (“Routing Cabling”)

## CableTrayMaximumHeight

`CablewaysBuilder.``CableTrayMaximumHeight`

  Returns the cabletray maximum height expression

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

  Getter Method

  Signature `CableTrayMaximumHeight`

  Returns: |
  Return type: | `NXOpen.Expression`

  New in version NX11.0.1.

  License requirements: routing_cabling (“Routing Cabling”)

## CabletrayHeight

`CablewaysBuilder.``CabletrayHeight`

  Returns the cabletray height expression

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

  Getter Method

  Signature `CabletrayHeight`

  Returns: |
  Return type: | `NXOpen.Expression`

  New in version NX11.0.1.

  License requirements: routing_cabling (“Routing Cabling”)

## CabletrayWidth

`CablewaysBuilder.``CabletrayWidth`

  Returns the cabletray width expression

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

  Getter Method

  Signature `CabletrayWidth`

  Returns: |
  Return type: | `NXOpen.Expression`

  New in version NX11.0.1.

  License requirements: routing_cabling (“Routing Cabling”)

## FillPercentage

`CablewaysBuilder.``FillPercentage`

  Returns the fill percentage expression

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

  Getter Method

  Signature `FillPercentage`

  Returns: |
  Return type: | `NXOpen.Expression`

  New in version NX7.5.0.

  License requirements: routing_cabling (“Routing Cabling”)

## RouteObjectCollector

`CablewaysBuilder.``RouteObjectCollector`

  Returns the route object collector

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

  Getter Method

  Signature `RouteObjectCollector`

  Returns: |
  Return type: | `NXOpen.Routing.RouteObjectCollector`

  New in version NX7.5.0.

  License requirements: routing_cabling (“Routing Cabling”)

## SpecifiedFillPercentage

`CablewaysBuilder.``SpecifiedFillPercentage`

  Returns the specified fill percentage expression

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

  Getter Method

  Signature `SpecifiedFillPercentage`

  Returns: |
  Return type: | `NXOpen.Expression`

  New in version NX11.0.1.

  License requirements: routing_cabling (“Routing Cabling”)

# Method Detail

## Validate

`CablewaysBuilder.``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.