Builder for Formboard pin list functionality used in formboard. More...
Public Types | |
| enum | FilterType { FilterTypeRoutedandUnroutedConnections, FilterTypeOnlyRoutedConnections, FilterTypeOnlyUnroutedConnections } |
| The options specify the filter type. More... | |
Public Member Functions | |
| bool | AutoUpdate () |
| Returns the options specifies whether annotation automatically updates. More... | |
| NXOpen::Annotations::PinListBuilder::FilterType | Filter () |
| Returns the category specifies the filter type. More... | |
| bool | FlattenHierarchy () |
| Returns the options specifies whether to flatten hierarchy. More... | |
| void | SetAutoUpdate (bool autoUpdate) |
| Sets the options specifies whether annotation automatically updates. More... | |
| void | SetFilter (NXOpen::Annotations::PinListBuilder::FilterType filter) |
| Sets the category specifies the filter type. More... | |
| void | SetFlattenHierarchy (bool flattenHierarchy) |
| Sets the options specifies whether to flatten hierarchy. More... | |
| virtual bool | Validate () |
| Validate whether the inputs to the component are sufficient for commit to be called. More... | |
 Public Member Functions inherited from NXOpen::TaggedObject | |
| tag_t | Tag () const |
| Returns the tag of this object. More... | |
Detailed Description
Builder for Formboard pin list functionality used in formboard.
This class queries and sets settings specific to formboard pin list.
Created in NX9.0.0.
Member Enumeration Documentation
Member Function Documentation
| bool NXOpen::Annotations::PinListBuilder::AutoUpdate | ( | ) |
Returns the options specifies whether annotation automatically updates.
Created in NX9.0.0.
License requirements : None
| NXOpen::Annotations::PinListBuilder::FilterType NXOpen::Annotations::PinListBuilder::Filter | ( | ) |
Returns the category specifies the filter type.
Created in NX9.0.0.
License requirements : None
| bool NXOpen::Annotations::PinListBuilder::FlattenHierarchy | ( | ) |
Returns the options specifies whether to flatten hierarchy.
Created in NX9.0.0.
License requirements : None
| void NXOpen::Annotations::PinListBuilder::SetAutoUpdate | ( | bool | autoUpdate | ) |
Sets the options specifies whether annotation automatically updates.
Created in NX9.0.0.
License requirements : routing_harness ("Routing Harness")
- Parameters
-
autoUpdate autoupdate
| void NXOpen::Annotations::PinListBuilder::SetFilter | ( | NXOpen::Annotations::PinListBuilder::FilterType | filter | ) |
Sets the category specifies the filter type.
Created in NX9.0.0.
License requirements : routing_harness ("Routing Harness")
- Parameters
-
filter filter
| void NXOpen::Annotations::PinListBuilder::SetFlattenHierarchy | ( | bool | flattenHierarchy | ) |
Sets the options specifies whether to flatten hierarchy.
Created in NX9.0.0.
License requirements : routing_harness ("Routing Harness")
- Parameters
-
flattenHierarchy flattenhierarchy
|
virtual |
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.
- Returns
- Was self validation successful
Created in NX3.0.1.
License requirements : None
Implements NXOpen::GeometricUtilities::IComponentBuilder.
The documentation for this class was generated from the following file:
- Annotations_PinListBuilder.hxx