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

Represents a NXOpen.Mechatronics.RuntimeNCBuilder . More...

Inheritance diagram for NXOpen.Mechatronics.RuntimeNCBuilder:
NXOpen.Builder NXOpen.TaggedObject NXOpen.GeometricUtilities.IComponentBuilder NXOpen.Utilities.NXRemotableObject IMessageSink

Public Member Functions

unsafe void ExportNCCode (string ncFile)
 This method is used to export current loaded NC Code to disk file. More...
 
unsafe void GetAxesAndMachineEvents (out string[] axisNames, out string[] machineEventNames)
 This method is used to get the axes that involved the motion of CSE output event, and the machine event (e. More...
 
unsafe NXOpen.TaggedObject GetMCDConnection (bool isAxis, string axisOrEventName)
 This method is used to get the MCD connected object to the specified axis or machine event More...
 
unsafe void LoadNCFile (string ncFile)
 This method is used to load NC file. More...
 
unsafe void RunCSE (out bool isRunningOK, out string errMsg, out int lineNum, out string ncLine)
 This method is used to run NC Code via CSE in order to get output events More...
 
unsafe void SetMCDConnection (bool isAxis, string axisOrEventName, NXOpen.TaggedObject mcdConnectedTag)
 This method is used to set the MCD connected object to the specified axis or machine event More...
 
unsafe void UpdateNCCode (string[] ncCodeLines)
 This method is used to update NC code. 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 bool FlagOfUsingContainer [get, set]
 Returns or sets the flag which indicates whether to put the MCD connected objects to the specific 'Runtime NC' container or not. More...
 
unsafe bool FlagOfUsingSpecifiedMCF [get, set]
 Returns or sets the flag which indicates whether use the specified MCF or not. More...
 
unsafe string Name [get, set]
 Returns or sets the name. More...
 
unsafe string SpecifiedMCF [get, set]
 Returns or sets the user specified MCF File. More...
 
- Properties inherited from NXOpen.Builder
unsafe NXOpen.PreviewBuilder PreviewBuilder [get]
 Returns the preview builder subobject. More...
 
- Properties inherited from NXOpen.TaggedObject
Tag Tag [get]
 Returns the tag of this object. More...
 
- Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink NextSink [get]
 Gets the next message sink in the sink chain. More...
 

Additional Inherited Members

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

Detailed Description

Represents a NXOpen.Mechatronics.RuntimeNCBuilder .

To create a new instance of this class, use NXOpen.Mechatronics.RuntimeNCCollection.CreateRuntimeNcBuilder

Created in NX9.0.0

Member Function Documentation

unsafe void NXOpen.Mechatronics.RuntimeNCBuilder.ExportNCCode ( string  ncFile)
inline

This method is used to export current loaded NC Code to disk file.

Created in NX9.0.0

License requirements: nx_mcd_core ("Mechatronics Concept Designer")

Parameters
ncFile
unsafe void NXOpen.Mechatronics.RuntimeNCBuilder.GetAxesAndMachineEvents ( out string[]  axisNames,
out string[]  machineEventNames 
)
inline

This method is used to get the axes that involved the motion of CSE output event, and the machine event (e.

g. ToolChange) that fired by CSE. These axes and machine events are used to connect with MCD objects, so in the MCD simulation stage, the CSE will know which MCD runtime object will be driven.

Created in NX9.0.0

License requirements: nx_mcd_core ("Mechatronics Concept Designer")

Parameters
axisNamesThe axis names which involved in CSE motion.
machineEventNamesThe name of events fired by CSE.
unsafe NXOpen.TaggedObject NXOpen.Mechatronics.RuntimeNCBuilder.GetMCDConnection ( bool  isAxis,
string  axisOrEventName 
)
inline

This method is used to get the MCD connected object to the specified axis or machine event

Created in NX9.0.0

License requirements: nx_mcd_core ("Mechatronics Concept Designer")

Parameters
isAxisFlag indicates whether the MCD object is set to connect with axis or machine event.
axisOrEventNameAxis or machine event name.
Returns
MCD connected object. The object type can be Mechatronics.PositionControl for the motion axis; or Mechatronics.SpeedControl for the spinde axis; or Mechatronics.GanttOperationObject for the machine event.
unsafe void NXOpen.Mechatronics.RuntimeNCBuilder.LoadNCFile ( string  ncFile)
inline

This method is used to load NC file.

Created in NX9.0.0

License requirements: nx_mcd_core ("Mechatronics Concept Designer")

Parameters
ncFile
unsafe void NXOpen.Mechatronics.RuntimeNCBuilder.RunCSE ( out bool  isRunningOK,
out string  errMsg,
out int  lineNum,
out string  ncLine 
)
inline

This method is used to run NC Code via CSE in order to get output events

Created in NX9.0.0

License requirements: nx_mcd_core ("Mechatronics Concept Designer")

Parameters
isRunningOKTrue means CSE returns succeed result, or failure.
errMsgError message if CSE return false.
lineNumThe NC line number at which CSE failed.
ncLineThe NC Code for which CSE failed.
unsafe void NXOpen.Mechatronics.RuntimeNCBuilder.SetMCDConnection ( bool  isAxis,
string  axisOrEventName,
NXOpen.TaggedObject  mcdConnectedTag 
)
inline

This method is used to set the MCD connected object to the specified axis or machine event

Created in NX9.0.0

License requirements: nx_mcd_core ("Mechatronics Concept Designer")

Parameters
isAxisFlag indicates whether the MCD object is set to connect with axis or machine event.
axisOrEventNameAxis or machine event name.
mcdConnectedTagMCD connected object. The object type can be Mechatronics.PositionControl for the motion axis; or Mechatronics.SpeedControl for the spinde axis; or Mechatronics.GanttOperationObject for the machine event.
unsafe void NXOpen.Mechatronics.RuntimeNCBuilder.UpdateNCCode ( string[]  ncCodeLines)
inline

This method is used to update NC code.

Created in NX9.0.0

License requirements: nx_mcd_core ("Mechatronics Concept Designer")

Parameters
ncCodeLines

Property Documentation

unsafe bool NXOpen.Mechatronics.RuntimeNCBuilder.FlagOfUsingContainer
getset

Returns or sets the flag which indicates whether to put the MCD connected objects to the specific 'Runtime NC' container or not.

true means put the MCD connected objects to the specific container (creates the container if it is not exist); false means restore the MCD connected objects to the original default folder, and remove the 'Runtime NC' container.

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: nx_mcd_core ("Mechatronics Concept Designer")

unsafe bool NXOpen.Mechatronics.RuntimeNCBuilder.FlagOfUsingSpecifiedMCF
getset

Returns or sets the flag which indicates whether use the specified MCF or not.

True means use user specified MCF file for running CSE, or use the Standard MCF file in MCD kits.

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: nx_mcd_core ("Mechatronics Concept Designer")

unsafe string NXOpen.Mechatronics.RuntimeNCBuilder.Name
getset

Returns or sets the name.

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: nx_mcd_core ("Mechatronics Concept Designer")

unsafe string NXOpen.Mechatronics.RuntimeNCBuilder.SpecifiedMCF
getset

Returns or sets the user specified MCF File.

Created in NX9.0.0

License requirements to get this property: None.

License requirements to set this property: nx_mcd_core ("Mechatronics Concept Designer")


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