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

Represents a Motion.ControlInput builder More...

Inheritance diagram for NXOpen.Motion.ControlInputBuilder:
NXOpen.Motion.EntityPropTableBuilder NXOpen.Motion.MotionBuilder NXOpen.Builder NXOpen.TaggedObject NXOpen.GeometricUtilities.IComponentBuilder NXOpen.Utilities.NXRemotableObject IMessageSink

Public Types

enum  FunctionCurveType {
  Polynomial, Harmonic, Function, Profile2D,
  Step, Ramp
}
 Function curve type More...
 
enum  InputType { Link }
 Control Input type. More...
 
enum  PathFollowerElmentType { Function, Profile2D, Road }
 Path follower element type More...
 
enum  PathFollowerLookAheadDistanceType { Expression, FromPort }
 Path follower look ahead distance type More...
 
enum  SpecialControlRefernceNumberType { Extra, Lambda, ElementData }
 Special control reference number type More...
 

Public Member Functions

unsafe
NXOpen.Motion.ControlInputPortBuilder 
CreateControlInputPortBuilder ()
 Creates a new control input port item and adds to the PortsList. More...
 
- Public Member Functions inherited from NXOpen.Motion.EntityPropTableBuilder
unsafe bool GetBooleanPropertyValue (string propertyName)
 Returns the boolean value of the property More...
 
unsafe NXOpen.CoordinateSystem GetCsysPropertyValue (string propertyName)
 Returns the csys value of the property More...
 
unsafe NXOpen.Direction GetDirectionPropertyValue (string propertyName)
 Returns the direction value of the property More...
 
unsafe string GetEntitySubtypeName ()
 Returns the entity subtype name More...
 
unsafe string GetFileReferenceValue (string propertyName)
 Returns the file reference value of the property More...
 
unsafe int GetIntegerPropertyValue (string propertyName)
 Returns the integer value of the property More...
 
unsafe NXOpen.PhysicalMaterial GetMaterialPropertyValue (string propertyName, out bool isInherited)
 Returns the material value of the property More...
 
unsafe NXOpen.NXObject[] GetMultipleReferencePropertyValue (string propertyName)
 Returns the multiple referenced object values of the property More...
 
unsafe NXOpen.Point GetPointPropertyValue (string propertyName)
 Returns the point value of the property More...
 
unsafe
NXOpen.Motion.ParamOverrideState 
GetPropertyOverrideState (string propertyName)
 Returns the override state of the property More...
 
unsafe NXOpen.NXObject GetReferencePropertyValue (string propertyName)
 Returns the referenced object value of the property More...
 
unsafe void GetScalarExpressionPropertyValue (string propertyName, out double propertyValue, out NXOpen.Unit unitType)
 Returns the double value of the property with unit More...
 
unsafe string GetStringPropertyValue (string propertyName)
 Returns the string value of the property More...
 
unsafe void SetBooleanPropertyValue (string propertyName, bool propertyValue)
 Sets the boolean value of the property More...
 
unsafe void SetCsysPropertyValue (string propertyName, NXOpen.CoordinateSystem propertyValue)
 Sets the csys value of the property More...
 
unsafe void SetDirectionPropertyValue (string propertyName, NXOpen.Direction propertyValue)
 Sets the direction value of the property More...
 
unsafe void SetEntitySubtypeName (string entitySubtypeName)
 Set the entity subtype name More...
 
unsafe void SetFileReferenceValue (string propertyName, string propertyValue)
 Sets the file reference value of the property More...
 
unsafe void SetIntegerPropertyValue (string propertyName, int propertyValue)
 Sets the integer value of the property More...
 
unsafe void SetMaterialPropertyValue (string propertyName, bool isInherited, NXOpen.PhysicalMaterial propertyValue)
 Sets the material value of the property More...
 
unsafe void SetMultipleReferencePropertyValue (string propertyName, NXOpen.NXObject[] propertyValue)
 Sets the multiple referenced object values of the property More...
 
unsafe void SetPointPropertyValue (string propertyName, NXOpen.Point propertyValue)
 Sets the point value of the property More...
 
unsafe void SetPropertyOverrideState (string propertyName, NXOpen.Motion.ParamOverrideState overrideState)
 Sets the override state of the property More...
 
unsafe void SetPropertyWithoutValue (string propertyName)
 Unset a property value More...
 
unsafe void SetReferencePropertyValue (string propertyName, NXOpen.NXObject propertyValue)
 Sets the referenced object value of the property More...
 
unsafe void SetScalarExpressionPropertyValue (string propertyName, double propertyValue, NXOpen.Unit unitType)
 Sets the double value of the property with unit More...
 
unsafe void SetScalarExpressionPropertyValue (string propertyName, string propertyValue, NXOpen.Unit unitType)
 Sets the string value of the property with unit More...
 
unsafe void SetStringPropertyValue (string propertyName, string propertyValue)
 Sets the string value of the property More...
 

Properties

unsafe
NXOpen.Motion.LinkAttachmentData 
MeasurementLinkAttachment [get]
 Returns the measurement motion body attachment. More...
 
unsafe string Name [get, set]
 Returns or sets the control input name. More...
 
unsafe
NXOpen.Motion.ControlInputPortBuilderList 
PortsList [get]
 Returns the list of all child control input ports. More...
 
unsafe
NXOpen.Motion.LinkAttachmentData 
ReferenceLinkAttachment [get]
 Returns the reference motion body attachment and its components are optional. More...
 
unsafe
NXOpen.Motion.LinkAttachmentData 
RelativeLinkAttachment [get]
 Returns the relative motion body attachment and its components are optional. More...
 
unsafe
NXOpen.Motion.ControlInputPortBuilder 
SinglePort [get]
 Returns the single port. More...
 
unsafe
NXOpen.Motion.ControlInputBuilder.InputType 
Type [get, set]
 Returns or sets the type of control input element. More...
 
- Properties inherited from NXOpen.Motion.EntityPropTableBuilder
unsafe string EntityName [get, set]
 Returns or sets the entity name. 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...
 
- 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 Motion.ControlInput builder

To create a new instance of this class, use NXOpen.Motion.ControlInputCollection.CreateControlInputBuilder

Created in NX11.0.0

Member Enumeration Documentation

Function curve type

Enumerator
Polynomial 

Polynomial

Harmonic 

Harmonic

Function 

Function

Profile2D 

Profile2D

Step 

Step

Ramp 

Ramp

Control Input type.

Deprecated.

Enumerator
Link 

Motion body

Path follower element type

Enumerator
Function 

Function

Profile2D 

Profile2D

Road 

Road

Path follower look ahead distance type

Enumerator
Expression 

Expression

FromPort 

From port

Special control reference number type

Enumerator
Extra 

Extra

Lambda 

Lambda

ElementData 

ElementData

Member Function Documentation

unsafe NXOpen.Motion.ControlInputPortBuilder NXOpen.Motion.ControlInputBuilder.CreateControlInputPortBuilder ( )
inline

Creates a new control input port item and adds to the PortsList.

Created in NX11.0.0

License requirements: mechanisms ("MECHANISMS")

Returns

Property Documentation

unsafe NXOpen.Motion.LinkAttachmentData NXOpen.Motion.ControlInputBuilder.MeasurementLinkAttachment
get

Returns the measurement motion body attachment.

The control input element measures the kinematic variables at the reference frame defined by this attachment.

Created in NX11.0.0

Deprecated in NX1872.0.0. Use NXOpen.Motion.EntityPropTableBuilder.GetReferencePropertyValue , NXOpen.Motion.EntityPropTableBuilder.GetPointPropertyValue and NXOpen.Motion.EntityPropTableBuilder.GetCsysPropertyValue

License requirements: mechanisms ("MECHANISMS")

unsafe string NXOpen.Motion.ControlInputBuilder.Name
getset

Returns or sets the control input 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.Motion.ControlInputPortBuilderList NXOpen.Motion.ControlInputBuilder.PortsList
get

Returns the list of all child control input ports.

It is used when the control input is motion body type

Created in NX11.0.0

License requirements: mechanisms ("MECHANISMS")

unsafe NXOpen.Motion.LinkAttachmentData NXOpen.Motion.ControlInputBuilder.ReferenceLinkAttachment
get

Returns the reference motion body attachment and its components are optional.

When the motion body, point or csys are not defined, they are interpreted as ground motion body, ground origin or ground csys respectively. The measurement is computed in the reference frame defined by this attachment.

Created in NX11.0.0

Deprecated in NX1872.0.0. Use NXOpen.Motion.EntityPropTableBuilder.GetReferencePropertyValue , NXOpen.Motion.EntityPropTableBuilder.GetPointPropertyValue and NXOpen.Motion.EntityPropTableBuilder.GetCsysPropertyValue

License requirements: mechanisms ("MECHANISMS")

unsafe NXOpen.Motion.LinkAttachmentData NXOpen.Motion.ControlInputBuilder.RelativeLinkAttachment
get

Returns the relative motion body attachment and its components are optional.

When the motion body, point or csys are not defined, they are interpreted as ground motion body, ground origin or ground csys respectively. The measurement is made relative to the reference frame defined by this attachment.

Created in NX11.0.0

Deprecated in NX1872.0.0. Use NXOpen.Motion.EntityPropTableBuilder.GetReferencePropertyValue , NXOpen.Motion.EntityPropTableBuilder.GetPointPropertyValue and NXOpen.Motion.EntityPropTableBuilder.GetCsysPropertyValue

License requirements: mechanisms ("MECHANISMS")

unsafe NXOpen.Motion.ControlInputPortBuilder NXOpen.Motion.ControlInputBuilder.SinglePort
get

Returns the single port.

It is used when the control input is not motion body type

Created in NX1899.0.0

License requirements: mechanisms ("MECHANISMS")

unsafe NXOpen.Motion.ControlInputBuilder.InputType NXOpen.Motion.ControlInputBuilder.Type
getset

Returns or sets the type of control input element.

Motion body is the default value

Created in NX11.0.0

Deprecated in NX1899.0.0. Use NXOpen.Motion.EntityPropTableBuilder.GetEntitySubtypeName

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:
Copyright 2019 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.