NX Open C++ Reference Guide
Public Member Functions | List of all members
NXOpen::CAM::Ude Class Reference

Represets a User Defined Event
To create a new instance of this class, use NXOpen::CAM::UdeSet::CreateUde

Created in NX7.0.0. More...

Inheritance diagram for NXOpen::CAM::Ude:
NXOpen::TaggedObject

Public Member Functions

NXOpen::CAM::UdeParameterGetParameter (const NXString &parameterName)
 Get the parameter for the specified parameter name. More...
 
NXOpen::CAM::UdeParameterGetParameter (const char *parameterName)
 Get the parameter for the specified parameter name. More...
 
NXOpen::CAM::UdeParameterGetParameter (int index)
 Get the parameter for the specified index. More...
 
std::vector< NXStringGetParameterNames ()
 Returns the parameter names. More...
 
int NumberOfParameters ()
 Returns the number of parameters
Created in NX7.5.0. More...
 
bool OutputLoadTool ()
 Returns the output load tool
Created in NX7.5.0. More...
 
void SetOutputLoadTool (bool loadTool)
 Sets the output load tool
Created in NX7.5.0. More...
 
void SetUdeName (const NXString &udeName)
 Sets the ude name
Created in NX7.5.0. More...
 
void SetUdeName (const char *udeName)
 Sets the ude name
Created in NX7.5.0. More...
 
NXString UdeName ()
 Returns the ude name
Created in NX7.5.0. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Represets a User Defined Event
To create a new instance of this class, use NXOpen::CAM::UdeSet::CreateUde

Created in NX7.0.0.


Member Function Documentation

NXOpen::CAM::UdeParameter* NXOpen::CAM::Ude::GetParameter ( const NXString parameterName)

Get the parameter for the specified parameter name.

Returns
the parameter
Created in NX7.5.0.

License requirements : None
Parameters
parameterNamethe parameter name
NXOpen::CAM::UdeParameter* NXOpen::CAM::Ude::GetParameter ( const char *  parameterName)

Get the parameter for the specified parameter name.

Returns
the parameter
Created in NX7.5.0.

License requirements : None
Parameters
parameterNamethe parameter name
NXOpen::CAM::UdeParameter* NXOpen::CAM::Ude::GetParameter ( int  index)

Get the parameter for the specified index.

Returns
the parameter
Created in NX8.0.0.

License requirements : None
Parameters
indexthe parameter index
std::vector<NXString> NXOpen::CAM::Ude::GetParameterNames ( )

Returns the parameter names.

Returns
the names of ude parameters
Created in NX9.0.1.

License requirements : None
int NXOpen::CAM::Ude::NumberOfParameters ( )

Returns the number of parameters
Created in NX7.5.0.



License requirements : None

bool NXOpen::CAM::Ude::OutputLoadTool ( )

Returns the output load tool
Created in NX7.5.0.



License requirements : None

void NXOpen::CAM::Ude::SetOutputLoadTool ( bool  loadTool)

Sets the output load tool
Created in NX7.5.0.



License requirements : None

Parameters
loadTooloutput load tool
void NXOpen::CAM::Ude::SetUdeName ( const NXString udeName)

Sets the ude name
Created in NX7.5.0.



License requirements : cam_base ("CAM BASE")

Parameters
udeNamethe name of the Ude
void NXOpen::CAM::Ude::SetUdeName ( const char *  udeName)

Sets the ude name
Created in NX7.5.0.



License requirements : cam_base ("CAM BASE")

Parameters
udeNamethe name of the Ude
NXString NXOpen::CAM::Ude::UdeName ( )

Returns the ude name
Created in NX7.5.0.



License requirements : None


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