NXOpen.Motion.ControlInputPortBuilder Class Reference

Represents a Motion.ControlPort builder specific to control input element. More...

Inheritance diagram for NXOpen.Motion.ControlInputPortBuilder:

Public Types
enum	MeasuredComponent {   LinearMagnitude, X, Y, Z,   AngularMagnitude, Rx, Ry, Rz,   Radial }
	the types of components that can be measured by the control input element for the selected variable. More...
enum	MeasuredVariable {   Displacement, Velocity, Acceleration, GravityExcludedAcceleration,   TraveledDistance }
	the types of variables that can be measured by the control input element. More...

Properties
unsafe NXOpen.Motion.ControlInputPortBuilder.MeasuredComponent	Component [get, set]
	Returns or sets the component that is measured by the control input element for the selected variable. More...
unsafe bool	Digital [get, set]
	Returns or sets a logical flag to specify whether the element is digital (sampled) or analog. More...
unsafe string	Name [get, set]
	Returns or sets the control input port name. More...
unsafe NXOpen.Expression	SampleRate [get]
	Returns the Sample Rate specifies the sampling frequency in samples per second for this element. More...
unsafe NXOpen.Motion.ControlInputPortBuilder.MeasuredVariable	Variable [get, set]
	Returns or sets the variable that is measured by the control input element. More...
Properties inherited from NXOpen.Motion.MotionBuilder
unsafe double	DisplayScale [get, set]
	Returns or sets the icon display scale More...
unsafe string	GroupName [get, set]
	Returns or sets the group name More...
unsafe NXOpen.Motion.MotionObject.GroupType	GroupType [get, set]
	Returns or sets the group type More...

Additional Inherited Members
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...
Protected Member Functions inherited from NXOpen.TaggedObject
new void	initialize ()
	<exclude> More...

Detailed Description

Represents a Motion.ControlPort builder specific to control input element.

To create a new instance of this class, use NXOpen.Motion.ControlInputBuilder.CreateControlInputPortBuilder

Created in NX11.0.0

Member Enumeration Documentation

enum NXOpen.Motion.ControlInputPortBuilder.MeasuredComponent

the types of components that can be measured by the control input element for the selected variable.

Enumerator
LinearMagnitude	Linear Magnitude
X	X
Y	Y
Z	Z
AngularMagnitude	Angular Magnitude
Rx	RX
Ry	RY
Rz	RZ
Radial	Radial

enum NXOpen.Motion.ControlInputPortBuilder.MeasuredVariable

the types of variables that can be measured by the control input element.

Enumerator
Displacement	Displacement
Velocity	Velocity
Acceleration	Acceleration
GravityExcludedAcceleration	Gravity Excluded Acceleration
TraveledDistance	Traveled Distance

Property Documentation

unsafe NXOpen.Motion.ControlInputPortBuilder.MeasuredComponent NXOpen.Motion.ControlInputPortBuilder.Component

getset

Returns or sets the component that is measured by the control input element for the selected variable.

Created in NX11.0.0

License requirements to get this property: mechanisms ("MECHANISMS")

License requirements to set this property: mechanisms ("MECHANISMS")

unsafe bool NXOpen.Motion.ControlInputPortBuilder.Digital

getset

Returns or sets a logical flag to specify whether the element is digital (sampled) or analog.

If TRUE, the element will be considered digital and will require a sample rate.

Created in NX11.0.0

License requirements to get this property: mechanisms ("MECHANISMS")

License requirements to set this property: mechanisms ("MECHANISMS")

unsafe string NXOpen.Motion.ControlInputPortBuilder.Name

getset

Returns or sets the control input port name.

Must be unique across all motion elements.

Created in NX11.0.0

License requirements to get this property: mechanisms ("MECHANISMS")

License requirements to set this property: mechanisms ("MECHANISMS")

unsafe NXOpen.Expression NXOpen.Motion.ControlInputPortBuilder.SampleRate

get

Returns the Sample Rate specifies the sampling frequency in samples per second for this element.

A value is required if Digital flag is set to TRUE.

Created in NX11.0.0

License requirements: mechanisms ("MECHANISMS")

unsafe NXOpen.Motion.ControlInputPortBuilder.MeasuredVariable NXOpen.Motion.ControlInputPortBuilder.Variable

getset

Returns or sets the variable that is measured by the control input element.

Created in NX11.0.0

License requirements to get this property: mechanisms ("MECHANISMS")

License requirements to set this property: mechanisms ("MECHANISMS")

---

The documentation for this class was generated from the following file:

• Motion_ControlInputPortBuilder.cs