NX Open C++ Reference Guide
Public Member Functions | List of all members
NXOpen::Routing::IPath Class Referenceabstract

The Routing IPath object is a list of segments in a route. More...

Inheritance diagram for NXOpen::Routing::IPath:
NXOpen::INXObject NXOpen::Routing::OffsetPath NXOpen::Routing::Path NXOpen::Routing::Wire

Public Member Functions

virtual void AddSegmentsToList (const std::vector< NXOpen::Routing::ISegment * > &objs)=0
 Adds segment(s) to an IPath object. More...
 
virtual
NXOpen::Routing::ControlPoint
ControlPointEnd ()=0
 Returns the end ControlPoint for an IPath object. More...
 
virtual
NXOpen::Routing::ControlPoint
ControlPointStart ()=0
 Returns the start ControlPoint for an IPath object. More...
 
virtual void DelSegmentsFromList (const std::vector< NXOpen::Routing::ISegment * > &objs)=0
 Removes segment(s) from the IPath object. More...
 
virtual std::vector
< NXOpen::Routing::ISegment * > 
GetSegmentList ()=0
 Returns the list of all of the segments contained in the IPath. More...
 
virtual void SetControlPointEnd (NXOpen::Routing::ControlPoint *end)=0
 Sets the end ControlPoint for an IPath object. More...
 
virtual void SetControlPointStart (NXOpen::Routing::ControlPoint *start)=0
 Sets the start ControlPoint for an IPath object. More...
 
- Public Member Functions inherited from NXOpen::INXObject
virtual NXOpen::INXObjectFindObject (const NXString &journalIdentifier)=0
 Finds the NXOpen::NXObject with the given identifier as recorded in a journal. More...
 
virtual NXOpen::INXObjectFindObject (const char *journalIdentifier)=0
 Finds the NXOpen::NXObject with the given identifier as recorded in a journal. More...
 
virtual bool IsOccurrence ()=0
 Returns whether this object is an occurrence or not. More...
 
virtual NXString JournalIdentifier ()=0
 Returns the identifier that would be recorded in a journal for this object. More...
 
virtual NXString Name ()=0
 Returns the custom name of the object. More...
 
virtual
NXOpen::Assemblies::Component
OwningComponent ()=0
 Returns the owning component, if this object is an occurrence. More...
 
virtual NXOpen::BasePartOwningPart ()=0
 Returns the owning part of this object
Created in NX3.0.0. More...
 
virtual void Print ()=0
 Prints a representation of this object to the system log file. More...
 
virtual NXOpen::INXObjectPrototype ()=0
 Returns the prototype of this object if it is an occurrence. More...
 
virtual void SetName (const NXString &name)=0
 Sets the custom name of the object. More...
 
virtual void SetName (const char *name)=0
 Sets the custom name of the object. More...
 

Detailed Description

The Routing IPath object is a list of segments in a route.

It also contains the beginning and ending control point for the path.


Created in NX4.0.0.

Member Function Documentation

virtual void NXOpen::Routing::IPath::AddSegmentsToList ( const std::vector< NXOpen::Routing::ISegment * > &  objs)
pure virtual

Adds segment(s) to an IPath object.


Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters
objslist of segments that are to be added

Implemented in NXOpen::Routing::OffsetPath, NXOpen::Routing::Wire, and NXOpen::Routing::Path.

virtual NXOpen::Routing::ControlPoint* NXOpen::Routing::IPath::ControlPointEnd ( )
pure virtual

Returns the end ControlPoint for an IPath object.


Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Implemented in NXOpen::Routing::OffsetPath, NXOpen::Routing::Wire, and NXOpen::Routing::Path.

virtual NXOpen::Routing::ControlPoint* NXOpen::Routing::IPath::ControlPointStart ( )
pure virtual

Returns the start ControlPoint for an IPath object.


Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Implemented in NXOpen::Routing::OffsetPath, NXOpen::Routing::Wire, and NXOpen::Routing::Path.

virtual void NXOpen::Routing::IPath::DelSegmentsFromList ( const std::vector< NXOpen::Routing::ISegment * > &  objs)
pure virtual

Removes segment(s) from the IPath object.


Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters
objslist of segments that are to be deleted

Implemented in NXOpen::Routing::OffsetPath, NXOpen::Routing::Wire, and NXOpen::Routing::Path.

virtual std::vector<NXOpen::Routing::ISegment *> NXOpen::Routing::IPath::GetSegmentList ( )
pure virtual

Returns the list of all of the segments contained in the IPath.

Returns
list of all of the segments in this IPath object
Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Implemented in NXOpen::Routing::OffsetPath, NXOpen::Routing::Wire, and NXOpen::Routing::Path.

virtual void NXOpen::Routing::IPath::SetControlPointEnd ( NXOpen::Routing::ControlPoint end)
pure virtual

Sets the end ControlPoint for an IPath object.


Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters
endend ControlPoint for the IPath object

Implemented in NXOpen::Routing::OffsetPath, NXOpen::Routing::Wire, and NXOpen::Routing::Path.

virtual void NXOpen::Routing::IPath::SetControlPointStart ( NXOpen::Routing::ControlPoint start)
pure virtual

Sets the start ControlPoint for an IPath object.


Created in NX4.0.0.

License requirements : routing_base ("Routing Basic")

Parameters
startstart ControlPoint for the IPath object

Implemented in NXOpen::Routing::OffsetPath, NXOpen::Routing::Wire, and NXOpen::Routing::Path.


The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.