PinListBuilder Class

class NXOpen.Annotations.PinListBuilder

Bases: NXOpen.TaggedObject, NXOpen.GeometricUtilities.IComponentBuilder

Builder for Formboard pin list functionality used in formboard.

This class queries and sets settings specific to formboard pin list.

New in version NX9.0.0.

Properties

Property	Description
AutoUpdate	Returns or sets the options specifies whether annotation automatically updates.
Filter	Returns or sets the category specifies the filter type.
FlattenHierarchy	Returns or sets the options specifies whether to flatten hierarchy.
Tag	Returns the Tag for this object.

Methods

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

Enumerations

PinListBuilderFilterType Enumeration

The options specify the filter type.

Property Detail

AutoUpdate

PinListBuilder.AutoUpdate

Returns or sets the options specifies whether annotation automatically updates.

-------------------------------------

Getter Method

Signature AutoUpdate

Returns: Return type:bool

New in version NX9.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature AutoUpdate

Parameters:autoUpdate (bool) –

New in version NX9.0.0.

License requirements: routing_harness (“Routing Harness”)

Filter

PinListBuilder.Filter

Returns or sets the category specifies the filter type.

-------------------------------------

Getter Method

Signature Filter

Returns: Return type:NXOpen.Annotations.PinListBuilderFilterType

New in version NX9.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature Filter

Parameters:filter (NXOpen.Annotations.PinListBuilderFilterType) –

New in version NX9.0.0.

License requirements: routing_harness (“Routing Harness”)

FlattenHierarchy

PinListBuilder.FlattenHierarchy

Returns or sets the options specifies whether to flatten hierarchy.

-------------------------------------

Getter Method

Signature FlattenHierarchy

Returns: Return type:bool

New in version NX9.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature FlattenHierarchy

Parameters:flattenHierarchy (bool) –

New in version NX9.0.0.

License requirements: routing_harness (“Routing Harness”)

Method Detail

Validate

PinListBuilder.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.