Represents the KinematicComponentBuilder class object More...

Inheritance diagram for NXOpen.SIM.KinematicComponentBuilder:

Public Types
enum	RegisterTypes { SameAsPocketId, Specify }
	The register types More...

enum	SystemClass { Machine, Tool, Turret, Pocket, Temporary, Part, Workpiece, SetupElement, Basic, LatheSpindle, PocketOnHead, ToolCutting, Spinning, TempSpinning, Head, RobotMountableComponent, RobotPickAndPlaceComponent, ToolNonCutting, FacingHead, AdditiveMaterial }
	The SIM KIM system classes More...

enum	WorkPositionAngleTypes { None, SpecifyAngle }
	The Working Position Angle type More...

Public Member Functions
unsafe void	AddChannelName (string channel)
	Adds a channel name to the component More...

unsafe void	AddGeometry (NXOpen.NXObject geo)
	Adds a single geometry element More...

unsafe void	AddHoldingSystem (string holdSys)
	Adds a holding system to the component More...

unsafe void	AddSystemClass (NXOpen.SIM.KinematicComponentBuilder.SystemClass sysClass)
	Add a system class More...

unsafe void	AddUserClassName (string uclass)
	Adds a user class to the component More...

unsafe void	DeleteAllGeometries ()
	Deletes all geometry elements from the component More...

unsafe void	DeleteAllSystemClasses ()
	Delete all system classes of the component More...

unsafe void	DeleteChannelName (string channel)
	Deletes a channel name from the component More...

unsafe void	DeleteGeometry (NXOpen.NXObject geo)
	Deletes a single geometry element from the component More...

unsafe void	DeleteHoldingSystem (string holdSys)
	Deletes a holding system from the component More...

unsafe void	DeleteSystemClass (NXOpen.SIM.KinematicComponentBuilder.SystemClass sysClasses)
	Delete a system class More...

unsafe void	DeleteUserClassName (string uclass)
	Deletes a user class from the component More...

unsafe string[]	GetChannelNames ()
	Get a list of channel names of the component More...

unsafe void	GetGeometries (out NXOpen.NXObject[] geos)
	Returns the geometry elements assigned to this component More...

unsafe string[]	GetHoldingSystems ()
	Get a list of holding systems of the component More...

unsafe bool	GetSaveIpw ()
	Does the system save an IPW with the component? More...

unsafe void	GetSystemClasses (out NXOpen.SIM.KinematicComponentBuilder.SystemClass[] sysClasses)
	Returns the component's system classes More...

unsafe string[]	GetUserClassNames ()
	Get a list of user classes of the component More...

unsafe bool	IsOfSystemClass (NXOpen.SIM.KinematicComponentBuilder.SystemClass sysClass)
	Test if the compomnent is a member of the given system class More...

unsafe void	RenameChannelName (string oldName, string newName)
	Renames a channel name from the component More...

unsafe void	RenameHoldingSystem (string oldName, string newName)
	Renames a holding system from the component More...

unsafe void	RenameUserClass (string oldName, string newName)
	Renames a user class from the component More...

unsafe void	SetGeometries (NXOpen.NXObject[] geos)
	Sets geometry elements for the component More...

unsafe void	SetSaveIpw (bool saveIpw)
	Save an IPW with the component 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 int	AdjustRegister `[get, set]`
	Returns or sets the adjust register More...

unsafe NXOpen.SIM.KinematicComponentBuilder.RegisterTypes	AdjustRegisterType `[get, set]`
	Returns or sets the adjust register type More...

unsafe int	CutcomRegister `[get, set]`
	Returns or sets the cutcom register More...

unsafe NXOpen.SIM.KinematicComponentBuilder.RegisterTypes	CutcomRegisterType `[get, set]`
	Returns or sets the cutcom register type More...

unsafe string	CutterId `[get, set]`
	Returns or sets the cutter id string to identify a cutter within a multitool More...

unsafe string	DeviceId `[get, set]`
	Returns or sets the device id More...

unsafe int	HolderId `[get, set]`
	Returns or sets the holder id More...

unsafe string	HolderIdString `[get, set]`
	Returns or sets the holder id in string More...

unsafe NXOpen.SIM.KinematicJunctionBuilderList	JunctionList `[get]`
	Returns the junction list More...

unsafe string	Name `[get, set]`
	Returns or sets the kim component's name More...

unsafe int	NumberOfTools `[get, set]`
	Returns or sets the number of tools More...

unsafe double	WorkPositionAngle `[get, set]`
	Returns or sets the working position angle More...

unsafe NXOpen.SIM.KinematicComponentBuilder.WorkPositionAngleTypes	WorkPositionAngleType `[get, set]`
	Returns or sets the working position angle type 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 the KinematicComponentBuilder class object

To create a new instance of this class, use NXOpen.SIM.KinematicComponentCollection.CreateHeadBaseComponentBuilder

Created in NX7.5.0

Member Enumeration Documentation

enum NXOpen.SIM.KinematicComponentBuilder.RegisterTypes

The register types

Enumerator
SameAsPocketId	the pocket id defined the register
Specify	the register is specified

enum NXOpen.SIM.KinematicComponentBuilder.SystemClass

The SIM KIM system classes

Enumerator
Machine	Machine Base classification
Tool	Tool classification
Turret	Device classification
Pocket	Static Holder classification
Temporary	Temporary classification
Part	Part - Setup classification
Workpiece	Workpiece - Setup classification
SetupElement	Any setup element classification
Basic	Only available in a BASIC machine. If this bit is set, then the machine part can be used for simulation when only UG_ISV_BASIC license is available
LatheSpindle	Lathe Spindle classification
PocketOnHead	Dynamic Holder classification
ToolCutting	Tool Cutting classification
Spinning	Spinning classification
TempSpinning	Temporary spinning classification (only for internal use)
Head	Head class
RobotMountableComponent	Mountable robot component
RobotPickAndPlaceComponent	Pick and place robot component
ToolNonCutting	Non cutting portion of tool
FacingHead	Facing head
AdditiveMaterial	Additive Material - Setup classification

enum NXOpen.SIM.KinematicComponentBuilder.WorkPositionAngleTypes

The Working Position Angle type

Enumerator
None	no angle specified
SpecifyAngle	angle is specified

Member Function Documentation

unsafe void NXOpen.SIM.KinematicComponentBuilder.AddChannelName ( string channel )

inline

Adds a channel name to the component

Created in NX7.5.0

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

Parameters

channel The channel name to add

unsafe void NXOpen.SIM.KinematicComponentBuilder.AddGeometry ( NXOpen.NXObject geo )

inline

Adds a single geometry element

Created in NX7.5.0

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

Parameters

geo	The geometry element to add

unsafe void NXOpen.SIM.KinematicComponentBuilder.AddHoldingSystem ( string holdSys )

inline

Adds a holding system to the component

Created in NX7.5.0

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

Parameters

holdSys The holding system to add

unsafe void NXOpen.SIM.KinematicComponentBuilder.AddSystemClass ( NXOpen.SIM.KinematicComponentBuilder.SystemClass sysClass )

inline

Add a system class

Created in NX7.5.0

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

Parameters

sysClass the system class to add

unsafe void NXOpen.SIM.KinematicComponentBuilder.AddUserClassName ( string uclass )

inline

Adds a user class to the component

Created in NX7.5.0

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

Parameters

uclass The user cass to add

unsafe void NXOpen.SIM.KinematicComponentBuilder.DeleteAllGeometries ( )

inline

Deletes all geometry elements from the component

Created in NX7.5.0

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

unsafe void NXOpen.SIM.KinematicComponentBuilder.DeleteAllSystemClasses ( )

inline

Delete all system classes of the component

Created in NX7.5.0

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

unsafe void NXOpen.SIM.KinematicComponentBuilder.DeleteChannelName ( string channel )

inline

Deletes a channel name from the component

Created in NX7.5.0

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

Parameters

channel The channel name to remove

unsafe void NXOpen.SIM.KinematicComponentBuilder.DeleteGeometry ( NXOpen.NXObject geo )

inline

Deletes a single geometry element from the component

Created in NX7.5.0

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

Parameters

geo	The geometry to remove

unsafe void NXOpen.SIM.KinematicComponentBuilder.DeleteHoldingSystem ( string holdSys )

inline

Deletes a holding system from the component

Created in NX7.5.0

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

Parameters

holdSys The holding system to remove

unsafe void NXOpen.SIM.KinematicComponentBuilder.DeleteSystemClass ( NXOpen.SIM.KinematicComponentBuilder.SystemClass sysClasses )

inline

Delete a system class

Created in NX7.5.0

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

Parameters

sysClasses the system class to delete

unsafe void NXOpen.SIM.KinematicComponentBuilder.DeleteUserClassName ( string uclass )

inline

Deletes a user class from the component

Created in NX7.5.0

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

Parameters

uclass The user cass to remove

unsafe string [] NXOpen.SIM.KinematicComponentBuilder.GetChannelNames ( )

inline

Get a list of channel names of the component

Created in NX7.5.0

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

Returns: The channel names of the component

unsafe void NXOpen.SIM.KinematicComponentBuilder.GetGeometries ( out NXOpen.NXObject[] geos )

inline

Returns the geometry elements assigned to this component

Created in NX7.5.0

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

Parameters

geos	The geometry elements

unsafe string [] NXOpen.SIM.KinematicComponentBuilder.GetHoldingSystems ( )

inline

Get a list of holding systems of the component

Created in NX7.5.0

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

Returns: The channel names of the component

unsafe bool NXOpen.SIM.KinematicComponentBuilder.GetSaveIpw ( )

inline

Does the system save an IPW with the component?

Created in NX11.0.1

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

Returns

unsafe void NXOpen.SIM.KinematicComponentBuilder.GetSystemClasses ( out NXOpen.SIM.KinematicComponentBuilder.SystemClass[] sysClasses )

inline

Returns the component's system classes

Created in NX7.5.0

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

Parameters

sysClasses the component's system classes

unsafe string [] NXOpen.SIM.KinematicComponentBuilder.GetUserClassNames ( )

inline

Get a list of user classes of the component

Created in NX7.5.0

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

Returns: The user classes of the component

unsafe bool NXOpen.SIM.KinematicComponentBuilder.IsOfSystemClass ( NXOpen.SIM.KinematicComponentBuilder.SystemClass sysClass )

inline

Test if the compomnent is a member of the given system class

Created in NX7.5.0

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

Parameters

sysClass the system class to test

Returns: TRUE if component is of the system class

unsafe void NXOpen.SIM.KinematicComponentBuilder.RenameChannelName	(	string	oldName,
		string	newName
	)

inline

Renames a channel name from the component

Created in NX7.5.0

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

Parameters

oldName	The old channel name
newName	The new channel name

unsafe void NXOpen.SIM.KinematicComponentBuilder.RenameHoldingSystem	(	string	oldName,
		string	newName
	)

inline

Renames a holding system from the component

Created in NX7.5.0

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

Parameters

oldName	The old holding system
newName	The new holding system

unsafe void NXOpen.SIM.KinematicComponentBuilder.RenameUserClass	(	string	oldName,
		string	newName
	)

inline

Renames a user class from the component

Created in NX7.5.0

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

Parameters

oldName	The old user class
newName	The new user class

unsafe void NXOpen.SIM.KinematicComponentBuilder.SetGeometries ( NXOpen.NXObject[] geos )

inline

Sets geometry elements for the component

Created in NX7.5.0

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

Parameters

geos	the geometry elements

unsafe void NXOpen.SIM.KinematicComponentBuilder.SetSaveIpw ( bool saveIpw )

inline

Save an IPW with the component

Created in NX11.0.1

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

Parameters

saveIpw

Property Documentation

unsafe int NXOpen.SIM.KinematicComponentBuilder.AdjustRegister

getset

Returns or sets the adjust register

Created in NX7.5.0

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

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

unsafe NXOpen.SIM.KinematicComponentBuilder.RegisterTypes NXOpen.SIM.KinematicComponentBuilder.AdjustRegisterType

getset

Returns or sets the adjust register type

Created in NX7.5.0

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

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

unsafe int NXOpen.SIM.KinematicComponentBuilder.CutcomRegister

getset

Returns or sets the cutcom register

Created in NX7.5.0

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

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

unsafe NXOpen.SIM.KinematicComponentBuilder.RegisterTypes NXOpen.SIM.KinematicComponentBuilder.CutcomRegisterType

getset

Returns or sets the cutcom register type

Created in NX7.5.0

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

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.KinematicComponentBuilder.CutterId

getset

Returns or sets the cutter id string to identify a cutter within a multitool

Created in NX11.0.1

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

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.KinematicComponentBuilder.DeviceId

getset

Returns or sets the device id

Created in NX7.5.0

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

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

unsafe int NXOpen.SIM.KinematicComponentBuilder.HolderId

getset

Returns or sets the holder id

Created in NX7.5.0

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

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.KinematicComponentBuilder.HolderIdString

getset

Returns or sets the holder id in string

Created in NX7.5.5

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

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

unsafe NXOpen.SIM.KinematicJunctionBuilderList NXOpen.SIM.KinematicComponentBuilder.JunctionList

get

Returns the junction list

Created in NX7.5.0

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

unsafe string NXOpen.SIM.KinematicComponentBuilder.Name

getset

Returns or sets the kim component's name

Created in NX7.5.0

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

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

unsafe int NXOpen.SIM.KinematicComponentBuilder.NumberOfTools

getset

Returns or sets the number of tools

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") OR nx_isv_mtb ("Machine Tool Builder")

unsafe double NXOpen.SIM.KinematicComponentBuilder.WorkPositionAngle

getset

Returns or sets the working position angle

Created in NX7.5.0

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

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

unsafe NXOpen.SIM.KinematicComponentBuilder.WorkPositionAngleTypes NXOpen.SIM.KinematicComponentBuilder.WorkPositionAngleType

getset

Returns or sets the working position angle type

Created in NX7.5.0

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

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:

SIM_KinematicComponentBuilder.cs

Public Types

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Member Function Documentation

Property Documentation