NXOpen .NET Reference Guide
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Public Member Functions | Protected Member Functions | Properties | List of all members
NXOpen.Routing.HealPath Class Reference

Represents a NXOpen.Routing.HealPath object which holds the data used in the creation of the heal path spline. More...

Inheritance diagram for NXOpen.Routing.HealPath:
NXOpen.TransientObject NXOpen.Utilities.NXRemotableObject IDisposable IMessageSink

Public Member Functions

unsafe void GetAllData (out NXOpen.Point3d startPoint, out NXOpen.Point3d endPoint, out NXOpen.Vector3d startVector, out NXOpen.Vector3d endVector, out double startParms, out double endParms, out double startExtension, out double endExtension, out bool reverseStart, out bool reverseEnd, out NXOpen.Routing.HealMethod healMethod, out NXOpen.Routing.SplineOptions splineOptions)
 Get all the data associated with the heal path creation. More...
 
unsafe double GetEndExtension ()
 Get end extension. More...
 
unsafe double GetEndParms ()
 Get end parameters. More...
 
unsafe NXOpen.Point3d GetEndPoint ()
 Get the end point. More...
 
unsafe NXOpen.Vector3d GetEndVector ()
 Get the end vector. More...
 
unsafe NXOpen.Routing.HealMethod GetHealMethod ()
 Get heal method. More...
 
unsafe NXOpen.Routing.SplineOptions GetSplineOptions ()
 Get spline options (by pole/by points). More...
 
unsafe double GetStartExtension ()
 Get start extension. More...
 
unsafe double GetStartParms ()
 Get start parameters. More...
 
unsafe NXOpen.Point3d GetStartPoint ()
 Get the start point. More...
 
unsafe NXOpen.Vector3d GetStartVector ()
 Get the start vector. More...
 
unsafe void SetAllData (NXOpen.Point3d startPoint, NXOpen.Point3d endPoint, NXOpen.Vector3d startVector, NXOpen.Vector3d endVector, double startParm, double endParm, double startExtension, double endExtension, bool reverseStart, bool reverseEnd, NXOpen.Routing.HealMethod healMethod, NXOpen.Routing.SplineOptions splineOptions)
 Set all the data associated with the heal path creation. More...
 
unsafe void SetEndExtension (double endExtension)
 Set end extension. More...
 
unsafe void SetEndParms (double endParms)
 Set end parameters. More...
 
unsafe void SetEndPoint (NXOpen.Point3d endPoint)
 Set the end point. More...
 
unsafe void SetEndVector (NXOpen.Vector3d endVector)
 Set the end vector. More...
 
unsafe void SetHealMethod (NXOpen.Routing.HealMethod healMethod)
 Set heal method. More...
 
unsafe void SetReverseEnd (bool reverse)
 Sets the reverse end end. More...
 
unsafe void SetReverseStart (bool reverse)
 Sets the reverse start end. More...
 
unsafe void SetSplineOptions (NXOpen.Routing.SplineOptions splineOptions)
 Set spline options. More...
 
unsafe void SetStartExtension (double startExtension)
 Set start extension. More...
 
unsafe void SetStartParms (double startParms)
 Set start parameters. More...
 
unsafe void SetStartPoint (NXOpen.Point3d startPoint)
 Set the start point. More...
 
unsafe void SetStartVector (NXOpen.Vector3d startVector)
 Set the start vector. More...
 
- Public Member Functions inherited from NXOpen.TransientObject
void Dispose ()
 Frees the object from memory. More...
 
void PrintTestData (String variableName)
 <exclude> More...
 
void PrintTestData (String variableName, int lineNumber)
 <exclude> More...
 
new string ToString ()
 Returns a String that represents the current Object. More...
 
- Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl AsyncProcessMessage (IMessage msg, IMessageSink replySink)
 Asynchronously processes the given message. More...
 
IMessage SyncProcessMessage (IMessage msg)
 Synchronously processes the given message. More...
 

Protected Member Functions

override void FreeResource ()
 Frees the object from memory. More...
 

Properties

unsafe bool ReverseEnd [get]
 Returns the reverse end end. More...
 
unsafe bool ReverseStart [get]
 Returns the reverse start end. More...
 
- Properties inherited from NXOpen.TransientObject
IntPtr Handle [get]
 Handle of the internal object represented by this object. More...
 
- Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink NextSink [get]
 Gets the next message sink in the sink chain. More...
 

Detailed Description

Represents a NXOpen.Routing.HealPath object which holds the data used in the creation of the heal path spline.

Created in NX5.0.0

Member Function Documentation

override void NXOpen.Routing.HealPath.FreeResource ( )
inlineprotectedvirtual

Frees the object from memory.

After this method is called, it is illegal to use the object.

Created in NX5.0.0

License requirements: None.

Implements NXOpen.TransientObject.

unsafe void NXOpen.Routing.HealPath.GetAllData ( out NXOpen.Point3d  startPoint,
out NXOpen.Point3d  endPoint,
out NXOpen.Vector3d  startVector,
out NXOpen.Vector3d  endVector,
out double  startParms,
out double  endParms,
out double  startExtension,
out double  endExtension,
out bool  reverseStart,
out bool  reverseEnd,
out NXOpen.Routing.HealMethod  healMethod,
out NXOpen.Routing.SplineOptions  splineOptions 
)
inline

Get all the data associated with the heal path creation.

Created in NX5.0.0

License requirements: routing_base ("Routing Basic")

Parameters
startPoint
endPoint
startVector
endVector
startParms
endParms
startExtension
endExtension
reverseStart
reverseEnd
healMethod
splineOptions
unsafe double NXOpen.Routing.HealPath.GetEndExtension ( )
inline

Get end extension.

Created in NX5.0.0

License requirements: routing_base ("Routing Basic")

Returns
unsafe double NXOpen.Routing.HealPath.GetEndParms ( )
inline

Get end parameters.

Created in NX5.0.0

License requirements: routing_base ("Routing Basic")

Returns
unsafe NXOpen.Point3d NXOpen.Routing.HealPath.GetEndPoint ( )
inline

Get the end point.

Queries from end object if input is origin.

Created in NX5.0.0

License requirements: routing_base ("Routing Basic")

Returns
unsafe NXOpen.Vector3d NXOpen.Routing.HealPath.GetEndVector ( )
inline

Get the end vector.

Queries from end object if input is zero vector.

Created in NX5.0.0

License requirements: routing_base ("Routing Basic")

Returns
unsafe NXOpen.Routing.HealMethod NXOpen.Routing.HealPath.GetHealMethod ( )
inline

Get heal method.

Created in NX5.0.0

License requirements: routing_base ("Routing Basic")

Returns
unsafe NXOpen.Routing.SplineOptions NXOpen.Routing.HealPath.GetSplineOptions ( )
inline

Get spline options (by pole/by points).

Created in NX5.0.0

License requirements: routing_base ("Routing Basic")

Returns
unsafe double NXOpen.Routing.HealPath.GetStartExtension ( )
inline

Get start extension.

Created in NX5.0.0

License requirements: routing_base ("Routing Basic")

Returns
unsafe double NXOpen.Routing.HealPath.GetStartParms ( )
inline

Get start parameters.

Created in NX5.0.0

License requirements: routing_base ("Routing Basic")

Returns
unsafe NXOpen.Point3d NXOpen.Routing.HealPath.GetStartPoint ( )
inline

Get the start point.

Queries from start object if input is origin.

Created in NX5.0.0

License requirements: routing_base ("Routing Basic")

Returns
unsafe NXOpen.Vector3d NXOpen.Routing.HealPath.GetStartVector ( )
inline

Get the start vector.

Queries from start object if input is zero vector.

Created in NX5.0.0

License requirements: routing_base ("Routing Basic")

Returns
unsafe void NXOpen.Routing.HealPath.SetAllData ( NXOpen.Point3d  startPoint,
NXOpen.Point3d  endPoint,
NXOpen.Vector3d  startVector,
NXOpen.Vector3d  endVector,
double  startParm,
double  endParm,
double  startExtension,
double  endExtension,
bool  reverseStart,
bool  reverseEnd,
NXOpen.Routing.HealMethod  healMethod,
NXOpen.Routing.SplineOptions  splineOptions 
)
inline

Set all the data associated with the heal path creation.

Created in NX5.0.0

License requirements: routing_base ("Routing Basic")

Parameters
startPoint
endPoint
startVector
endVector
startParm
endParm
startExtension
endExtension
reverseStart
reverseEnd
healMethod
splineOptions
unsafe void NXOpen.Routing.HealPath.SetEndExtension ( double  endExtension)
inline

Set end extension.

Created in NX5.0.0

License requirements: routing_base ("Routing Basic")

Parameters
endExtension
unsafe void NXOpen.Routing.HealPath.SetEndParms ( double  endParms)
inline

Set end parameters.

Created in NX5.0.0

License requirements: routing_base ("Routing Basic")

Parameters
endParms
unsafe void NXOpen.Routing.HealPath.SetEndPoint ( NXOpen.Point3d  endPoint)
inline

Set the end point.

Created in NX5.0.0

License requirements: routing_base ("Routing Basic")

Parameters
endPoint
unsafe void NXOpen.Routing.HealPath.SetEndVector ( NXOpen.Vector3d  endVector)
inline

Set the end vector.

Created in NX5.0.0

License requirements: routing_base ("Routing Basic")

Parameters
endVector
unsafe void NXOpen.Routing.HealPath.SetHealMethod ( NXOpen.Routing.HealMethod  healMethod)
inline

Set heal method.

Created in NX5.0.0

License requirements: routing_base ("Routing Basic")

Parameters
healMethod
unsafe void NXOpen.Routing.HealPath.SetReverseEnd ( bool  reverse)
inline

Sets the reverse end end.

Reverse the direction tha tthe end of the heal path takes when the path is healed.

Created in NX5.0.0

License requirements: routing_base ("Routing Basic")

Parameters
reverse
unsafe void NXOpen.Routing.HealPath.SetReverseStart ( bool  reverse)
inline

Sets the reverse start end.

Reverse the direction that the start of the heal path takes when the path is healed.

Created in NX5.0.0

License requirements: routing_base ("Routing Basic")

Parameters
reverse
unsafe void NXOpen.Routing.HealPath.SetSplineOptions ( NXOpen.Routing.SplineOptions  splineOptions)
inline

Set spline options.

Created in NX5.0.0

License requirements: routing_base ("Routing Basic")

Parameters
splineOptions
unsafe void NXOpen.Routing.HealPath.SetStartExtension ( double  startExtension)
inline

Set start extension.

Created in NX5.0.0

License requirements: routing_base ("Routing Basic")

Parameters
startExtension
unsafe void NXOpen.Routing.HealPath.SetStartParms ( double  startParms)
inline

Set start parameters.

Created in NX5.0.0

License requirements: routing_base ("Routing Basic")

Parameters
startParms
unsafe void NXOpen.Routing.HealPath.SetStartPoint ( NXOpen.Point3d  startPoint)
inline

Set the start point.

Created in NX5.0.0

License requirements: routing_base ("Routing Basic")

Parameters
startPoint
unsafe void NXOpen.Routing.HealPath.SetStartVector ( NXOpen.Vector3d  startVector)
inline

Set the start vector.

Created in NX5.0.0

License requirements: routing_base ("Routing Basic")

Parameters
startVector

Property Documentation

unsafe bool NXOpen.Routing.HealPath.ReverseEnd
get

Returns the reverse end end.

Reverse the direction tha tthe end of the heal path takes when the path is healed.

Created in NX5.0.0

License requirements: routing_base ("Routing Basic")

unsafe bool NXOpen.Routing.HealPath.ReverseStart
get

Returns the reverse start end.

Reverse the direction that the start of the heal path takes when the path is healed.

Created in NX5.0.0

License requirements: routing_base ("Routing Basic")


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