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

This class is used for add kinematic channel to the channel configuratation list. More...

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

Public Member Functions

unsafe void GetAssignedAxes (out string[] assignedAxes)
 Gets a list of assigned axes of the channel More...
 
unsafe void GetReferencedSpindles (out string[] refSpindles)
 Gets a list of referenced spindles of the channel More...
 
unsafe void SetAssignedAxes (string[] assignedAxes)
 Sets a list of assigned axes of the channel More...
 
unsafe void SetAssignedAxis (string axisName)
 Sets an assigned axis of the channel More...
 
unsafe void SetReferencedSpindle (string spindleName)
 Sets a referenced spindle of the channel More...
 
unsafe void SetReferencedSpindles (string[] refSpindles)
 Sets a list of referenced spindles of the channel More...
 
unsafe void SetUnassignedAxis (string axisName)
 Sets an unassigned axis of the channel More...
 
unsafe void SetUnreferencedSpindle (string spindleName)
 Sets an unreferenced spindle of the channel 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 string GeometryAxisX [get, set]
 Returns or sets the geometry X axis of the channel More...
 
unsafe string GeometryAxisY [get, set]
 Returns or sets the geometry Y axis of the channel More...
 
unsafe string GeometryAxisZ [get, set]
 Returns or sets the geometry Z axis of the channel More...
 
unsafe string MainSpindle [get, set]
 Returns or sets the main spindle of the channel More...
 
unsafe string Name [get, set]
 Returns or sets the name of the channel 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

This class is used for add kinematic channel to the channel configuratation list.

Calling Builder.Commit on this builder will only return a null reference (Nothing in Visual Basic).

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

Created in NX9.0.3

Member Function Documentation

unsafe void NXOpen.SIM.KinematicChannelBuilder.GetAssignedAxes ( out string[]  assignedAxes)
inline

Gets a list of assigned axes of the channel

Created in NX9.0.3

License requirements: None.

Parameters
assignedAxesthe list of assigned axes
unsafe void NXOpen.SIM.KinematicChannelBuilder.GetReferencedSpindles ( out string[]  refSpindles)
inline

Gets a list of referenced spindles of the channel

Created in NX9.0.3

License requirements: None.

Parameters
refSpindlesthe list of referenced spindles
unsafe void NXOpen.SIM.KinematicChannelBuilder.SetAssignedAxes ( string[]  assignedAxes)
inline

Sets a list of assigned axes of the channel

Created in NX9.0.3

License requirements: ug_isv_full ("Full functionality for Integrated Simulation and Verification") OR nx_isv_mtb ("Machine Tool Builder")

Parameters
assignedAxesthe list of assigned axes
unsafe void NXOpen.SIM.KinematicChannelBuilder.SetAssignedAxis ( string  axisName)
inline

Sets an assigned axis of the channel

Created in NX9.0.3

License requirements: ug_isv_full ("Full functionality for Integrated Simulation and Verification") OR nx_isv_mtb ("Machine Tool Builder")

Parameters
axisNamethe assigned axis
unsafe void NXOpen.SIM.KinematicChannelBuilder.SetReferencedSpindle ( string  spindleName)
inline

Sets a referenced spindle of the channel

Created in NX9.0.3

License requirements: ug_isv_full ("Full functionality for Integrated Simulation and Verification") OR nx_isv_mtb ("Machine Tool Builder")

Parameters
spindleNamethe referenced spindle
unsafe void NXOpen.SIM.KinematicChannelBuilder.SetReferencedSpindles ( string[]  refSpindles)
inline

Sets a list of referenced spindles of the channel

Created in NX9.0.3

License requirements: ug_isv_full ("Full functionality for Integrated Simulation and Verification") OR nx_isv_mtb ("Machine Tool Builder")

Parameters
refSpindlesthe list of referenced spindles
unsafe void NXOpen.SIM.KinematicChannelBuilder.SetUnassignedAxis ( string  axisName)
inline

Sets an unassigned axis of the channel

Created in NX9.0.3

License requirements: ug_isv_full ("Full functionality for Integrated Simulation and Verification") OR nx_isv_mtb ("Machine Tool Builder")

Parameters
axisNamethe unassigned axis
unsafe void NXOpen.SIM.KinematicChannelBuilder.SetUnreferencedSpindle ( string  spindleName)
inline

Sets an unreferenced spindle of the channel

Created in NX9.0.3

License requirements: ug_isv_full ("Full functionality for Integrated Simulation and Verification") OR nx_isv_mtb ("Machine Tool Builder")

Parameters
spindleNamethe unreferenced spindle
unsafe bool NXOpen.SIM.KinematicChannelBuilder.Validate ( )
inline

Validate whether the inputs to the component are sufficient for commit to be called.

If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven't set it. This method throws a not-yet-implemented NXException for some components.

Created in NX3.0.1

License requirements: None.

Returns
Was self validation successful

Implements NXOpen.GeometricUtilities.IComponentBuilder.

Property Documentation

unsafe string NXOpen.SIM.KinematicChannelBuilder.GeometryAxisX
getset

Returns or sets the geometry X axis of the channel

Created in NX9.0.3

License requirements to get this property: None.

License requirements to set this property: ug_isv_full ("Full functionality for Integrated Simulation and Verification") OR nx_isv_mtb ("Machine Tool Builder")

unsafe string NXOpen.SIM.KinematicChannelBuilder.GeometryAxisY
getset

Returns or sets the geometry Y axis of the channel

Created in NX9.0.3

License requirements to get this property: None.

License requirements to set this property: ug_isv_full ("Full functionality for Integrated Simulation and Verification") OR nx_isv_mtb ("Machine Tool Builder")

unsafe string NXOpen.SIM.KinematicChannelBuilder.GeometryAxisZ
getset

Returns or sets the geometry Z axis of the channel

Created in NX9.0.3

License requirements to get this property: None.

License requirements to set this property: ug_isv_full ("Full functionality for Integrated Simulation and Verification") OR nx_isv_mtb ("Machine Tool Builder")

unsafe string NXOpen.SIM.KinematicChannelBuilder.MainSpindle
getset

Returns or sets the main spindle of the channel

Created in NX9.0.3

License requirements to get this property: None.

License requirements to set this property: ug_isv_full ("Full functionality for Integrated Simulation and Verification") OR nx_isv_mtb ("Machine Tool Builder")

unsafe string NXOpen.SIM.KinematicChannelBuilder.Name
getset

Returns or sets the name of the channel

Created in NX9.0.3

License requirements to get this property: None.

License requirements to set this property: ug_isv_full ("Full functionality for Integrated Simulation and Verification") OR nx_isv_mtb ("Machine Tool Builder")


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