NXOpen .NET Reference Guide  1899
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Classes | Public Types | Public Member Functions | List of all members
NXOpen.UF.UFPath Class Reference

Contains wrappers for all 'UF_PATH' functions and data types. More...

Inheritance diagram for NXOpen.UF.UFPath:
NXOpen.Utilities.NXRemotableObject IMessageSink

Classes

struct  _SpindleOn
 
struct  CircularMotion
 Wrapper for UF_PATH_circular_motion_s More...
 
struct  ContactData
 Wrapper for UF_PATH_contact_data_s More...
 
struct  Cutcom
 Wrapper for UF_PATH_cutcom_s More...
 
struct  Flush
 Wrapper for UF_PATH_flush_s More...
 
struct  HelicalMotion
 Wrapper for UF_PATH_helical_motion_s More...
 
struct  LevelMarker
 Wrapper for UF_PATH_level_marker_s More...
 
struct  LinearMotion
 Wrapper for UF_PATH_linear_motion_s More...
 
struct  Rotate
 Wrapper for UF_PATH_rotate_s More...
 
struct  SpindleOn
 Wrapper for UF_PATH_spindle_on_s More...
 
struct  ToolChange
 Wrapper for UF_PATH_tool_change_s More...
 
struct  TrackingPointChange
 Wrapper for UF_PATH_tracking_point_change_s More...
 

Public Types

enum  ArcMode
 Wrapper for UF_PATH_arc_mode_e More...
 
enum  Axis
 Wrapper for UF_PATH_axis_e More...
 
enum  ClampStatus
 Wrapper for UF_PATH_clamp_status_e More...
 
enum  CoolantType
 Wrapper for UF_PATH_coolant_type_e More...
 
enum  CutcomMode
 Wrapper for UF_PATH_cutcom_mode_e More...
 
enum  CutcomOff
 Wrapper for UF_PATH_cutcom_off_e More...
 
enum  CutcomOn
 Wrapper for UF_PATH_cutcom_on_e More...
 
enum  Direction
 Wrapper for UF_PATH_direction_e More...
 
enum  DwellUnit
 Wrapper for UF_PATH_dwell_unit_e More...
 
enum  FeedrateMode
 Wrapper for UF_PATH_feedrate_mode_e More...
 
enum  FeedUnit
 Wrapper for UF_PATH_feed_unit_e More...
 
enum  FlushType
 Wrapper for UF_PATH_flush_type_e More...
 
enum  Guide
 Wrapper for UF_PATH_guide_e More...
 
enum  HeadType
 Wrapper for UF_PATH_head_type_e More...
 
enum  MachineMode
 Wrapper for UF_PATH_machine_mode_e More...
 
enum  MotionType
 Wrapper for UF_PATH_motion_type_e More...
 
enum  OpSkip
 Wrapper for UF_PATH_op_skip_e More...
 
enum  OutputMode
 Wrapper for UF_PATH_output_mode_e More...
 
enum  ParallelMode
 Wrapper for UF_PATH_parallel_mode_e More...
 
enum  PlaneType
 Wrapper for UF_PATH_plane_type_e More...
 
enum  Pressure
 Wrapper for UF_PATH_pressure_e More...
 
enum  RotationObject
 Wrapper for UF_PATH_rotation_object_e More...
 
enum  RotationType
 Wrapper for UF_PATH_rotation_type_e More...
 
enum  Seqno
 Wrapper for UF_PATH_seqno_e More...
 
enum  Shape
 Wrapper for UF_PATH_shape_e More...
 
enum  Side
 Wrapper for UF_PATH_side_e More...
 
enum  SpindleMode
 Wrapper for UF_PATH_spindle_mode_e More...
 
enum  TankType
 Wrapper for UF_PATH_tank_type_e More...
 

Public Member Functions

void CreateAuxfun (IntPtr path_id, int auxfun_code, string text)
 Wrapper method for UF_PATH_create_auxfun More...
 
void CreateCircularMotion (IntPtr path_id, ref CircularMotion circular_motion_data)
 Wrapper method for UF_PATH_create_circular_motion More...
 
void CreateClamp (IntPtr path_id, ClampStatus clamp_status, Axis axis_type, string text)
 Wrapper method for UF_PATH_create_clamp More...
 
void CreateContactCircularMotion (IntPtr path_id, ref CircularMotion motion_data, ref ContactData contact_data)
 Wrapper method for UF_PATH_create_contact_circular_motion More...
 
void CreateContactLinearMotion (IntPtr path_id, ref LinearMotion linear_motion_data, ref ContactData contact_data)
 Wrapper method for UF_PATH_create_contact_linear_motion More...
 
void CreateCoolantOff (IntPtr paht_id, string text)
 Wrapper method for UF_PATH_create_coolant_off More...
 
void CreateCoolantOn (IntPtr path_id, CoolantType coolant_type, string text)
 Wrapper method for UF_PATH_create_coolant_on More...
 
void CreateCutcom (IntPtr path_id, ref Cutcom cutcom_data, string text)
 Wrapper method for UF_PATH_create_cutcom More...
 
void CreateCutWire (IntPtr path_id, string text)
 Wrapper method for UF_PATH_create_cut_wire More...
 
void CreateDwell (IntPtr path_id, double dwell_value, DwellUnit dwell_unit, string text)
 Wrapper method for UF_PATH_create_dwell More...
 
void CreateFedrat (IntPtr path_id, double fedrat_value, string text)
 Wrapper method for UF_PATH_create_fedrat More...
 
void CreateFlush (IntPtr path_id, ref Flush flush_data, string text)
 Wrapper method for UF_PATH_create_flush More...
 
void CreateFlushTank (IntPtr path_id, TankType tank_type, string text)
 Wrapper method for UF_PATH_create_flush_tank More...
 
void CreateHelicalMotion (IntPtr path_id, ref HelicalMotion helical_motion_data)
 Wrapper method for UF_PATH_create_helical_motion More...
 
void CreateLevelMarker (IntPtr path_id, ref LevelMarker level_marker_data)
 Wrapper method for UF_PATH_create_level_marker More...
 
void CreateLinearMotion (IntPtr path_id, ref LinearMotion linear_motion_data)
 Wrapper method for UF_PATH_create_linear_motion More...
 
void CreateOpmessage (IntPtr path_id, string text)
 Wrapper method for UF_PATH_create_opmessage More...
 
void CreateOpSkip (IntPtr path_id, OpSkip skip_option, string text)
 Wrapper method for UF_PATH_create_op_skip More...
 
void CreateOpStop (IntPtr path_id, string text)
 Wrapper method for UF_PATH_create_op_stop More...
 
void CreateOrigin (IntPtr path_id, double[] origin_coordinates, string text)
 Wrapper method for UF_PATH_create_origin More...
 
void CreatePower (IntPtr path_id, double power_value, string text)
 Wrapper method for UF_PATH_create_power More...
 
void CreatePprint (IntPtr path_id, string text)
 Wrapper method for UF_PATH_create_pprint More...
 
void CreatePrefun (IntPtr path_id, int prefun_code, string text)
 Wrapper method for UF_PATH_create_prefun More...
 
void CreateRotate (IntPtr path_id, ref Rotate rotate_data, string text)
 Wrapper method for UF_PATH_create_rotate More...
 
void CreateSelectHead (IntPtr path_id, HeadType head_type, string text)
 Wrapper method for UF_PATH_create_select_head More...
 
void CreateSeqno (IntPtr path_id, Seqno seq_type, int seq_number, int seq_incr, int seq_freq, string text)
 Wrapper method for UF_PATH_create_seqno More...
 
void CreateSetMode (IntPtr path_id, OutputMode ouput_mode, FeedrateMode feedrate_mode, ArcMode arc_mode, ParallelMode parallel_mode, MachineMode machine_mode, string text)
 Wrapper method for UF_PATH_create_set_mode More...
 
void CreateSpindleOff (IntPtr path_id, string text)
 Wrapper method for UF_PATH_create_spindle_off More...
 
unsafe void CreateSpindleOn (IntPtr path_id, ref SpindleOn spindle_on_data, string text)
 Wrapper method for UF_PATH_create_spindle_on More...
 
void CreateSpindleReverse (IntPtr path_id, string text)
 Wrapper method for UF_PATH_create_spindle_reverse More...
 
void CreateStop (IntPtr path_id, string text)
 Wrapper method for UF_PATH_create_stop More...
 
void CreateText (IntPtr path_id, string text)
 Wrapper method for UF_PATH_create_text More...
 
void CreateThreadWire (IntPtr path_id, string text)
 Wrapper method for UF_PATH_create_thread_wire More...
 
void CreateToolChange (IntPtr path_id, ref ToolChange tool_change_data, string text)
 Wrapper method for UF_PATH_create_tool_change More...
 
void CreateToolLengthComp (IntPtr path_id, int tool_comp_register, string text)
 Wrapper method for UF_PATH_create_tool_length_comp More...
 
void CreateToolPreselect (IntPtr path_id, int tool_number, string text)
 Wrapper method for UF_PATH_create_tool_preselect More...
 
void CreateTrackingPointChange (IntPtr path_id, ref TrackingPointChange tool_change_data)
 Wrapper method for UF_PATH_create_tracking_point_change More...
 
void CreateWireAngle (IntPtr path_id, double slope_value, double angle_value, bool angle_flag, string text)
 Wrapper method for UF_PATH_create_wire_angle More...
 
void CreateWireCutcom (IntPtr path_id, CutcomMode cutcom_mode, int adjust_register, bool cutcom_off_flag, bool adjust_flag, string text)
 Wrapper method for UF_PATH_create_wire_cutcom More...
 
void CreateWireGuides (IntPtr path_id, string text)
 Wrapper method for UF_PATH_create_wire_guides More...
 
void EndToolPath (IntPtr path_id)
 Wrapper method for UF_PATH_end_tool_path More...
 
void InitToolPath (IntPtr path_id)
 Wrapper method for UF_PATH_init_tool_path 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...
 

Additional Inherited Members

- Protected Member Functions inherited from NXOpen.Utilities.NXRemotableObject
void initialize ()
 <exclude> More...
 
- Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink NextSink [get]
 Gets the next message sink in the sink chain. More...
 

Detailed Description

Contains wrappers for all 'UF_PATH' functions and data types.

Member Enumeration Documentation

Wrapper for UF_PATH_arc_mode_e

Refer to UF_PATH_arc_mode_e for documentation

Wrapper for UF_PATH_axis_e

Refer to UF_PATH_axis_e for documentation

Wrapper for UF_PATH_clamp_status_e

Refer to UF_PATH_clamp_status_e for documentation

Wrapper for UF_PATH_coolant_type_e

Refer to UF_PATH_coolant_type_e for documentation

Wrapper for UF_PATH_cutcom_mode_e

Refer to UF_PATH_cutcom_mode_e for documentation

Wrapper for UF_PATH_cutcom_off_e

Refer to UF_PATH_cutcom_off_e for documentation

Wrapper for UF_PATH_cutcom_on_e

Refer to UF_PATH_cutcom_on_e for documentation

Wrapper for UF_PATH_direction_e

Refer to UF_PATH_direction_e for documentation

Wrapper for UF_PATH_dwell_unit_e

Refer to UF_PATH_dwell_unit_e for documentation

Wrapper for UF_PATH_feedrate_mode_e

Refer to UF_PATH_feedrate_mode_e for documentation

Wrapper for UF_PATH_feed_unit_e

Refer to UF_PATH_feed_unit_e for documentation

Wrapper for UF_PATH_flush_type_e

Refer to UF_PATH_flush_type_e for documentation

Wrapper for UF_PATH_guide_e

Refer to UF_PATH_guide_e for documentation

Wrapper for UF_PATH_head_type_e

Refer to UF_PATH_head_type_e for documentation

Wrapper for UF_PATH_machine_mode_e

Refer to UF_PATH_machine_mode_e for documentation

Wrapper for UF_PATH_motion_type_e

Refer to UF_PATH_motion_type_e for documentation

Wrapper for UF_PATH_op_skip_e

Refer to UF_PATH_op_skip_e for documentation

Wrapper for UF_PATH_output_mode_e

Refer to UF_PATH_output_mode_e for documentation

Wrapper for UF_PATH_parallel_mode_e

Refer to UF_PATH_parallel_mode_e for documentation

Wrapper for UF_PATH_plane_type_e

Refer to UF_PATH_plane_type_e for documentation

Wrapper for UF_PATH_pressure_e

Refer to UF_PATH_pressure_e for documentation

Wrapper for UF_PATH_rotation_object_e

Refer to UF_PATH_rotation_object_e for documentation

Wrapper for UF_PATH_rotation_type_e

Refer to UF_PATH_rotation_type_e for documentation

Wrapper for UF_PATH_seqno_e

Refer to UF_PATH_seqno_e for documentation

Wrapper for UF_PATH_shape_e

Refer to UF_PATH_shape_e for documentation

Wrapper for UF_PATH_side_e

Refer to UF_PATH_side_e for documentation

Wrapper for UF_PATH_spindle_mode_e

Refer to UF_PATH_spindle_mode_e for documentation

Wrapper for UF_PATH_tank_type_e

Refer to UF_PATH_tank_type_e for documentation

Member Function Documentation

void NXOpen.UF.UFPath.CreateAuxfun ( IntPtr  path_id,
int  auxfun_code,
string  text 
)
inline

Wrapper method for UF_PATH_create_auxfun

Refer to UF_PATH_create_auxfun for documentation

License requirements:None

void NXOpen.UF.UFPath.CreateCircularMotion ( IntPtr  path_id,
ref CircularMotion  circular_motion_data 
)
inline

Wrapper method for UF_PATH_create_circular_motion

Refer to UF_PATH_create_circular_motion for documentation

License requirements:None

void NXOpen.UF.UFPath.CreateClamp ( IntPtr  path_id,
ClampStatus  clamp_status,
Axis  axis_type,
string  text 
)
inline

Wrapper method for UF_PATH_create_clamp

Refer to UF_PATH_create_clamp for documentation

License requirements:None

void NXOpen.UF.UFPath.CreateContactCircularMotion ( IntPtr  path_id,
ref CircularMotion  motion_data,
ref ContactData  contact_data 
)
inline

Wrapper method for UF_PATH_create_contact_circular_motion

Refer to UF_PATH_create_contact_circular_motion for documentation

License requirements:None

void NXOpen.UF.UFPath.CreateContactLinearMotion ( IntPtr  path_id,
ref LinearMotion  linear_motion_data,
ref ContactData  contact_data 
)
inline

Wrapper method for UF_PATH_create_contact_linear_motion

Refer to UF_PATH_create_contact_linear_motion for documentation

License requirements:None

void NXOpen.UF.UFPath.CreateCoolantOff ( IntPtr  paht_id,
string  text 
)
inline

Wrapper method for UF_PATH_create_coolant_off

Refer to UF_PATH_create_coolant_off for documentation

License requirements:None

void NXOpen.UF.UFPath.CreateCoolantOn ( IntPtr  path_id,
CoolantType  coolant_type,
string  text 
)
inline

Wrapper method for UF_PATH_create_coolant_on

Refer to UF_PATH_create_coolant_on for documentation

License requirements:None

void NXOpen.UF.UFPath.CreateCutcom ( IntPtr  path_id,
ref Cutcom  cutcom_data,
string  text 
)
inline

Wrapper method for UF_PATH_create_cutcom

Refer to UF_PATH_create_cutcom for documentation

License requirements:None

void NXOpen.UF.UFPath.CreateCutWire ( IntPtr  path_id,
string  text 
)
inline

Wrapper method for UF_PATH_create_cut_wire

Refer to UF_PATH_create_cut_wire for documentation

License requirements:None

void NXOpen.UF.UFPath.CreateDwell ( IntPtr  path_id,
double  dwell_value,
DwellUnit  dwell_unit,
string  text 
)
inline

Wrapper method for UF_PATH_create_dwell

Refer to UF_PATH_create_dwell for documentation

License requirements:None

void NXOpen.UF.UFPath.CreateFedrat ( IntPtr  path_id,
double  fedrat_value,
string  text 
)
inline

Wrapper method for UF_PATH_create_fedrat

Refer to UF_PATH_create_fedrat for documentation

License requirements:None

void NXOpen.UF.UFPath.CreateFlush ( IntPtr  path_id,
ref Flush  flush_data,
string  text 
)
inline

Wrapper method for UF_PATH_create_flush

Refer to UF_PATH_create_flush for documentation

License requirements:None

void NXOpen.UF.UFPath.CreateFlushTank ( IntPtr  path_id,
TankType  tank_type,
string  text 
)
inline

Wrapper method for UF_PATH_create_flush_tank

Refer to UF_PATH_create_flush_tank for documentation

License requirements:None

void NXOpen.UF.UFPath.CreateHelicalMotion ( IntPtr  path_id,
ref HelicalMotion  helical_motion_data 
)
inline

Wrapper method for UF_PATH_create_helical_motion

Refer to UF_PATH_create_helical_motion for documentation

License requirements:None

void NXOpen.UF.UFPath.CreateLevelMarker ( IntPtr  path_id,
ref LevelMarker  level_marker_data 
)
inline

Wrapper method for UF_PATH_create_level_marker

Refer to UF_PATH_create_level_marker for documentation

License requirements:None

void NXOpen.UF.UFPath.CreateLinearMotion ( IntPtr  path_id,
ref LinearMotion  linear_motion_data 
)
inline

Wrapper method for UF_PATH_create_linear_motion

Refer to UF_PATH_create_linear_motion for documentation

License requirements:None

void NXOpen.UF.UFPath.CreateOpmessage ( IntPtr  path_id,
string  text 
)
inline

Wrapper method for UF_PATH_create_opmessage

Refer to UF_PATH_create_opmessage for documentation

License requirements:None

void NXOpen.UF.UFPath.CreateOpSkip ( IntPtr  path_id,
OpSkip  skip_option,
string  text 
)
inline

Wrapper method for UF_PATH_create_op_skip

Refer to UF_PATH_create_op_skip for documentation

License requirements:None

void NXOpen.UF.UFPath.CreateOpStop ( IntPtr  path_id,
string  text 
)
inline

Wrapper method for UF_PATH_create_op_stop

Refer to UF_PATH_create_op_stop for documentation

License requirements:None

void NXOpen.UF.UFPath.CreateOrigin ( IntPtr  path_id,
double[]  origin_coordinates,
string  text 
)
inline

Wrapper method for UF_PATH_create_origin

Refer to UF_PATH_create_origin for documentation

License requirements:None

void NXOpen.UF.UFPath.CreatePower ( IntPtr  path_id,
double  power_value,
string  text 
)
inline

Wrapper method for UF_PATH_create_power

Refer to UF_PATH_create_power for documentation

License requirements:None

void NXOpen.UF.UFPath.CreatePprint ( IntPtr  path_id,
string  text 
)
inline

Wrapper method for UF_PATH_create_pprint

Refer to UF_PATH_create_pprint for documentation

License requirements:None

void NXOpen.UF.UFPath.CreatePrefun ( IntPtr  path_id,
int  prefun_code,
string  text 
)
inline

Wrapper method for UF_PATH_create_prefun

Refer to UF_PATH_create_prefun for documentation

License requirements:None

void NXOpen.UF.UFPath.CreateRotate ( IntPtr  path_id,
ref Rotate  rotate_data,
string  text 
)
inline

Wrapper method for UF_PATH_create_rotate

Refer to UF_PATH_create_rotate for documentation

License requirements:None

void NXOpen.UF.UFPath.CreateSelectHead ( IntPtr  path_id,
HeadType  head_type,
string  text 
)
inline

Wrapper method for UF_PATH_create_select_head

Refer to UF_PATH_create_select_head for documentation

License requirements:None

void NXOpen.UF.UFPath.CreateSeqno ( IntPtr  path_id,
Seqno  seq_type,
int  seq_number,
int  seq_incr,
int  seq_freq,
string  text 
)
inline

Wrapper method for UF_PATH_create_seqno

Refer to UF_PATH_create_seqno for documentation

License requirements:None

void NXOpen.UF.UFPath.CreateSetMode ( IntPtr  path_id,
OutputMode  ouput_mode,
FeedrateMode  feedrate_mode,
ArcMode  arc_mode,
ParallelMode  parallel_mode,
MachineMode  machine_mode,
string  text 
)
inline

Wrapper method for UF_PATH_create_set_mode

Refer to UF_PATH_create_set_mode for documentation

License requirements:None

void NXOpen.UF.UFPath.CreateSpindleOff ( IntPtr  path_id,
string  text 
)
inline

Wrapper method for UF_PATH_create_spindle_off

Refer to UF_PATH_create_spindle_off for documentation

License requirements:None

unsafe void NXOpen.UF.UFPath.CreateSpindleOn ( IntPtr  path_id,
ref SpindleOn  spindle_on_data,
string  text 
)
inline

Wrapper method for UF_PATH_create_spindle_on

Refer to UF_PATH_create_spindle_on for documentation

License requirements:None

void NXOpen.UF.UFPath.CreateSpindleReverse ( IntPtr  path_id,
string  text 
)
inline

Wrapper method for UF_PATH_create_spindle_reverse

Refer to UF_PATH_create_spindle_reverse for documentation

License requirements:None

void NXOpen.UF.UFPath.CreateStop ( IntPtr  path_id,
string  text 
)
inline

Wrapper method for UF_PATH_create_stop

Refer to UF_PATH_create_stop for documentation

License requirements:None

void NXOpen.UF.UFPath.CreateText ( IntPtr  path_id,
string  text 
)
inline

Wrapper method for UF_PATH_create_text

Refer to UF_PATH_create_text for documentation

License requirements:None

void NXOpen.UF.UFPath.CreateThreadWire ( IntPtr  path_id,
string  text 
)
inline

Wrapper method for UF_PATH_create_thread_wire

Refer to UF_PATH_create_thread_wire for documentation

License requirements:None

void NXOpen.UF.UFPath.CreateToolChange ( IntPtr  path_id,
ref ToolChange  tool_change_data,
string  text 
)
inline

Wrapper method for UF_PATH_create_tool_change

Refer to UF_PATH_create_tool_change for documentation

License requirements:None

void NXOpen.UF.UFPath.CreateToolLengthComp ( IntPtr  path_id,
int  tool_comp_register,
string  text 
)
inline

Wrapper method for UF_PATH_create_tool_length_comp

Refer to UF_PATH_create_tool_length_comp for documentation

License requirements:None

void NXOpen.UF.UFPath.CreateToolPreselect ( IntPtr  path_id,
int  tool_number,
string  text 
)
inline

Wrapper method for UF_PATH_create_tool_preselect

Refer to UF_PATH_create_tool_preselect for documentation

License requirements:None

void NXOpen.UF.UFPath.CreateTrackingPointChange ( IntPtr  path_id,
ref TrackingPointChange  tool_change_data 
)
inline

Wrapper method for UF_PATH_create_tracking_point_change

Refer to UF_PATH_create_tracking_point_change for documentation

License requirements:None

void NXOpen.UF.UFPath.CreateWireAngle ( IntPtr  path_id,
double  slope_value,
double  angle_value,
bool  angle_flag,
string  text 
)
inline

Wrapper method for UF_PATH_create_wire_angle

Refer to UF_PATH_create_wire_angle for documentation

License requirements:None

void NXOpen.UF.UFPath.CreateWireCutcom ( IntPtr  path_id,
CutcomMode  cutcom_mode,
int  adjust_register,
bool  cutcom_off_flag,
bool  adjust_flag,
string  text 
)
inline

Wrapper method for UF_PATH_create_wire_cutcom

Refer to UF_PATH_create_wire_cutcom for documentation

License requirements:None

void NXOpen.UF.UFPath.CreateWireGuides ( IntPtr  path_id,
string  text 
)
inline

Wrapper method for UF_PATH_create_wire_guides

Refer to UF_PATH_create_wire_guides for documentation

License requirements:None

void NXOpen.UF.UFPath.EndToolPath ( IntPtr  path_id)
inline

Wrapper method for UF_PATH_end_tool_path

Refer to UF_PATH_end_tool_path for documentation

License requirements:None

void NXOpen.UF.UFPath.InitToolPath ( IntPtr  path_id)
inline

Wrapper method for UF_PATH_init_tool_path

Refer to UF_PATH_init_tool_path for documentation

License requirements:None


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