NXOpen C++ Reference Guide
|
Represents a Motion::ControlPort builder specific to control input element. More...
Public Types | |
enum | MeasuredComponent { MeasuredComponentLinearMagnitude, MeasuredComponentX, MeasuredComponentY, MeasuredComponentZ, MeasuredComponentAngularMagnitude, MeasuredComponentRx, MeasuredComponentRy, MeasuredComponentRz, MeasuredComponentRadial } |
the types of components that can be measured by the control input element for the selected variable. More... | |
enum | MeasuredVariable { MeasuredVariableDisplacement, MeasuredVariableVelocity, MeasuredVariableAcceleration, MeasuredVariableGravityExcludedAcceleration, MeasuredVariableTraveledDistance } |
the types of variables that can be measured by the control input element. More... | |
Public Member Functions | |
NXOpen::Motion::ControlInputPortBuilder::MeasuredComponent | Component () |
Returns the component that is measured by the control input element for the selected variable. More... | |
bool | Digital () |
Returns a logical flag to specify whether the element is digital (sampled) or analog. More... | |
NXString | Name () |
Returns the control input port name. More... | |
NXOpen::Expression * | SampleRate () |
Returns the Sample Rate specifies the sampling frequency in samples per second for this element. More... | |
void | SetComponent (NXOpen::Motion::ControlInputPortBuilder::MeasuredComponent component) |
Sets the component that is measured by the control input element for the selected variable. More... | |
void | SetDigital (bool digital) |
Sets a logical flag to specify whether the element is digital (sampled) or analog. More... | |
void | SetName (const NXString &name) |
Sets the control input port name. More... | |
void | SetName (const char *name) |
Sets the control input port name. More... | |
void | SetVariable (NXOpen::Motion::ControlInputPortBuilder::MeasuredVariable variable) |
Sets the variable that is measured by the control input element. More... | |
NXOpen::Motion::ControlInputPortBuilder::MeasuredVariable | Variable () |
Returns the variable that is measured by the 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... | |
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.
the types of components that can be measured by the control input element for the selected variable.
the types of variables that can be measured by the control input element.
NXOpen::Motion::ControlInputPortBuilder::MeasuredComponent NXOpen::Motion::ControlInputPortBuilder::Component | ( | ) |
Returns the component that is measured by the control input element for the selected variable.
Created in NX11.0.0.
License requirements : mechanisms ("MECHANISMS")
bool NXOpen::Motion::ControlInputPortBuilder::Digital | ( | ) |
Returns 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 : mechanisms ("MECHANISMS")
NXString NXOpen::Motion::ControlInputPortBuilder::Name | ( | ) |
Returns the control input port name.
Must be unique across all motion elements.
Created in NX11.0.0.
License requirements : mechanisms ("MECHANISMS")
NXOpen::Expression* NXOpen::Motion::ControlInputPortBuilder::SampleRate | ( | ) |
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")
void NXOpen::Motion::ControlInputPortBuilder::SetComponent | ( | NXOpen::Motion::ControlInputPortBuilder::MeasuredComponent | component | ) |
Sets the component that is measured by the control input element for the selected variable.
Created in NX11.0.0.
License requirements : mechanisms ("MECHANISMS")
component | component |
void NXOpen::Motion::ControlInputPortBuilder::SetDigital | ( | bool | digital | ) |
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 : mechanisms ("MECHANISMS")
digital | digital |
void NXOpen::Motion::ControlInputPortBuilder::SetName | ( | const NXString & | name | ) |
Sets the control input port name.
Must be unique across all motion elements.
Created in NX11.0.0.
License requirements : mechanisms ("MECHANISMS")
name | name |
void NXOpen::Motion::ControlInputPortBuilder::SetName | ( | const char * | name | ) |
Sets the control input port name.
Must be unique across all motion elements.
Created in NX11.0.0.
License requirements : mechanisms ("MECHANISMS")
name | name |
void NXOpen::Motion::ControlInputPortBuilder::SetVariable | ( | NXOpen::Motion::ControlInputPortBuilder::MeasuredVariable | variable | ) |
Sets the variable that is measured by the control input element.
Created in NX11.0.0.
License requirements : mechanisms ("MECHANISMS")
variable | variable |
NXOpen::Motion::ControlInputPortBuilder::MeasuredVariable NXOpen::Motion::ControlInputPortBuilder::Variable | ( | ) |
Returns the variable that is measured by the control input element.
Created in NX11.0.0.
License requirements : mechanisms ("MECHANISMS")