NX Open C++ Reference Guide
Public Member Functions
NXOpen::Routing::HealPath Class Reference

Represents a 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

List of all members.

Public Member Functions

void GetAllData (NXOpen::Point3d *startPoint, NXOpen::Point3d *endPoint, NXOpen::Vector3d *startVector, NXOpen::Vector3d *endVector, double *startParms, double *endParms, double *startExtension, double *endExtension, bool *reverseStart, bool *reverseEnd, NXOpen::Routing::HealMethod *healMethod, NXOpen::Routing::SplineOptions *splineOptions)
 Get all the data associated with the heal path creation.
double GetEndExtension ()
 Get end extension.
double GetEndParms ()
 Get end parameters.
NXOpen::Point3d GetEndPoint ()
 Get the end point.
NXOpen::Vector3d GetEndVector ()
 Get the end vector.
NXOpen::Routing::HealMethod GetHealMethod ()
 Get heal method.
NXOpen::Routing::SplineOptions GetSplineOptions ()
 Get spline options (by pole/by points).
double GetStartExtension ()
 Get start extension.
double GetStartParms ()
 Get start parameters.
NXOpen::Point3d GetStartPoint ()
 Get the start point.
NXOpen::Vector3d GetStartVector ()
 Get the start vector.
bool ReverseEnd ()
 Returns the reverse end end.
bool ReverseStart ()
 Returns the reverse start end.
void SetAllData (const NXOpen::Point3d &startPoint, const NXOpen::Point3d &endPoint, const NXOpen::Vector3d &startVector, const 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.
void SetEndExtension (double endExtension)
 Set end extension.
void SetEndParms (double endParms)
 Set end parameters.
void SetEndPoint (const NXOpen::Point3d &endPoint)
 Set the end point.
void SetEndVector (const NXOpen::Vector3d &endVector)
 Set the end vector.
void SetHealMethod (NXOpen::Routing::HealMethod healMethod)
 Set heal method.
void SetReverseEnd (bool reverse)
 Sets the reverse end end.
void SetReverseStart (bool reverse)
 Sets the reverse start end.
void SetSplineOptions (NXOpen::Routing::SplineOptions splineOptions)
 Set spline options.
void SetStartExtension (double startExtension)
 Set start extension.
void SetStartParms (double startParms)
 Set start parameters.
void SetStartPoint (const NXOpen::Point3d &startPoint)
 Set the start point.
void SetStartVector (const NXOpen::Vector3d &startVector)
 Set the start vector.
virtual ~HealPath ()
 Frees the object from memory.

Detailed Description

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


Created in NX5.0.0.


Constructor & Destructor Documentation

virtual NXOpen::Routing::HealPath::~HealPath ( ) [virtual]

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


Member Function Documentation

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

Get all the data associated with the heal path creation.


Created in NX5.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
startPointstart point
endPointend point
startVectorstart vector
endVectorend vector
startParmsstart parms
endParmsend parms
startExtensionstart extension
endExtensionend extension
reverseStartreverse start
reverseEndreverse end
healMethodheal method
splineOptionsspline options

Get end extension.

Returns:

Created in NX5.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Get end parameters.

Returns:

Created in NX5.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Get the end point.

Queries from end object if input is origin.

Returns:

Created in NX5.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Get the end vector.

Queries from end object if input is zero vector.

Returns:

Created in NX5.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Get heal method.

Returns:

Created in NX5.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Get spline options (by pole/by points).

Returns:

Created in NX5.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Get start extension.

Returns:

Created in NX5.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Get start parameters.

Returns:

Created in NX5.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Get the start point.

Queries from start object if input is origin.

Returns:

Created in NX5.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Get the start vector.

Queries from start object if input is zero vector.

Returns:

Created in NX5.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

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_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

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_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

void NXOpen::Routing::HealPath::SetAllData ( const NXOpen::Point3d startPoint,
const NXOpen::Point3d endPoint,
const NXOpen::Vector3d startVector,
const 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.


Created in NX5.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
startPointstart point
endPointend point
startVectorstart vector
endVectorend vector
startParmstart parm
endParmend parm
startExtensionstart extension
endExtensionend extension
reverseStartreverse start
reverseEndreverse end
healMethodheal method
splineOptionsspline options
void NXOpen::Routing::HealPath::SetEndExtension ( double  endExtension)

Set end extension.


Created in NX5.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
endExtensionend extension
void NXOpen::Routing::HealPath::SetEndParms ( double  endParms)

Set end parameters.


Created in NX5.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
endParmsend parms

Set the end point.


Created in NX5.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
endPointend point

Set the end vector.


Created in NX5.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
endVectorend vector

Set heal method.


Created in NX5.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
healMethodheal method

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_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
reversereverse

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_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
reversereverse

Set spline options.


Created in NX5.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
splineOptionsspline options
void NXOpen::Routing::HealPath::SetStartExtension ( double  startExtension)

Set start extension.


Created in NX5.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
startExtensionstart extension
void NXOpen::Routing::HealPath::SetStartParms ( double  startParms)

Set start parameters.


Created in NX5.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
startParmsstart parms

Set the start point.


Created in NX5.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
startPointstart point

Set the start vector.


Created in NX5.0.0.

License requirements : routing_combined ("Routing Combined") OR routing_electrical ("Routing Electrical") OR routing_mechanical ("Routing Mechanical")

Parameters:
startVectorstart vector

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