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

Represents a NXOpen.SIM.SimDebugBuilder More...

Inheritance diagram for NXOpen.SIM.SimDebugBuilder:
NXOpen.Builder NXOpen.TaggedObject NXOpen.GeometricUtilities.IComponentBuilder NXOpen.Utilities.NXRemotableObject IMessageSink

Public Types

enum  DriverType { Cse, Mtd }
 Represents the driver type More...
 
enum  DumpType {
  None, KinematicModel, Highlighting, Ipw,
  Collision, OutputBuffer, Time, Details,
  SynchronizeUi, SynchronizeManagerXtp, EngineParams, MomVariables,
  DebugUi, SimulationSettings, SimManager, PathEvents,
  MachiningTimeAnalysis
}
 Represents the dump type More...
 
enum  KinematicModelType { Main, Simulation, Driver }
 Represents the kinematic model type More...
 
enum  OutputType { Syslog, ListingWindow, Autotest, ToFile }
 The output type More...
 
enum  PrintoutTagsOrPointersType { Boolean, Value, Name }
 Represents the printout tags or pointers type More...
 
enum  TraceType {
  ButtonDown, Vcr, Ipw, Performance,
  Collision, Gouge, Highlighting, Details,
  PositionalIsv, SpinningNonSpinning, KinematicModel, Event,
  LineServer, Sync, ToolPathPicking, CseMotionData,
  CseCallStack, CseToolEvents, CseCheckSyntax
}
 Represents the trace type More...
 
enum  UiType {
  DisplayMomEvent, ShowPartAndTipJunctions, GenerateSpinningTools, UseHybridGougeChecker,
  UseMtbOldDialogs, UseFastTicker, PrintOutTraceSerialNumbers, PerformanceDisplayDetail,
  PerformanceDisplayTime, PerformanceIndentTime, PerformanceDisplayData, DctkWriteCollisionPairs
}
 Represents the ui type More...
 

Public Member Functions

unsafe bool GetTrace (NXOpen.SIM.SimDebugBuilder.TraceType type)
 Gets the trace More...
 
unsafe bool GetUiSetting (NXOpen.SIM.SimDebugBuilder.UiType type)
 Gets the debug setting More...
 
unsafe void SetTrace (NXOpen.SIM.SimDebugBuilder.TraceType type, bool state)
 Sets the trace More...
 
unsafe void SetUiSetting (NXOpen.SIM.SimDebugBuilder.UiType type, bool state)
 Sets the debug setting More...
 
unsafe void ShowKinematicModelState ()
 Show the kinematic model state More...
 
- Public Member Functions inherited from NXOpen.Builder
unsafe NXOpen.NXObject Commit ()
 Commits any edits that have been applied to the builder. More...
 
unsafe void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
unsafe NXOpen.NXObject[] GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
unsafe NXOpen.NXObject GetObject ()
 Returns the object currently being edited by this builder. More...
 
unsafe void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
unsafe bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen.TaggedObject
void PrintTestData (String variableName)
 <exclude> More...
 
void PrintTestData (String variableName, int lineNumber)
 <exclude> More...
 
override string ToString ()
 Returns a String that represents the current Object. 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...
 

Properties

unsafe
NXOpen.SIM.SimDebugBuilder.DriverType 
Driver [get, set]
 Returns or sets the driver More...
 
unsafe
NXOpen.SIM.SimDebugBuilder.DumpType 
Dump [get, set]
 Returns or sets the dump More...
 
unsafe
NXOpen.SIM.SimDebugBuilder.OutputType 
DumpOutput [get, set]
 Returns or sets the dump output More...
 
unsafe string DumpToFileName [get, set]
 Returns or sets the output filename More...
 
unsafe
NXOpen.SIM.SimDebugBuilder.KinematicModelType 
KinematicModel [get, set]
 Returns or sets the kinematic model More...
 
unsafe
NXOpen.SIM.SimDebugBuilder.PrintoutTagsOrPointersType 
PrintoutTags [get, set]
 Returns or sets the printout tags type More...
 

Additional Inherited Members

- Protected Member Functions inherited from NXOpen.TaggedObject
new void initialize ()
 <exclude> More...
 

Detailed Description

Represents a NXOpen.SIM.SimDebugBuilder

To create a new instance of this class, use NXOpen.SIM.KinematicConfigurator.CreateSimDebugBuilder

Created in NX8.0.0

Member Enumeration Documentation

Represents the driver type

Enumerator
Cse 

CSE driver

Mtd 

MTD driver

Represents the dump type

Enumerator
None 

Dump Nothing

KinematicModel 

Dump Kinematic Model

Highlighting 

Dump Highlighting

Ipw 

Dump IPW

Collision 

Dump Collision

OutputBuffer 

Dump Output Buffer

Time 

Dump Time

Details 

Dump Details

SynchronizeUi 

Dump Synchronize UI

SynchronizeManagerXtp 

Dump SynchronizeManagerXtp

EngineParams 

Dump Engine Params

MomVariables 

Dump Mom Variables

DebugUi 

Dump Debug UI

SimulationSettings 

Dump Simulation Settings

SimManager 

Dump SimManager

PathEvents 

Dump Path Events

MachiningTimeAnalysis 

Dump Machining Time Analysis

Represents the kinematic model type

Enumerator
Main 

Main Kinematic Model

Simulation 

Simulation Kinematic Model

Driver 

Driver Kinematic Model

The output type

Enumerator
Syslog 

Output to syslog

ListingWindow 

Output to listing window

Autotest 

Output to autotest

ToFile 

Output to file

Represents the printout tags or pointers type

Enumerator
Boolean 

Boolean

Value 

Value

Name 

Name

Represents the trace type

Enumerator
ButtonDown 

Trace Button Down

Vcr 

Trace Vcr

Ipw 

Trace Ipw

Performance 

Trace Performance

Collision 

Trace Collision

Gouge 

Trace Gouge

Highlighting 

Trace Highlighting

Details 

Trace Details

PositionalIsv 

Trace Positional Isv

SpinningNonSpinning 

Trace Spinning Nonspinning

KinematicModel 

Trace Kinematic Model

Event 

Trace Event

LineServer 

Trace Line Server

Sync 

Trace Sync

ToolPathPicking 

Trace ToolPath Picking

CseMotionData 

Trace Cse Motions

CseCallStack 

Trace Cse Programs

CseToolEvents 

Trace Cse Tool Events

CseCheckSyntax 

Trace Check Syntax

Represents the ui type

Enumerator
DisplayMomEvent 

Display Mom Event

ShowPartAndTipJunctions 

Show Part And Tip Junction

GenerateSpinningTools 

Generate Spinning Tools

UseHybridGougeChecker 

Use Hybrid Gouge Checker

UseMtbOldDialogs 

Use MTB Old Dialogs

UseFastTicker 

Use Fast Ticker

PrintOutTraceSerialNumbers 

Print Out Trace Serial Numbers

PerformanceDisplayDetail 

Performance Display Detail

PerformanceDisplayTime 

Performance Display Time

PerformanceIndentTime 

Performance Indent Time

PerformanceDisplayData 

Performance Display Data

DctkWriteCollisionPairs 

Write Collision Pairs

Member Function Documentation

unsafe bool NXOpen.SIM.SimDebugBuilder.GetTrace ( NXOpen.SIM.SimDebugBuilder.TraceType  type)
inline

Gets the trace

Created in NX8.0.0

License requirements: None.

Parameters
typeThe trace type
Returns
The state
unsafe bool NXOpen.SIM.SimDebugBuilder.GetUiSetting ( NXOpen.SIM.SimDebugBuilder.UiType  type)
inline

Gets the debug setting

Created in NX8.0.0

License requirements: None.

Parameters
typeThe ui type
Returns
The state
unsafe void NXOpen.SIM.SimDebugBuilder.SetTrace ( NXOpen.SIM.SimDebugBuilder.TraceType  type,
bool  state 
)
inline

Sets the trace

Created in NX8.0.0

License requirements: ug_isv_full ("Full functionality for Integrated Simulation and Verification")

Parameters
typeThe trace type
stateThe state
unsafe void NXOpen.SIM.SimDebugBuilder.SetUiSetting ( NXOpen.SIM.SimDebugBuilder.UiType  type,
bool  state 
)
inline

Sets the debug setting

Created in NX8.0.0

License requirements: ug_isv_full ("Full functionality for Integrated Simulation and Verification")

Parameters
typeThe ui type
stateThe state
unsafe void NXOpen.SIM.SimDebugBuilder.ShowKinematicModelState ( )
inline

Show the kinematic model state

Created in NX8.0.0

License requirements: ug_isv_full ("Full functionality for Integrated Simulation and Verification")

Property Documentation

unsafe NXOpen.SIM.SimDebugBuilder.DriverType NXOpen.SIM.SimDebugBuilder.Driver
getset

Returns or sets the driver

Created in NX8.0.0

License requirements to get this property: None.

License requirements to set this property: ug_isv_full ("Full functionality for Integrated Simulation and Verification")

unsafe NXOpen.SIM.SimDebugBuilder.DumpType NXOpen.SIM.SimDebugBuilder.Dump
getset

Returns or sets the dump

Created in NX8.0.0

License requirements to get this property: None.

License requirements to set this property: ug_isv_full ("Full functionality for Integrated Simulation and Verification")

unsafe NXOpen.SIM.SimDebugBuilder.OutputType NXOpen.SIM.SimDebugBuilder.DumpOutput
getset

Returns or sets the dump output

Created in NX8.0.0

License requirements to get this property: None.

License requirements to set this property: ug_isv_full ("Full functionality for Integrated Simulation and Verification")

unsafe string NXOpen.SIM.SimDebugBuilder.DumpToFileName
getset

Returns or sets the output filename

Created in NX8.0.0

License requirements to get this property: ug_isv_full ("Full functionality for Integrated Simulation and Verification")

License requirements to set this property: ug_isv_full ("Full functionality for Integrated Simulation and Verification")

unsafe NXOpen.SIM.SimDebugBuilder.KinematicModelType NXOpen.SIM.SimDebugBuilder.KinematicModel
getset

Returns or sets the kinematic model

Created in NX8.0.0

License requirements to get this property: None.

License requirements to set this property: ug_isv_full ("Full functionality for Integrated Simulation and Verification")

unsafe NXOpen.SIM.SimDebugBuilder.PrintoutTagsOrPointersType NXOpen.SIM.SimDebugBuilder.PrintoutTags
getset

Returns or sets the printout tags type

Created in NX8.5.0

License requirements to get this property: None.

License requirements to set this property: ug_isv_full ("Full functionality for Integrated Simulation and Verification")


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