Represents a Motion::ControlInput builder
To create a new instance of this class, use NXOpen::Motion::ControlInputCollection::CreateControlInputBuilder
Created in NX11.0.0.
More...
Public Types | |
| enum | InputType { InputTypeLink } |
| Control Input type. More... | |
Public Member Functions | |
| NXOpen::Motion::ControlInputPortBuilder * | CreateControlInputPortBuilder () |
| Creates a new control input port item and adds to the PortsList. More... | |
| NXOpen::Motion::LinkAttachmentData * | MeasurementLinkAttachment () |
| Returns the measurement link attachment. More... | |
| NXString | Name () |
| Returns the control input name. More... | |
| NXOpen::Motion::ControlInputPortBuilderList * | PortsList () |
| Returns the list of all child control input ports. More... | |
| NXOpen::Motion::LinkAttachmentData * | ReferenceLinkAttachment () |
| Returns the reference link attachment and its components are optional. More... | |
| NXOpen::Motion::LinkAttachmentData * | RelativeLinkAttachment () |
| Returns the relative link attachment and its components are optional. More... | |
| void | SetName (const NXString &name) |
| Sets the control input name. More... | |
| void | SetName (const char *name) |
| Sets the control input name. More... | |
| void | SetType (NXOpen::Motion::ControlInputBuilder::InputType type) |
| Sets the type of control input element. More... | |
| NXOpen::Motion::ControlInputBuilder::InputType | Type () |
| Returns the type of control input element. More... | |
 Public Member Functions inherited from NXOpen::Motion::MotionBuilder | |
| double | DisplayScale () |
| Returns the icon display scale Created in NX5.0.0. More... | |
| NXString | GroupName () |
| Returns the group name Created in NX5.0.0. More... | |
| NXOpen::Motion::MotionObject::GroupType | GroupType () |
| Returns the group type Created in NX5.0.0. More... | |
| void | SetDisplayScale (double displayScale) |
| Sets the icon display scale Created in NX5.0.0. More... | |
| void | SetGroupName (const NXString &groupName) |
| Sets the group name Created in NX5.0.0. More... | |
| void | SetGroupName (const char *groupName) |
| Sets the group name Created in NX5.0.0. More... | |
| void | SetGroupType (NXOpen::Motion::MotionObject::GroupType groupType) |
| Sets the group type Created in NX5.0.0. More... | |
| Public Member Functions inherited from NXOpen::Builder | |
| NXOpen::NXObject * | Commit () |
| Commits any edits that have been applied to the builder. More... | |
| void | Destroy () |
| Deletes the builder, and cleans up any objects created by the builder. More... | |
| std::vector< NXOpen::NXObject * > | GetCommittedObjects () |
| For builders that create more than one object, this method returns the objects that are created by commit. More... | |
| NXOpen::NXObject * | GetObject () |
| Returns the object currently being edited by this builder. More... | |
| void | ShowResults () |
| Updates the model to reflect the result of an edit to the model for all builders that support showing results. More... | |
| virtual bool | Validate () |
| Validate whether the inputs to the component are sufficient for commit to be called. More... | |
| Public Member Functions inherited from NXOpen::TaggedObject | |
| tag_t | Tag () const |
| Returns the tag of this object. 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
Member Function Documentation
| NXOpen::Motion::ControlInputPortBuilder* NXOpen::Motion::ControlInputBuilder::CreateControlInputPortBuilder | ( | ) |
Creates a new control input port item and adds to the PortsList.
- Returns
Created in NX11.0.0.
License requirements : mechanisms ("MECHANISMS")
| NXOpen::Motion::LinkAttachmentData* NXOpen::Motion::ControlInputBuilder::MeasurementLinkAttachment | ( | ) |
Returns the measurement link attachment.
The control input element measures the kinematic variables at the reference frame defined by this attachment.
Created in NX11.0.0.
License requirements : mechanisms ("MECHANISMS")
| NXString NXOpen::Motion::ControlInputBuilder::Name | ( | ) |
Returns the control input name.
Must be unique across all motion elements.
Created in NX11.0.0.
License requirements : mechanisms ("MECHANISMS")
| NXOpen::Motion::ControlInputPortBuilderList* NXOpen::Motion::ControlInputBuilder::PortsList | ( | ) |
Returns the list of all child control input ports.
Created in NX11.0.0.
License requirements : mechanisms ("MECHANISMS")
| NXOpen::Motion::LinkAttachmentData* NXOpen::Motion::ControlInputBuilder::ReferenceLinkAttachment | ( | ) |
Returns the reference link attachment and its components are optional.
When the link, point or csys are not defined, they are interpreted as ground link, ground origin or ground csys respectively. The measurement is computed in the reference frame defined by this attachment.
Created in NX11.0.0.
License requirements : mechanisms ("MECHANISMS")
| NXOpen::Motion::LinkAttachmentData* NXOpen::Motion::ControlInputBuilder::RelativeLinkAttachment | ( | ) |
Returns the relative link attachment and its components are optional.
When the link, point or csys are not defined, they are interpreted as ground link, ground origin or ground csys respectively. The measurement is made relative to the reference frame defined by this attachment.
Created in NX11.0.0.
License requirements : mechanisms ("MECHANISMS")
| void NXOpen::Motion::ControlInputBuilder::SetName | ( | const NXString & | name | ) |
Sets the control input name.
Must be unique across all motion elements.
Created in NX11.0.0.
License requirements : mechanisms ("MECHANISMS")
- Parameters
-
name name
| void NXOpen::Motion::ControlInputBuilder::SetName | ( | const char * | name | ) |
Sets the control input name.
Must be unique across all motion elements.
Created in NX11.0.0.
License requirements : mechanisms ("MECHANISMS")
- Parameters
-
name name
| void NXOpen::Motion::ControlInputBuilder::SetType | ( | NXOpen::Motion::ControlInputBuilder::InputType | type | ) |
Sets the type of control input element.
Link is the default value
Created in NX11.0.0.
License requirements : mechanisms ("MECHANISMS")
- Parameters
-
type type
| NXOpen::Motion::ControlInputBuilder::InputType NXOpen::Motion::ControlInputBuilder::Type | ( | ) |
Returns the type of control input element.
Link is the default value
Created in NX11.0.0.
License requirements : mechanisms ("MECHANISMS")
The documentation for this class was generated from the following file:
- Motion_ControlInputBuilder.hxx