NXOpen::Routing::IPath Class Reference

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

Inheritance diagram for NXOpen::Routing::IPath:

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

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

objs	list 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

objs	list 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

end	end 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

start

start 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:

• Routing_IPath.hxx