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.UFParam Class Reference

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

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

Classes

struct  _IndexAttribute
 
struct  DispPath
 Wrapper for UF_PARAM_disp_path_s More...
 
struct  DispTool
 Wrapper for UF_PARAM_disp_tool_s More...
 
struct  Feedrate
 Wrapper for UF_PARAM_feedrate_s More...
 
struct  IndexAttribute
 Wrapper for UF_PARAM_index_attribute_s More...
 

Public Types

enum  FeedUnit
 Wrapper for UF_PARAM_feed_unit_t More...
 
enum  Regen
 Wrapper for UF_PARAM_regen_e More...
 
enum  Status
 Wrapper for UF_PARAM_status_e More...
 
enum  Type
 Wrapper for UF_PARAM_type_e More...
 

Public Member Functions

void AppendUde (NXOpen.Tag param, UdeSetType ude_set_type, string ude_name, out IntPtr ud_obj)
 Wrapper method for UF_PARAM_append_ude More...
 
void Ask2dValue (NXOpen.Tag param_tag, int param_index,[Out] double[] value)
 Wrapper method for UF_PARAM_ask_2d_value More...
 
void Ask3dValue (NXOpen.Tag param_tag, int param_index,[Out] double[] value)
 Wrapper method for UF_PARAM_ask_3d_value More...
 
void AskDoubleValue (NXOpen.Tag param_tag, int param_index, out double value)
 Wrapper method for UF_PARAM_ask_double_value More...
 
unsafe void AskDoubleVla (NXOpen.Tag param_tag, int param_index, out int count, out double[] dbl_array)
 Wrapper method for UF_PARAM_ask_double_vla More...
 
void AskInheritedParams (NXOpen.Tag param_tag, out int count,[Out] int[] indices)
 Wrapper method for UF_PARAM_ask_inherited_params More...
 
void AskIntValue (NXOpen.Tag param_tag, int param_index, out int value)
 Wrapper method for UF_PARAM_ask_int_value More...
 
unsafe void AskIntVla (NXOpen.Tag param_tag, int param_index, out int count, out int[] int_array)
 Wrapper method for UF_PARAM_ask_int_vla More...
 
void AskLogicalValue (NXOpen.Tag param_tag, int param_index, out bool value)
 Wrapper method for UF_PARAM_ask_logical_value More...
 
unsafe void AskParamAttributes (int param_index, out IndexAttribute attributes)
 Wrapper method for UF_PARAM_ask_param_attributes More...
 
void AskParamDefiner (NXOpen.Tag param_tag, int param_index, out NXOpen.Tag definer_tag)
 Wrapper method for UF_PARAM_ask_param_definer More...
 
void AskParamStatus (NXOpen.Tag param_tag, int param_index, out Status status)
 Wrapper method for UF_PARAM_ask_param_status More...
 
unsafe void AskRequiredParams (NXOpen.Tag param_tag, out int count, out int[] indices)
 Wrapper method for UF_PARAM_ask_required_params More...
 
unsafe void AskStrValue (NXOpen.Tag param_tag, int param_index, out string value)
 Wrapper method for UF_PARAM_ask_str_value More...
 
void AskSubobjPtrValue (NXOpen.Tag param_tag, int param_index, IntPtr value)
 Wrapper method for UF_PARAM_ask_subobj_ptr_value More...
 
void AskTagValue (NXOpen.Tag param_tag, int param_index, out NXOpen.Tag value)
 Wrapper method for UF_PARAM_ask_tag_value More...
 
unsafe void AskTagVla (NXOpen.Tag param_tag, int param_index, out int count, out NXOpen.Tag[] tag_array)
 Wrapper method for UF_PARAM_ask_tag_vla More...
 
unsafe void AskUdes (NXOpen.Tag param, UdeSetType ude_set_type, out int num_of_udes, out IntPtr[] ude_objs)
 Wrapper method for UF_PARAM_ask_udes More...
 
void CanAcceptUde (NXOpen.Tag param, UdeSetType ude_set_type, string ude_name, out bool response)
 Wrapper method for UF_PARAM_can_accept_ude More...
 
void CanAcceptUdeSet (NXOpen.Tag param, UdeSetType ude_set_type, out bool response)
 Wrapper method for UF_PARAM_can_accept_ude_set More...
 
void Check (NXOpen.Tag param, out bool is_ok)
 Wrapper method for UF_PARAM_check More...
 
void DeleteAllUdes (NXOpen.Tag param, UdeSetType ude_set_type)
 Wrapper method for UF_PARAM_delete_all_udes More...
 
void DeleteUde (NXOpen.Tag param, UdeSetType ude_set_type, IntPtr ude_obj)
 Wrapper method for UF_PARAM_delete_ude More...
 
void Duplicate (NXOpen.Tag old_obj_tag, string name, out NXOpen.Tag new_obj_tag)
 Wrapper method for UF_PARAM_duplicate More...
 
void Generate (NXOpen.Tag param_tag, out bool generated)
 Wrapper method for UF_PARAM_generate More...
 
void InheritValue (NXOpen.Tag param_tag, int param_index)
 Wrapper method for UF_PARAM_inherit_value More...
 
void IsInherited (NXOpen.Tag param_tag, int param_index, out bool answer)
 Wrapper method for UF_PARAM_is_inherited More...
 
void IsLoadWithParent (NXOpen.Tag param, out bool response)
 Wrapper method for UF_PARAM_is_load_with_parent More...
 
void IsSameClass (NXOpen.Tag obj1_tag, NXOpen.Tag obj2_tag, out bool answer)
 Wrapper method for UF_PARAM_is_same_class More...
 
void IsTemplate (NXOpen.Tag param, out bool response)
 Wrapper method for UF_PARAM_is_template More...
 
void Reinit (NXOpen.Tag param_to_reinit, NXOpen.Tag param_to_reinit_from)
 Wrapper method for UF_PARAM_reinit More...
 
void Rename (NXOpen.Tag param_tag, string new_name)
 Wrapper method for UF_PARAM_rename More...
 
void ReplayPath (NXOpen.Tag param_tag)
 Wrapper method for UF_PARAM_replay_path More...
 
void Set2dValue (NXOpen.Tag param_tag, int param_index, double[] value)
 Wrapper method for UF_PARAM_set_2d_value More...
 
void Set3dValue (NXOpen.Tag param_tag, int param_index, double[] value)
 Wrapper method for UF_PARAM_set_3d_value More...
 
void SetDoubleValue (NXOpen.Tag param_tag, int param_index, double value)
 Wrapper method for UF_PARAM_set_double_value More...
 
void SetDoubleVla (NXOpen.Tag param_tag, int param_index, int count, double[] dbl_array)
 Wrapper method for UF_PARAM_set_double_vla More...
 
void SetIntValue (NXOpen.Tag param_tag, int param_index, int value)
 Wrapper method for UF_PARAM_set_int_value More...
 
void SetIntVla (NXOpen.Tag param_tag, int param_index, int count, int[] int_array)
 Wrapper method for UF_PARAM_set_int_vla More...
 
void SetLogicalValue (NXOpen.Tag param_tag, int param_index, bool value)
 Wrapper method for UF_PARAM_set_logical_value More...
 
void SetStrValue (NXOpen.Tag param_tag, int param_index, string value)
 Wrapper method for UF_PARAM_set_str_value More...
 
void SetSubobjPtrValue (NXOpen.Tag param_tag, int param_index, IntPtr value)
 Wrapper method for UF_PARAM_set_subobj_ptr_value More...
 
void SetTagValue (NXOpen.Tag param_tag, int param_index, NXOpen.Tag value)
 Wrapper method for UF_PARAM_set_tag_value More...
 
void SetTagVla (NXOpen.Tag param_tag, int param_index, int count, NXOpen.Tag[] tag_array)
 Wrapper method for UF_PARAM_set_tag_vla 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_PARAM' functions and data types.

Member Enumeration Documentation

Wrapper for UF_PARAM_feed_unit_t

Refer to UF_PARAM_feed_unit_t for documentation
Mapping Help

Wrapper for UF_PARAM_regen_e

Refer to UF_PARAM_regen_e for documentation

Wrapper for UF_PARAM_status_e

Refer to UF_PARAM_status_e for documentation

Wrapper for UF_PARAM_type_e

Refer to UF_PARAM_type_e for documentation

Member Function Documentation

void NXOpen.UF.UFParam.AppendUde ( NXOpen.Tag  param,
UdeSetType  ude_set_type,
string  ude_name,
out IntPtr  ud_obj 
)
inline

Wrapper method for UF_PARAM_append_ude

Refer to UF_PARAM_append_ude for documentation

License requirements:None

void NXOpen.UF.UFParam.Ask2dValue ( NXOpen.Tag  param_tag,
int  param_index,
[Out] double[]  value 
)
inline

Wrapper method for UF_PARAM_ask_2d_value

Refer to UF_PARAM_ask_2d_value for documentation

License requirements:None

void NXOpen.UF.UFParam.Ask3dValue ( NXOpen.Tag  param_tag,
int  param_index,
[Out] double[]  value 
)
inline

Wrapper method for UF_PARAM_ask_3d_value

Refer to UF_PARAM_ask_3d_value for documentation

License requirements:None

void NXOpen.UF.UFParam.AskDoubleValue ( NXOpen.Tag  param_tag,
int  param_index,
out double  value 
)
inline

Wrapper method for UF_PARAM_ask_double_value

Refer to UF_PARAM_ask_double_value for documentation

License requirements:None

unsafe void NXOpen.UF.UFParam.AskDoubleVla ( NXOpen.Tag  param_tag,
int  param_index,
out int  count,
out double[]  dbl_array 
)
inline

Wrapper method for UF_PARAM_ask_double_vla

Refer to UF_PARAM_ask_double_vla for documentation

License requirements:None

void NXOpen.UF.UFParam.AskInheritedParams ( NXOpen.Tag  param_tag,
out int  count,
[Out] int[]  indices 
)
inline

Wrapper method for UF_PARAM_ask_inherited_params

Refer to UF_PARAM_ask_inherited_params for documentation

License requirements:None

void NXOpen.UF.UFParam.AskIntValue ( NXOpen.Tag  param_tag,
int  param_index,
out int  value 
)
inline

Wrapper method for UF_PARAM_ask_int_value

Refer to UF_PARAM_ask_int_value for documentation

License requirements:None

unsafe void NXOpen.UF.UFParam.AskIntVla ( NXOpen.Tag  param_tag,
int  param_index,
out int  count,
out int[]  int_array 
)
inline

Wrapper method for UF_PARAM_ask_int_vla

Refer to UF_PARAM_ask_int_vla for documentation

License requirements:None

void NXOpen.UF.UFParam.AskLogicalValue ( NXOpen.Tag  param_tag,
int  param_index,
out bool  value 
)
inline

Wrapper method for UF_PARAM_ask_logical_value

Refer to UF_PARAM_ask_logical_value for documentation

License requirements:None

unsafe void NXOpen.UF.UFParam.AskParamAttributes ( int  param_index,
out IndexAttribute  attributes 
)
inline

Wrapper method for UF_PARAM_ask_param_attributes

Refer to UF_PARAM_ask_param_attributes for documentation

License requirements:None

void NXOpen.UF.UFParam.AskParamDefiner ( NXOpen.Tag  param_tag,
int  param_index,
out NXOpen.Tag  definer_tag 
)
inline

Wrapper method for UF_PARAM_ask_param_definer

Refer to UF_PARAM_ask_param_definer for documentation

License requirements:None

void NXOpen.UF.UFParam.AskParamStatus ( NXOpen.Tag  param_tag,
int  param_index,
out Status  status 
)
inline

Wrapper method for UF_PARAM_ask_param_status

Refer to UF_PARAM_ask_param_status for documentation

License requirements:None

unsafe void NXOpen.UF.UFParam.AskRequiredParams ( NXOpen.Tag  param_tag,
out int  count,
out int[]  indices 
)
inline

Wrapper method for UF_PARAM_ask_required_params

Refer to UF_PARAM_ask_required_params for documentation

License requirements:None

unsafe void NXOpen.UF.UFParam.AskStrValue ( NXOpen.Tag  param_tag,
int  param_index,
out string  value 
)
inline

Wrapper method for UF_PARAM_ask_str_value

Refer to UF_PARAM_ask_str_value for documentation

License requirements:None

void NXOpen.UF.UFParam.AskSubobjPtrValue ( NXOpen.Tag  param_tag,
int  param_index,
IntPtr  value 
)
inline

Wrapper method for UF_PARAM_ask_subobj_ptr_value

Refer to UF_PARAM_ask_subobj_ptr_value for documentation

License requirements:None

void NXOpen.UF.UFParam.AskTagValue ( NXOpen.Tag  param_tag,
int  param_index,
out NXOpen.Tag  value 
)
inline

Wrapper method for UF_PARAM_ask_tag_value

Refer to UF_PARAM_ask_tag_value for documentation

License requirements:None

unsafe void NXOpen.UF.UFParam.AskTagVla ( NXOpen.Tag  param_tag,
int  param_index,
out int  count,
out NXOpen.Tag[]  tag_array 
)
inline

Wrapper method for UF_PARAM_ask_tag_vla

Refer to UF_PARAM_ask_tag_vla for documentation

License requirements:None

unsafe void NXOpen.UF.UFParam.AskUdes ( NXOpen.Tag  param,
UdeSetType  ude_set_type,
out int  num_of_udes,
out IntPtr[]  ude_objs 
)
inline

Wrapper method for UF_PARAM_ask_udes

Refer to UF_PARAM_ask_udes for documentation

License requirements:None

void NXOpen.UF.UFParam.CanAcceptUde ( NXOpen.Tag  param,
UdeSetType  ude_set_type,
string  ude_name,
out bool  response 
)
inline

Wrapper method for UF_PARAM_can_accept_ude

Refer to UF_PARAM_can_accept_ude for documentation

License requirements:None

void NXOpen.UF.UFParam.CanAcceptUdeSet ( NXOpen.Tag  param,
UdeSetType  ude_set_type,
out bool  response 
)
inline

Wrapper method for UF_PARAM_can_accept_ude_set

Refer to UF_PARAM_can_accept_ude_set for documentation

License requirements:None

void NXOpen.UF.UFParam.Check ( NXOpen.Tag  param,
out bool  is_ok 
)
inline

Wrapper method for UF_PARAM_check

Refer to UF_PARAM_check for documentation

License requirements:None

void NXOpen.UF.UFParam.DeleteAllUdes ( NXOpen.Tag  param,
UdeSetType  ude_set_type 
)
inline

Wrapper method for UF_PARAM_delete_all_udes

Refer to UF_PARAM_delete_all_udes for documentation

License requirements:None

void NXOpen.UF.UFParam.DeleteUde ( NXOpen.Tag  param,
UdeSetType  ude_set_type,
IntPtr  ude_obj 
)
inline

Wrapper method for UF_PARAM_delete_ude

Refer to UF_PARAM_delete_ude for documentation

License requirements:None

void NXOpen.UF.UFParam.Duplicate ( NXOpen.Tag  old_obj_tag,
string  name,
out NXOpen.Tag  new_obj_tag 
)
inline

Wrapper method for UF_PARAM_duplicate

Refer to UF_PARAM_duplicate for documentation

License requirements:None

void NXOpen.UF.UFParam.Generate ( NXOpen.Tag  param_tag,
out bool  generated 
)
inline

Wrapper method for UF_PARAM_generate

Refer to UF_PARAM_generate for documentation

License requirements:None

void NXOpen.UF.UFParam.InheritValue ( NXOpen.Tag  param_tag,
int  param_index 
)
inline

Wrapper method for UF_PARAM_inherit_value

Refer to UF_PARAM_inherit_value for documentation

License requirements:None

void NXOpen.UF.UFParam.IsInherited ( NXOpen.Tag  param_tag,
int  param_index,
out bool  answer 
)
inline

Wrapper method for UF_PARAM_is_inherited

Refer to UF_PARAM_is_inherited for documentation

License requirements:None

void NXOpen.UF.UFParam.IsLoadWithParent ( NXOpen.Tag  param,
out bool  response 
)
inline

Wrapper method for UF_PARAM_is_load_with_parent

Refer to UF_PARAM_is_load_with_parent for documentation

License requirements:None

void NXOpen.UF.UFParam.IsSameClass ( NXOpen.Tag  obj1_tag,
NXOpen.Tag  obj2_tag,
out bool  answer 
)
inline

Wrapper method for UF_PARAM_is_same_class

Refer to UF_PARAM_is_same_class for documentation

License requirements:None

void NXOpen.UF.UFParam.IsTemplate ( NXOpen.Tag  param,
out bool  response 
)
inline

Wrapper method for UF_PARAM_is_template

Refer to UF_PARAM_is_template for documentation

License requirements:None

void NXOpen.UF.UFParam.Reinit ( NXOpen.Tag  param_to_reinit,
NXOpen.Tag  param_to_reinit_from 
)
inline

Wrapper method for UF_PARAM_reinit

Refer to UF_PARAM_reinit for documentation

License requirements:None

void NXOpen.UF.UFParam.Rename ( NXOpen.Tag  param_tag,
string  new_name 
)
inline

Wrapper method for UF_PARAM_rename

Refer to UF_PARAM_rename for documentation

License requirements:None

void NXOpen.UF.UFParam.ReplayPath ( NXOpen.Tag  param_tag)
inline

Wrapper method for UF_PARAM_replay_path

Refer to UF_PARAM_replay_path for documentation

License requirements:None

void NXOpen.UF.UFParam.Set2dValue ( NXOpen.Tag  param_tag,
int  param_index,
double[]  value 
)
inline

Wrapper method for UF_PARAM_set_2d_value

Refer to UF_PARAM_set_2d_value for documentation

License requirements:None

void NXOpen.UF.UFParam.Set3dValue ( NXOpen.Tag  param_tag,
int  param_index,
double[]  value 
)
inline

Wrapper method for UF_PARAM_set_3d_value

Refer to UF_PARAM_set_3d_value for documentation

License requirements:None

void NXOpen.UF.UFParam.SetDoubleValue ( NXOpen.Tag  param_tag,
int  param_index,
double  value 
)
inline

Wrapper method for UF_PARAM_set_double_value

Refer to UF_PARAM_set_double_value for documentation

License requirements:None

void NXOpen.UF.UFParam.SetDoubleVla ( NXOpen.Tag  param_tag,
int  param_index,
int  count,
double[]  dbl_array 
)
inline

Wrapper method for UF_PARAM_set_double_vla

Refer to UF_PARAM_set_double_vla for documentation

License requirements:None

void NXOpen.UF.UFParam.SetIntValue ( NXOpen.Tag  param_tag,
int  param_index,
int  value 
)
inline

Wrapper method for UF_PARAM_set_int_value

Refer to UF_PARAM_set_int_value for documentation

License requirements:None

void NXOpen.UF.UFParam.SetIntVla ( NXOpen.Tag  param_tag,
int  param_index,
int  count,
int[]  int_array 
)
inline

Wrapper method for UF_PARAM_set_int_vla

Refer to UF_PARAM_set_int_vla for documentation

License requirements:None

void NXOpen.UF.UFParam.SetLogicalValue ( NXOpen.Tag  param_tag,
int  param_index,
bool  value 
)
inline

Wrapper method for UF_PARAM_set_logical_value

Refer to UF_PARAM_set_logical_value for documentation

License requirements:None

void NXOpen.UF.UFParam.SetStrValue ( NXOpen.Tag  param_tag,
int  param_index,
string  value 
)
inline

Wrapper method for UF_PARAM_set_str_value

Refer to UF_PARAM_set_str_value for documentation

License requirements:None

void NXOpen.UF.UFParam.SetSubobjPtrValue ( NXOpen.Tag  param_tag,
int  param_index,
IntPtr  value 
)
inline

Wrapper method for UF_PARAM_set_subobj_ptr_value

Refer to UF_PARAM_set_subobj_ptr_value for documentation

License requirements:None

void NXOpen.UF.UFParam.SetTagValue ( NXOpen.Tag  param_tag,
int  param_index,
NXOpen.Tag  value 
)
inline

Wrapper method for UF_PARAM_set_tag_value

Refer to UF_PARAM_set_tag_value for documentation

License requirements:None

void NXOpen.UF.UFParam.SetTagVla ( NXOpen.Tag  param_tag,
int  param_index,
int  count,
NXOpen.Tag[]  tag_array 
)
inline

Wrapper method for UF_PARAM_set_tag_vla

Refer to UF_PARAM_set_tag_vla 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.