NXOpen C++ Reference Guide
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
Public Types | Public Member Functions | List of all members
NXOpen::SIM::PostConfigurator::UdeBuilder Class Reference

This class is used to create a new event. More...

Inheritance diagram for NXOpen::SIM::PostConfigurator::UdeBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  EventDescriptionType { EventDescriptionTypeNone, EventDescriptionTypeSpecify }
 Type of Event Description. More...
 

Public Member Functions

void AddItem (NXOpen::SIM::PostConfigurator::UdeParameterBuilder *itemBuilder)
 Adds item to item used list
Created in NX12.0.1. More...
 
void DeleteItem (NXOpen::SIM::PostConfigurator::UdeParameterBuilder *itemBuilder)
 Deletes parameter from ude list
Created in NX12.0.1. More...
 
void DeleteItems ()
 Deletes all parameters from ude list
Created in NX12.0.1. More...
 
bool EventCategoryDrilling ()
 Returns the event category drilling
Created in NX12.0.1. More...
 
bool EventCategoryMilling ()
 Returns the event category milling
Created in NX12.0.1. More...
 
bool EventCategoryTurning ()
 Returns the event category turning
Created in NX12.0.1. More...
 
bool EventCategoryWireEDM ()
 Returns the event category wire EDM
Created in NX12.0.1. More...
 
NXOpen::SIM::PostConfigurator::UdeBuilder::EventDescriptionType EventDescription ()
 Returns the event description type
Created in NX12.0.1. More...
 
NXString EventHelpDescription ()
 Returns the event description
Created in NX12.0.1. More...
 
NXString EventHelpLocation ()
 Returns the event url location
Created in NX12.0.1. More...
 
NXString EventID ()
 Returns the event ID
Created in NX12.0.1. More...
 
NXString EventName ()
 Returns the event name
Created in NX12.0.1. More...
 
NXOpen::SIM::PostConfigurator::UdeParameterBuilderGetUdeParameterBuilder (const NXString &parameterID)
 Returns the ude parameter builder by parameter ID. More...
 
NXOpen::SIM::PostConfigurator::UdeParameterBuilderGetUdeParameterBuilder (const char *parameterID)
 Returns the ude parameter builder by parameter ID. More...
 
NXString PostEvent ()
 Returns the post event
Created in NX12.0.1. More...
 
void RenameParameterID (NXOpen::SIM::PostConfigurator::UdeParameterBuilder *itemBuilder, const NXString &oldParameterID, const NXString &newParameterID)
 Renames the parameter ID
Created in NX12.0.1. More...
 
void RenameParameterID (NXOpen::SIM::PostConfigurator::UdeParameterBuilder *itemBuilder, const char *oldParameterID, const char *newParameterID)
 Renames the parameter ID
Created in NX12.0.1. More...
 
void SetEventCategoryDrilling (bool categoryDrilling)
 Sets the event category drilling
Created in NX12.0.1. More...
 
void SetEventCategoryMilling (bool categoryMilling)
 Sets the event category milling
Created in NX12.0.1. More...
 
void SetEventCategoryTurning (bool categoryTurning)
 Sets the event category turning
Created in NX12.0.1. More...
 
void SetEventCategoryWireEDM (bool categoryWireEDM)
 Sets the event category wire EDM
Created in NX12.0.1. More...
 
void SetEventDescription (NXOpen::SIM::PostConfigurator::UdeBuilder::EventDescriptionType eventDescription)
 Sets the event description type
Created in NX12.0.1. More...
 
void SetEventHelpDescription (const NXString &helpDescription)
 Sets the event description
Created in NX12.0.1. More...
 
void SetEventHelpDescription (const char *helpDescription)
 Sets the event description
Created in NX12.0.1. More...
 
void SetEventHelpLocation (const NXString &helpLocation)
 Sets the event url location
Created in NX12.0.1. More...
 
void SetEventHelpLocation (const char *helpLocation)
 Sets the event url location
Created in NX12.0.1. More...
 
void SetEventID (const NXString &stringEventID)
 Sets the event ID
Created in NX12.0.1. More...
 
void SetEventID (const char *stringEventID)
 Sets the event ID
Created in NX12.0.1. More...
 
void SetEventName (const NXString &name)
 Sets the event name
Created in NX12.0.1. More...
 
void SetEventName (const char *name)
 Sets the event name
Created in NX12.0.1. More...
 
void SetPostEvent (const NXString &postEventID)
 Sets the post event
Created in NX12.0.1. More...
 
void SetPostEvent (const char *postEventID)
 Sets the post event
Created in NX12.0.1. More...
 
NXOpen::SIM::PostConfigurator::UdeParameterBuilderListUdeParameterList ()
 Returns the ude parameter list
Created in NX12.0.1. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 Commits any edits that have been applied to the builder. More...
 
void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
std::vector< NXOpen::NXObject * > GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
NXOpen::NXObjectGetObject ()
 Returns the object currently being edited by this builder. More...
 
void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

This class is used to create a new event.

Calling Builder::Commit on this builder will only return NULL.
To create a new instance of this class, use NXOpen::SIM::PostConfigurator::PostConfiguratorManager::CreateUdeBuilder

Created in NX12.0.1.

Member Enumeration Documentation

Type of Event Description.

Enumerator
EventDescriptionTypeNone 

None.

EventDescriptionTypeSpecify 

Specify.

Member Function Documentation

void NXOpen::SIM::PostConfigurator::UdeBuilder::AddItem ( NXOpen::SIM::PostConfigurator::UdeParameterBuilder itemBuilder)

Adds item to item used list
Created in NX12.0.1.



License requirements : nx_post_config_full ("NX Post Configurator") OR nx_post_config_adv ("NX Post Configurator")

Parameters
itemBuilderitembuilder
void NXOpen::SIM::PostConfigurator::UdeBuilder::DeleteItem ( NXOpen::SIM::PostConfigurator::UdeParameterBuilder itemBuilder)

Deletes parameter from ude list
Created in NX12.0.1.



License requirements : nx_post_config_full ("NX Post Configurator") OR nx_post_config_adv ("NX Post Configurator")

Parameters
itemBuilderitembuilder
void NXOpen::SIM::PostConfigurator::UdeBuilder::DeleteItems ( )

Deletes all parameters from ude list
Created in NX12.0.1.



License requirements : nx_post_config_full ("NX Post Configurator") OR nx_post_config_adv ("NX Post Configurator")

bool NXOpen::SIM::PostConfigurator::UdeBuilder::EventCategoryDrilling ( )

Returns the event category drilling
Created in NX12.0.1.



License requirements : None

bool NXOpen::SIM::PostConfigurator::UdeBuilder::EventCategoryMilling ( )

Returns the event category milling
Created in NX12.0.1.



License requirements : None

bool NXOpen::SIM::PostConfigurator::UdeBuilder::EventCategoryTurning ( )

Returns the event category turning
Created in NX12.0.1.



License requirements : None

bool NXOpen::SIM::PostConfigurator::UdeBuilder::EventCategoryWireEDM ( )

Returns the event category wire EDM
Created in NX12.0.1.



License requirements : None

NXOpen::SIM::PostConfigurator::UdeBuilder::EventDescriptionType NXOpen::SIM::PostConfigurator::UdeBuilder::EventDescription ( )

Returns the event description type
Created in NX12.0.1.



License requirements : None

NXString NXOpen::SIM::PostConfigurator::UdeBuilder::EventHelpDescription ( )

Returns the event description
Created in NX12.0.1.



License requirements : None

NXString NXOpen::SIM::PostConfigurator::UdeBuilder::EventHelpLocation ( )

Returns the event url location
Created in NX12.0.1.



License requirements : None

NXString NXOpen::SIM::PostConfigurator::UdeBuilder::EventID ( )

Returns the event ID
Created in NX12.0.1.



License requirements : None

NXString NXOpen::SIM::PostConfigurator::UdeBuilder::EventName ( )

Returns the event name
Created in NX12.0.1.



License requirements : None

NXOpen::SIM::PostConfigurator::UdeParameterBuilder* NXOpen::SIM::PostConfigurator::UdeBuilder::GetUdeParameterBuilder ( const NXString parameterID)

Returns the ude parameter builder by parameter ID.

Returns
the ude parameter builder
Created in NX12.0.1.

License requirements : None
Parameters
parameterIDparameterid
NXOpen::SIM::PostConfigurator::UdeParameterBuilder* NXOpen::SIM::PostConfigurator::UdeBuilder::GetUdeParameterBuilder ( const char *  parameterID)

Returns the ude parameter builder by parameter ID.

Returns
the ude parameter builder
Created in NX12.0.1.

License requirements : None
Parameters
parameterIDparameterid
NXString NXOpen::SIM::PostConfigurator::UdeBuilder::PostEvent ( )

Returns the post event
Created in NX12.0.1.



License requirements : None

void NXOpen::SIM::PostConfigurator::UdeBuilder::RenameParameterID ( NXOpen::SIM::PostConfigurator::UdeParameterBuilder itemBuilder,
const NXString oldParameterID,
const NXString newParameterID 
)

Renames the parameter ID
Created in NX12.0.1.



License requirements : nx_post_config_full ("NX Post Configurator") OR nx_post_config_adv ("NX Post Configurator")

Parameters
itemBuilderitembuilder
oldParameterIDoldparameterid
newParameterIDnewparameterid
void NXOpen::SIM::PostConfigurator::UdeBuilder::RenameParameterID ( NXOpen::SIM::PostConfigurator::UdeParameterBuilder itemBuilder,
const char *  oldParameterID,
const char *  newParameterID 
)

Renames the parameter ID
Created in NX12.0.1.



License requirements : nx_post_config_full ("NX Post Configurator") OR nx_post_config_adv ("NX Post Configurator")

Parameters
itemBuilderitembuilder
oldParameterIDoldparameterid
newParameterIDnewparameterid
void NXOpen::SIM::PostConfigurator::UdeBuilder::SetEventCategoryDrilling ( bool  categoryDrilling)

Sets the event category drilling
Created in NX12.0.1.



License requirements : nx_post_config_full ("NX Post Configurator") OR nx_post_config_adv ("NX Post Configurator")

Parameters
categoryDrillingcategorydrilling
void NXOpen::SIM::PostConfigurator::UdeBuilder::SetEventCategoryMilling ( bool  categoryMilling)

Sets the event category milling
Created in NX12.0.1.



License requirements : nx_post_config_full ("NX Post Configurator") OR nx_post_config_adv ("NX Post Configurator")

Parameters
categoryMillingcategorymilling
void NXOpen::SIM::PostConfigurator::UdeBuilder::SetEventCategoryTurning ( bool  categoryTurning)

Sets the event category turning
Created in NX12.0.1.



License requirements : nx_post_config_full ("NX Post Configurator") OR nx_post_config_adv ("NX Post Configurator")

Parameters
categoryTurningcategoryturning
void NXOpen::SIM::PostConfigurator::UdeBuilder::SetEventCategoryWireEDM ( bool  categoryWireEDM)

Sets the event category wire EDM
Created in NX12.0.1.



License requirements : nx_post_config_full ("NX Post Configurator") OR nx_post_config_adv ("NX Post Configurator")

Parameters
categoryWireEDMcategorywireedm
void NXOpen::SIM::PostConfigurator::UdeBuilder::SetEventDescription ( NXOpen::SIM::PostConfigurator::UdeBuilder::EventDescriptionType  eventDescription)

Sets the event description type
Created in NX12.0.1.



License requirements : nx_post_config_full ("NX Post Configurator") OR nx_post_config_adv ("NX Post Configurator")

Parameters
eventDescriptioneventdescription
void NXOpen::SIM::PostConfigurator::UdeBuilder::SetEventHelpDescription ( const NXString helpDescription)

Sets the event description
Created in NX12.0.1.



License requirements : nx_post_config_full ("NX Post Configurator") OR nx_post_config_adv ("NX Post Configurator")

Parameters
helpDescriptionhelpdescription
void NXOpen::SIM::PostConfigurator::UdeBuilder::SetEventHelpDescription ( const char *  helpDescription)

Sets the event description
Created in NX12.0.1.



License requirements : nx_post_config_full ("NX Post Configurator") OR nx_post_config_adv ("NX Post Configurator")

Parameters
helpDescriptionhelpdescription
void NXOpen::SIM::PostConfigurator::UdeBuilder::SetEventHelpLocation ( const NXString helpLocation)

Sets the event url location
Created in NX12.0.1.



License requirements : nx_post_config_full ("NX Post Configurator") OR nx_post_config_adv ("NX Post Configurator")

Parameters
helpLocationhelplocation
void NXOpen::SIM::PostConfigurator::UdeBuilder::SetEventHelpLocation ( const char *  helpLocation)

Sets the event url location
Created in NX12.0.1.



License requirements : nx_post_config_full ("NX Post Configurator") OR nx_post_config_adv ("NX Post Configurator")

Parameters
helpLocationhelplocation
void NXOpen::SIM::PostConfigurator::UdeBuilder::SetEventID ( const NXString stringEventID)

Sets the event ID
Created in NX12.0.1.



License requirements : nx_post_config_full ("NX Post Configurator") OR nx_post_config_adv ("NX Post Configurator")

Parameters
stringEventIDstringeventid
void NXOpen::SIM::PostConfigurator::UdeBuilder::SetEventID ( const char *  stringEventID)

Sets the event ID
Created in NX12.0.1.



License requirements : nx_post_config_full ("NX Post Configurator") OR nx_post_config_adv ("NX Post Configurator")

Parameters
stringEventIDstringeventid
void NXOpen::SIM::PostConfigurator::UdeBuilder::SetEventName ( const NXString name)

Sets the event name
Created in NX12.0.1.



License requirements : nx_post_config_full ("NX Post Configurator") OR nx_post_config_adv ("NX Post Configurator")

Parameters
namename
void NXOpen::SIM::PostConfigurator::UdeBuilder::SetEventName ( const char *  name)

Sets the event name
Created in NX12.0.1.



License requirements : nx_post_config_full ("NX Post Configurator") OR nx_post_config_adv ("NX Post Configurator")

Parameters
namename
void NXOpen::SIM::PostConfigurator::UdeBuilder::SetPostEvent ( const NXString postEventID)

Sets the post event
Created in NX12.0.1.



License requirements : nx_post_config_full ("NX Post Configurator") OR nx_post_config_adv ("NX Post Configurator")

Parameters
postEventIDposteventid
void NXOpen::SIM::PostConfigurator::UdeBuilder::SetPostEvent ( const char *  postEventID)

Sets the post event
Created in NX12.0.1.



License requirements : nx_post_config_full ("NX Post Configurator") OR nx_post_config_adv ("NX Post Configurator")

Parameters
postEventIDposteventid
NXOpen::SIM::PostConfigurator::UdeParameterBuilderList* NXOpen::SIM::PostConfigurator::UdeBuilder::UdeParameterList ( )

Returns the ude parameter list
Created in NX12.0.1.



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.