NX Open C++ Reference Guide
|
Provides classes and interfaces for Routing. More...
Namespaces | |
namespace | Electrical |
Provides classes and interfaces for Routing Electrical. | |
Classes | |
class | Anchor |
A Routing Anchor defines a position in a Qualified Routing component part. More... | |
class | AnchorCollection |
Represents a collection of Anchor objects. More... | |
class | ArcSegment |
Represents a arc segment. More... | |
class | ArcSegmentCollection |
Represents a collection of Routing::ArcSegment objects. More... | |
class | AssemblyDefinition |
Represents a collection of Routing::SingleDevice objects that are used in an assembled product. More... | |
class | AssignCornerBuilder |
Builder class for Assign Corner which creates corner To create a new instance of this class, use Routing::RouteManager::CreateAssignCornerBuilder Default values. More... | |
class | AssignDiscontinuityBuilder |
the Builder to Assign Discontinuity for the stocks To create a new instance of this class, use Routing::RouteManager::CreateAssignDiscontinuityBuilder Created in NX7.5.0. More... | |
class | BendCorner |
Computes a fillet curve between to linear segments to form a smooth bend transition from one segment to another. More... | |
class | BendCornerCollection |
Represents a collection of Routing::BendCorner objects. More... | |
class | BuiltInPath |
The Routing BuiltInPath object stores a set of curves. More... | |
class | BuiltInPathCollection |
Represents a collection of BuiltInPath objects. More... | |
class | CharacteristicList |
Contains a list of characteristics. More... | |
class | ClockPartBuilder |
Builder class for clock part object To create a new instance of this class, use Routing::RouteManager::CreateClockPartBuilder Default values. More... | |
class | ConnectedCurvesBuilder |
Builder for creating automatically creating segments on end-to-end connected curves. More... | |
class | ConnectivityDefinition |
The base class for various connection objects. More... | |
class | ConnectPathBuilder |
Represents a Routing::ConnectPathBuilder . More... | |
class | ControlPoint |
Routing Control Points define a position in space, and are used to determine connections from segments to segments, and segments to ports. More... | |
class | ControlPointCollection |
Represents a collection of Routing::ControlPoint objects. More... | |
class | CopeCorner |
The cope corner is a corner that trims stocks at a junction. More... | |
class | CopeCornerBuilder |
Builder class for Cope Corner object To create a new instance of this class, use Routing::RouteManager::CreateCopeCornerBuilder More... | |
class | CopeCornerCollection |
Represents a collection of Routing::CopeCorner objects. More... | |
class | Corner |
The Routing Corner is the abstract parent class of all other corner objects. More... | |
class | CornerCollection |
Represents a collection of Routing::Corner objects. More... | |
class | CornerTypeBuilder |
Contains setting for corner creation. More... | |
class | CreateFabricationBuilder |
Builder class to fabricate subassembly from standard parts, path segments, stock, and other routing objects within the current routing assembly To create a new instance of this class, use Routing::RouteManager::CreateFabricationBuilder Created in NX8.0.0. More... | |
class | CrossSection |
A Routing::CrossSection defines a profile to sweep for Routing::Stock objects. More... | |
class | CrossSectionCollection |
Represents a collection of Routing::CrossSection objects. More... | |
class | DeleteObjectsBuilder |
Represents a Routing::DeleteObjectsBuilder To create a new instance of this class, use Routing::RouteManager::CreateDeleteObjectsBuilder Created in NX6.0.0. More... | |
class | DesignRule |
Represents Routing::DesignRule object Creator not available in KF. More... | |
class | DesignRuleCollection |
Represents a collection of DesignRule objects. More... | |
class | DesignRuleManager |
Represents Routing::DesignRuleManager object Creator not available in KF. More... | |
class | DesignRuleOverride |
Represents Routing DesignRuleOverride object Creator not available in KF. More... | |
class | DesignRuleViolation |
Represents Routing::DesignRuleViolation object Design Rule Violation object is created automatically during design rule check Created in NX4.0.2. More... | |
class | DesignRuleViolationCollection |
Represents a collection of DesignRuleViolation objects. More... | |
class | DesignRuleViolationLocation |
Represents Routing::DesignRuleViolationLocation object Design Rule Violation Location object get created automatically during design rule check Created in NX6.0.0. More... | |
class | DesignRuleViolationLocationCollection |
Represents a collection of DesignRuleViolationLocation objects. More... | |
class | DesignRuleViolationViewer |
This class can be used to set the violation id, update text for overridding the violation and update the user name used to override the violation. More... | |
class | DeviceRelationship |
Represents a relationship between Routing::SingleDevice objects. More... | |
class | DiscontinuityCorner |
A discontinuity corner is a corner that forces Routing::Stock objects to split as they cover the segments attached to the discontinuity corner. More... | |
class | DiscontinuityCornerCollection |
Represents a collection of Routing::DiscontinuityCorner objects. More... | |
class | Division |
Represents Routing::Division Creator not available in KF because transient objects are not supported. More... | |
class | DivisionsBuilder |
Represents a Routing::DivisionsBuilder. More... | |
class | DuctSizeCalculatorBuilder |
Builder to perform calculations of the duct which is to be used in the HVAC applications. More... | |
class | EditBendAngleBuilder |
To create a new instance of this class, use Routing::RouteManager::CreateEditBendAngleBuilder Created in NX7.5.0. More... | |
class | EditCharacteristicsBuilder |
Builder to edit required and optional characteristics of Routing::Stock or Assemblies::Component as defined in the application view file. More... | |
class | EditLineSegmentBuilder |
Builder for the "Edit Line Segment" operation. More... | |
class | ElbowSnapSettings |
Helper object used the by Routing::LinearPathBuilder builder. More... | |
class | ExtractPort |
Routing ExtractPort object is an extract of Port class To create an instance of this class use Routing::PortCollection::CreateExtractPort Created in NX4.0.0. More... | |
class | FeaturePort |
Routing::FeaturePort is a Features::Feature associated with Routing::Port . More... | |
class | Filler |
Represents a Filler Created in NX4.0.0. More... | |
class | FillerCollection |
Represents a collection of Routing::Stock objects. More... | |
class | FillerStockBuilder |
Creates Filler stock on selected Segments. More... | |
class | FittingOverstock |
The Routing::FittingOverstock object represents overstock applied over the faces of the routing parts. More... | |
class | FittingOverstockBuilder |
Builder for creating or editing Routing::FittingOverstock objects. More... | |
class | FittingOverstockCollection |
Represents a collection of Routing::FittingOverstock objects. More... | |
class | FittingPort |
Represents a Routing Fitting Port ObjectFittingPort . More... | |
class | FittingPortCollection |
Represents a collection of FittingPort objects. More... | |
class | FixturePort |
Routing::FixturePort objects are objects that segments are routed through when creating a routing path. More... | |
class | FixturePortCollection |
Represents a collection of FixturePort objects. More... | |
class | FormboardFrame |
The Routing::FormboardFrame is a (not pure) virtual class. More... | |
class | FormboardFrameCGM |
Represents a Formboard Frame CGM. More... | |
class | FormboardFrameCollection |
Represents a collection of FormboardFrame objects. More... | |
class | FormboardFramePattern |
Represents a Formboard Frame Pattern. More... | |
class | FormboardFrameRectangle |
Represents a Formboard Frame Rectangle. More... | |
class | HealPath |
Represents a Routing::HealPath object which holds the data used in the creation of the heal path spline. More... | |
class | IAxisPort |
Interface class for all routing objects that specify a direction Created in NX4.0.0. More... | |
class | ICharacteristic |
Interface for querying and setting characteristic (UG attribute values) on various routing objects. More... | |
class | InfoObjectsBuilder |
Represents a Routing::InfoObjectsBuilder To create a new instance of this class, use Routing::RouteManager::CreateInfoObjectsBuilder Created in NX6.0.0. More... | |
class | InstanceNameLookupBuilder |
Represents a Routing::InstanceNameLookupBuilder . More... | |
class | IntegrateRunsBuilder |
Builder Class for Integrate Runs Object To create a new instance of this class, use Routing::RouteManager::IntegrateRunsBuilder Default values. More... | |
class | InterfaceTerminalBase |
The Routing::InterfaceTerminalBase corresponds to an abstract class for a prototype Routing::Port . More... | |
class | InterfaceTerminalRelationshipBase |
The abstract class Routing::InterfaceTerminalRelationshipBase relates many Routing::Port s to one Routing::Port . More... | |
class | InterfaceTerminalRelationshipCollection |
Represents a collection of InterfaceTerminalRelationshipShadow objects. More... | |
class | InterfaceTerminalRelationshipShadow |
Represents an assembly shadow of Routing::InterfaceTerminalRelationshipBase . More... | |
class | InterfaceTerminalShadow |
Represents the defining data for a physical Routing::Port . More... | |
class | IPath |
The Routing IPath object is a list of segments in a route. More... | |
class | IRoutePosition |
Interface class for all routing objects that specify a single (possibly associative) location in space. More... | |
class | ISegment |
Interface class for all routing segments [Line/Arc/Spline] Created in NX4.0.0. More... | |
class | ISegmentCollection |
Represents a collection of Routing::ISegment objects. More... | |
class | ItemDefinition |
Routing::ItemDefinition object corresponds to DDID in AP212 and to a piece part or routing stock in NX. More... | |
class | LinearPathBuilder |
Builder for creating routing linear paths. More... | |
class | LinearPathSettings |
Helper object used the by Routing::LinearPathBuilder builder. More... | |
class | LineSegment |
Represents a line segment. More... | |
class | LineSegmentCollection |
Represents a collection of Routing::LineSegment objects. More... | |
class | LogicalConnection |
Represents a connection between mutiple From and To Routing::LogicalTerminal . More... | |
class | LogicalTerminal |
Assembly instance of a Routing::InterfaceTerminalBase . More... | |
class | ManualRouteBuilder |
To create a new instance of this class, use Routing::RouteManager::CreateManualRouteBuilder Created in NX7.5.0. More... | |
class | MiterCorner |
This class defines a mitered corner. More... | |
class | MiterCornerCollection |
Represents a collection of Routing::MiterCorner objects. More... | |
class | ModelTerminalsBuilder |
The Builder to Model/UnModel the Terminals To create a new instance of this class, use Routing::RouteManager::ModelTerminalsBuilder Default values. More... | |
class | MultiPort |
Represents a Routing::MultiPort . More... | |
class | MultiPortCollection |
Represents a collection of MultiPort objects. More... | |
class | ObjectRelationship |
Represents a relationship between Routing objects. More... | |
class | OffsetPath |
The Routing OffsetPath object is the set of information needed to define an offset route. More... | |
class | OffsetPathCollection |
The Routing OffsetPath object is a list of segments in a route. More... | |
class | Overstock |
Represents an Routing::Overstock object. More... | |
class | OverstockApplication |
Represents a collection of Routing::OverstockApplication objects. More... | |
class | OverstockApplicationCollection |
Represents a collection of Routing::OverstockApplication objects. More... | |
class | OverstockBuilder |
Builder for creating/editing overstocks. More... | |
class | OverstockDevice |
The Routing::OverstockDevice corresponds to an overstock instance of Routing::StockDevice . More... | |
class | OverstockFacesBuilder |
Builder for qualifying faces for overstock application over fittings. More... | |
class | PartDefinitionBase |
The abstract class Routing::PartDefinitionBase contains information defining a logical part. More... | |
class | PartDefinitionShadow |
Routing::PartDefinitionShadow contains the defining data for a logical part, such as an connector. More... | |
class | Path |
The Routing Path object is the set of ordered continuous segments. More... | |
class | PathStockBuilder |
Assigns stocks to segments based of users critiera and the current default stock. More... | |
class | PlacementSolutionsBuilder |
To create a new instance of this class, use Routing::RouteManager::CreatePlacementSolutionsBuilder Created in NX7.5.0. More... | |
class | PlacePartBuilder |
To create a new instance of this class, use Routing::RouteManager::CreatePlacePartBuilderPTS Created in NX7.5.0. More... | |
class | Port |
Routing Port Object is a parent class for FixturePort, ExtractPort, FittingPort, Multiport, StockPort and TerminalPort Creator not available in KF. More... | |
class | PortCollection |
Represents a collection of Port objects. More... | |
class | PortConnection |
The Routing PortConnection object is used by Routing to position ports while placing parts. More... | |
class | PortConnectionCollection |
Represents a collection of PortConnection objects. More... | |
class | ProxyPort |
A Routing::ProxyPort is a port that represents a connector in another design zone, but not present in this design zone. More... | |
class | ProxyPortCollection |
Represents a collection of ProxyPort objects. More... | |
class | QuickPathBuilder |
Builder for creating a collision free path between points. More... | |
class | RemoveDiscontinuityBuilder |
Builder class for remove discontinuity object To create a new instance of this class, use Routing::RouteManager::CreateRemoveDiscontinuityBuilder Created in NX7.5.0. More... | |
class | ReuseLibrary |
Represents a Routing::ReuseLibrary No creator is available in KF. More... | |
class | RootObject |
The Routing::RootObject is the parent class of all other Routing logical objects. More... | |
class | RouteLogicalAssociation |
RouteLogicalAssociation object associates non-electrical components to electrical components. More... | |
class | RouteLogicalAssociationCollection |
Collection class for RouteLogicalAssociation object To obtain an instance of this class, refer to Routing::RouteManager Created in NX4.0.0. More... | |
class | RouteManager |
Manages various Routing collections and methods for use in the current work part. More... | |
class | RouteObject |
The Top level routing data model object. More... | |
class | RouteObjectCollector |
Represents a Routing::RouteObjectCollector class to create objects for getting routing objects. More... | |
class | RoutePartDescriptor |
Represents a part descriptor chrx. More... | |
class | RoutePartDescriptorCollection |
Represents a collection of RoutePartDescriptor objects. More... | |
class | RouteSweptFoldBuilder |
Represents a Rout Swept Fold Builder To create a new instance of this class, use Routing::RouteManager::CreateRouteSweptFoldBuilder Created in NX7.0.0. More... | |
class | RouteSweptTwistBuilder |
To create a new instance of this class, use Routing::RouteManager::CreateRouteSweptTwistBuilder Created in NX6.0.0. More... | |
class | RoutingMeasureDistanceBuilder |
Represents a RoutingMeasureDistanceBuilder Creator not available in KF because transient objects are not supported. More... | |
class | RoutingSystem |
Routing object is a collection of Run objects. More... | |
class | RoutingSystemCollection |
Represents a collection of Routing::RoutingSystem objects. More... | |
class | Run |
Routing Run object references components and stocks which comprise a piping run. More... | |
class | RunCollection |
Represents a collection of Routing::Run objects. More... | |
class | RunItem |
Routing Run Item object references components which comprise a piping run. More... | |
class | SBendCorner |
The Routing SBendCorner defines a S-Bend. More... | |
class | SBendCornerCollection |
Represents a collection of SBendCorner objects. More... | |
class | SegmentManager |
Contains the type of the routing part as well as the Collection objects for creating/iterating over routing objects. More... | |
class | SegmentPairBuilder |
The builder for creating the list item of SegmentPairs To create a new instance of this class, use Routing::AssignDiscontinuityBuilder::SegmentPairBuilder Created in NX7.5.0. More... | |
class | SelectControlPoint |
Represents a single object selection. More... | |
class | SelectISegment |
Represents a single object selection. More... | |
class | SelectLineSegment |
Represents a single object selection. More... | |
class | SelectPort |
Represents a single object selection. More... | |
class | SelectRun |
Represents a single object selection. More... | |
class | SimplifyPathBuilder |
Represents a Routing::SimplifyPathBuilder for Simplify Path operation. More... | |
class | SingleDevice |
The Routing SingleDevice corresponds to an abstract instance of Routing::ItemDefinition . More... | |
class | SpaceReservationBuilder |
Represents a Routing::SpaceReservationBuilder. More... | |
class | SplinePathBuilder |
Builder for creating a D-Cubed constrained spline. More... | |
class | SplineSegment |
Represents a spline segment. More... | |
class | SplineSegmentCollection |
Represents a collection of Routing::SplineSegment objects. More... | |
class | SplitDuctBuilder |
Represents a Routing::SplitDuctBuilder. More... | |
class | SplitRunBuilder |
Builder Class for Split Run Object To create a new instance of this class, use Routing::RouteManager::SplitRunBuilder Default values. More... | |
class | Stock |
The Routing::Stock object represents a material (such as as pipe or tube) that covers a path of segments. More... | |
class | StockBrowserBuilder |
Builder class for stock browser . More... | |
class | StockBuilder |
Builder for creating/editing stocks. More... | |
class | StockCollection |
Represents a collection of Routing::Stock objects. More... | |
class | StockColorBuilder |
Represents a Routing::StockColorBuilder . More... | |
class | StockData |
A Routing::StockData contains the various profiles, characteristic information, Routing::Anchor and other attributes that define Routing::Stock objects. More... | |
class | StockDataCollection |
Represents a collection of Routing::StockData objects. More... | |
class | StockDefinition |
Represents Routing StockDefinition object Creator not available in KF. More... | |
class | StockDevice |
The Routing StockDevice corresponds to a generic stock instance of Routing::SingleDevice . More... | |
class | StockOffsetPointBuilder |
Applies Assemblies Constraints to a selected Point or Routing::ControlPoint to mimic the update/move behavior of the input smart Point . More... | |
class | StockOffsetPort |
Routing::StockOffsetPort class handles the relationship between a component part's port occurrence and the dumb offset port in the work part. More... | |
class | StockPort |
Routing::StockPort objects are automatically created and updated by Routing::Stock objects. More... | |
class | StockStyleBuilder |
Builder class to assigns style to the selected stock . More... | |
class | StockTransition |
Represents Routing::StockTransition object. More... | |
class | StockTransitionBuilder |
Builder for creating/editing stockTransition. More... | |
class | SubdivideSegmentBuilder |
Represents a Routing::SubdivideSegmentBuilder . More... | |
class | TerminalPort |
A Routing::TerminalPort models the pins on an electrical connector. More... | |
class | TerminalPortBuilder |
Builder for creating the Terminal List Item for the ModelTerminals To create a new instance of this class, use Routing::RouteManager::TerminalPortBuilder Created in NX7.5.0. More... | |
class | TerminalPortCollection |
The collection of all Routing::TerminalPort s. More... | |
class | TransformPathBuilder |
Builder for the "Transform Path" operation. More... | |
class | UnifyPathBuilder |
Builder to unify Routing::Stock and Assemblies::Component based on specified characteristic values. More... | |
class | WatertightFittingsBuilder |
Represents a Routing::WatertightFittingsBuilder To create a new instance of this class, use Routing::RouteManager::CreateWatertightFittingsBuilder Created in NX8.0.0. More... | |
class | Wire |
The Routing Wire object is the set of information needed to define a ROUTE_wire. More... | |
class | WireCollection |
The Routing Wire object is a list of segments in a route and some stock. More... | |
Enumerations | |
enum | ComponentName { ComponentNameTemporary, ComponentNamePermanent } |
Describes whether or not a component associated with a Stock as Compoents Stock has been renamed by the user with a permanent name using the Routing::Stock::RenameComponent method. More... | |
enum | ConvertEccentricLinearToLinear { ConvertEccentricLinearToLinearNotConverted, ConvertEccentricLinearToLinearConverted } |
Option to query if an existing Routing::ISegment is a eccentric segment. More... | |
enum | ConvertLinearToEccentricLinear { ConvertLinearToEccentricLinearNotConverted, ConvertLinearToEccentricLinearConverted } |
Option to query if an existing Routing::ISegment is a eccentric segment. More... | |
enum | CreationMethod { CreationMethodUnknown = -1, CreationMethodEntireSegments, CreationMethodInterval, CreationMethodPointToPoint, CreationMethodPointAndLength } |
Describes the overstock creation method. More... | |
enum | Eccentric { EccentricNotEccentricSeg, EccentricEccentricSeg } |
Option to query if an existing Routing::ISegment is a eccentric segment. More... | |
enum | Flip { FlipNotFlipped, FlipFlipped } |
Describes whether the stock profile is flipped, see the user help documenation on Orient Stock. More... | |
enum | HealMethod { HealMethodDirect, HealMethodIntersect, HealMethodXyz, HealMethodXzy, HealMethodYxz, HealMethodYzx, HealMethodZxy, HealMethodZyx, HealMethodMax } |
Different heal path creation methods. More... | |
enum | Interior { InteriorNotInteriorToPart, InteriorInteriorToPart } |
Option to query if an existing Routing::ISegment is interior to any Part . More... | |
enum | Method { MethodEntireSegments, MethodInterval, MethodPointToPoint, MethodPointAndLength } |
Available application methods for Overstock Applications for a given Overstock. More... | |
enum | Operation { OperationCreate, OperationEdit } |
Available operations to perform for Overstock Applications. More... | |
enum | PointDefinition { PointDefinitionStart, PointDefinitionMiddle, PointDefinitionEnd } |
Available definitions for the point location for the Point and Length application method. More... | |
enum | ProfileFrom { ProfileFromStart, ProfileFromEnd } |
Describes whether the stock profile is located at the first segment in the path or the last segment. More... | |
enum | SplineOptions { SplineOptionsByPoints, SplineOptionsByPoles } |
Different spline creation options. More... | |
enum | StockDataType { StockDataTypeNotBundled, StockDataTypeBundled } |
Whether the Routing::StockData was generated by the bundling algorithm used for routing wires. More... | |
enum | StockStyle { StockStyleNone, StockStyleSimple, StockStyleDetailed } |
Available styles of Routing::CrossSection for a given Routing::StockData . More... | |
enum | StockType { StockTypeUnknown, StockTypeFixedCrossSection, StockTypeWrapped, StockTypeSleeved, StockTypeFlagged } |
Available overstock stock types for Overstock Applications for a given Overstock. More... | |
enum | StockUse { StockUseLegacyStock, StockUseBundled, StockUseStockAsComponent, StockUseStockInComponent, StockUseDeformed } |
Describes how the stock is used. More... | |
enum | Terminal { TerminalNotTerminalSeg, TerminalTerminalSeg } |
Option to query if an existing Routing::ISegment is a terminal segment. More... | |
enum | Type { TypeUnknown = -1, TypeFixedCrossSection, TypeWrapped, TypeSleeved, TypeFlagged } |
Describes the type of overstock. More... | |
enum | UserDefined { UserDefinedNotUserDefined, UserDefinedUserDefined } |
Option to indicate if an existing Routing::LineSegment , Routing::ArcSegment or Routing::SplineSegment is user defined. More... | |
enum | WrapApplicationType { WrapApplicationTypeUnknown, WrapApplicationTypeSpot, WrapApplicationTypeOverlapped, WrapApplicationTypeGapped } |
Available application methods for wrapped overstock. More... |
Provides classes and interfaces for Routing.
Describes whether or not a component associated with a Stock as Compoents Stock has been renamed by the user with a permanent name using the Routing::Stock::RenameComponent method.
Option to query if an existing Routing::ISegment is a eccentric segment.
Option to query if an existing Routing::ISegment is a eccentric segment.
Option to query if an existing Routing::ISegment is a eccentric segment.
Describes whether the stock profile is flipped, see the user help documenation on Orient Stock.
Option to query if an existing Routing::ISegment is interior to any Part .
Available operations to perform for Overstock Applications.
Available definitions for the point location for the Point and Length application method.
Whether the Routing::StockData was generated by the bundling algorithm used for routing wires.
Available styles of Routing::CrossSection for a given Routing::StockData .
A Routing::StockData may have at most one Routing::CrossSection of each type.
Describes how the stock is used.
StockUseLegacyStock |
Normal Legacy Stock. |
StockUseBundled |
Legacy Stock that was generated by the bundling algorithm. |
StockUseStockAsComponent |
Stock as Component stock in the work part. |
StockUseStockInComponent |
Stock as Component stock in the component part. User should not modify this stock. |
StockUseDeformed |
Stock has been deformed using the "Deform Component" functionality. User should not modify this stock. |
Option to query if an existing Routing::ISegment is a terminal segment.
Option to indicate if an existing Routing::LineSegment , Routing::ArcSegment or Routing::SplineSegment is user defined.
Available application methods for wrapped overstock.