DocumentationBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# DocumentationBuilder Class

class `NXOpen.CAM.``DocumentationBuilder`

  Bases: `NXOpen.CAM.OperationBuilder`

  Represents a Documentation Builder

  To create a new instance of this class, use `NXOpen.CAM.OperationCollection.CreateDocumentationBuilder()`

  New in version NX9.0.3.

# Properties

Property | Description
--- | ---
ChannelName | Returns or sets the channel’s name
CycleEvent | Returns the cycle event
CycleTable | Returns the cycle
Description | Returns or sets the description
EndOfPath | Returns the end event builder
EndUdeSet | Returns the end ude set
Geometry | Returns the geometry builder
GougeChecking | Returns or sets the gouge checking flag
HoleAxisType | Returns or sets the Hole Axis Type
HoleDepth | Returns the max depth distance builder
HoleDepthType | Returns or sets the Hole Depth Type
LayoutAndLayer | Returns the Layer and Layout
MotionOutputBuilder | Returns the motion output builder
Notes | Returns the notes builder
OptimizationBasedOn | Returns or sets the optimization based on in operation
OptimizationDistanceMethod | Returns or sets the optimization distance method in operation
OptimizationLevel | Returns or sets the optimization level in operation
OptimizationMethod | Returns or sets the optim method
PathDisplayOptions | Returns the path display options builder
PostToolPathExit | Returns or sets the environment variable that points to the post tool path generation library which has the exit
RetractDistance | Returns the Retract Distance builder (inheritable double)
RetractDistanceOnToolAxisChange | Returns the Retract Distance on Tool Axis Change builder (inheritable double)
SafeClearance | Returns the safe clearance builder
SelectToolFlag | Returns or sets the user selected tool
StartOfPath | Returns the start event builder
StartUdeSet | Returns the start ude set
Tag | Returns the Tag for this object.
ToolChangeSetting | Returns the tool change builder
ToolPathEditor | Returns the Tool Path Editor Builder
ToolPathSplitParametersBuilder | Returns the tool path split Parameters

# 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.
GetCustomizableItemBuilder | Returns the customizable item builder for the given customizable item name
GetCustomizableItemNames | Returns the names for all customizable item ids
GetHoleAxisValues | Get the Hole Axis values
GetObject | Returns the object currently being edited by this builder.
SetHoleAxisValues | Set the Hole Axis values
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.

# Method Detail

## Validate

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