NX Open C++ Reference Guide
Public Member Functions | 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

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. More...
 
double GetEndExtension ()
 Get end extension. More...
 
double GetEndParms ()
 Get end parameters. More...
 
NXOpen::Point3d GetEndPoint ()
 Get the end point. More...
 
NXOpen::Vector3d GetEndVector ()
 Get the end vector. More...
 
NXOpen::Routing::HealMethod GetHealMethod ()
 Get heal method. More...
 
NXOpen::Routing::SplineOptions GetSplineOptions ()
 Get spline options (by pole/by points). More...
 
double GetStartExtension ()
 Get start extension. More...
 
double GetStartParms ()
 Get start parameters. More...
 
NXOpen::Point3d GetStartPoint ()
 Get the start point. More...
 
NXOpen::Vector3d GetStartVector ()
 Get the start vector. More...
 
bool ReverseEnd ()
 Returns the reverse end end. More...
 
bool ReverseStart ()
 Returns the reverse start end. More...
 
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. More...
 
void SetEndExtension (double endExtension)
 Set end extension. More...
 
void SetEndParms (double endParms)
 Set end parameters. More...
 
void SetEndPoint (const NXOpen::Point3d &endPoint)
 Set the end point. More...
 
void SetEndVector (const NXOpen::Vector3d &endVector)
 Set the end vector. More...
 
void SetHealMethod (NXOpen::Routing::HealMethod healMethod)
 Set heal method. More...
 
void SetReverseEnd (bool reverse)
 Sets the reverse end end. More...
 
void SetReverseStart (bool reverse)
 Sets the reverse start end. More...
 
void SetSplineOptions (NXOpen::Routing::SplineOptions splineOptions)
 Set spline options. More...
 
void SetStartExtension (double startExtension)
 Set start extension. More...
 
void SetStartParms (double startParms)
 Set start parameters. More...
 
void SetStartPoint (const NXOpen::Point3d &startPoint)
 Set the start point. More...
 
void SetStartVector (const NXOpen::Vector3d &startVector)
 Set the start vector. More...
 
virtual ~HealPath ()
 Frees the object from memory. More...
 
- Public Member Functions inherited from NXOpen::TransientObject
void * GetHandle ()
 Handle of the internal object represented by this object. 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.

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_base ("Routing Basic")

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
double NXOpen::Routing::HealPath::GetEndExtension ( )

Get end extension.

Returns

Created in NX5.0.0.

License requirements : routing_base ("Routing Basic")
double NXOpen::Routing::HealPath::GetEndParms ( )

Get end parameters.

Returns

Created in NX5.0.0.

License requirements : routing_base ("Routing Basic")
NXOpen::Point3d NXOpen::Routing::HealPath::GetEndPoint ( )

Get the end point.

Queries from end object if input is origin.

Returns

Created in NX5.0.0.

License requirements : routing_base ("Routing Basic")
NXOpen::Vector3d NXOpen::Routing::HealPath::GetEndVector ( )

Get the end vector.

Queries from end object if input is zero vector.

Returns

Created in NX5.0.0.

License requirements : routing_base ("Routing Basic")
NXOpen::Routing::HealMethod NXOpen::Routing::HealPath::GetHealMethod ( )

Get heal method.

Returns

Created in NX5.0.0.

License requirements : routing_base ("Routing Basic")
NXOpen::Routing::SplineOptions NXOpen::Routing::HealPath::GetSplineOptions ( )

Get spline options (by pole/by points).

Returns

Created in NX5.0.0.

License requirements : routing_base ("Routing Basic")
double NXOpen::Routing::HealPath::GetStartExtension ( )

Get start extension.

Returns

Created in NX5.0.0.

License requirements : routing_base ("Routing Basic")
double NXOpen::Routing::HealPath::GetStartParms ( )

Get start parameters.

Returns

Created in NX5.0.0.

License requirements : routing_base ("Routing Basic")
NXOpen::Point3d NXOpen::Routing::HealPath::GetStartPoint ( )

Get the start point.

Queries from start object if input is origin.

Returns

Created in NX5.0.0.

License requirements : routing_base ("Routing Basic")
NXOpen::Vector3d NXOpen::Routing::HealPath::GetStartVector ( )

Get the start vector.

Queries from start object if input is zero vector.

Returns

Created in NX5.0.0.

License requirements : routing_base ("Routing Basic")
bool NXOpen::Routing::HealPath::ReverseEnd ( )

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")

bool NXOpen::Routing::HealPath::ReverseStart ( )

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")

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_base ("Routing Basic")

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_base ("Routing Basic")

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

Set end parameters.


Created in NX5.0.0.

License requirements : routing_base ("Routing Basic")

Parameters
endParmsend parms
void NXOpen::Routing::HealPath::SetEndPoint ( const NXOpen::Point3d endPoint)

Set the end point.


Created in NX5.0.0.

License requirements : routing_base ("Routing Basic")

Parameters
endPointend point
void NXOpen::Routing::HealPath::SetEndVector ( const NXOpen::Vector3d endVector)

Set the end vector.


Created in NX5.0.0.

License requirements : routing_base ("Routing Basic")

Parameters
endVectorend vector
void NXOpen::Routing::HealPath::SetHealMethod ( NXOpen::Routing::HealMethod  healMethod)

Set heal method.


Created in NX5.0.0.

License requirements : routing_base ("Routing Basic")

Parameters
healMethodheal method
void NXOpen::Routing::HealPath::SetReverseEnd ( bool  reverse)

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
reversereverse
void NXOpen::Routing::HealPath::SetReverseStart ( bool  reverse)

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
reversereverse
void NXOpen::Routing::HealPath::SetSplineOptions ( NXOpen::Routing::SplineOptions  splineOptions)

Set spline options.


Created in NX5.0.0.

License requirements : routing_base ("Routing Basic")

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

Set start extension.


Created in NX5.0.0.

License requirements : routing_base ("Routing Basic")

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

Set start parameters.


Created in NX5.0.0.

License requirements : routing_base ("Routing Basic")

Parameters
startParmsstart parms
void NXOpen::Routing::HealPath::SetStartPoint ( const NXOpen::Point3d startPoint)

Set the start point.


Created in NX5.0.0.

License requirements : routing_base ("Routing Basic")

Parameters
startPointstart point
void NXOpen::Routing::HealPath::SetStartVector ( const NXOpen::Vector3d startVector)

Set the start vector.


Created in NX5.0.0.

License requirements : routing_base ("Routing Basic")

Parameters
startVectorstart vector

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