NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::Motion::MotionSensorBuilder Class Reference

Represents a NXOpen::Motion::MotionSensorBuilder
To create a new instance of this class, use NXOpen::Motion::MotionSensorCollection::CreateMotionSensorBuilder
Default values. More...

Inheritance diagram for NXOpen::Motion::MotionSensorBuilder:
NXOpen::Motion::MotionBuilder NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  Component {
  ComponentLinearMagnitude, ComponentX, ComponentY, ComponentZ,
  ComponentAngularMagnitude, ComponentRx, ComponentRy, ComponentRz
}
 component enumeration type More...
 
enum  Reference { ReferenceAbsolute, ReferenceRelative, ReferenceUserDefined }
 reference frame enumeration type More...
 
enum  Types { TypesDisplacement, TypesVelocity, TypesAcceleration, TypesForce }
 sensor type More...
 

Public Member Functions

NXOpen::Motion::MotionSensorBuilder::Component ComponentType ()
 Returns the component type
Created in NX6.0.0. More...
 
NXOpen::SelectNXObjectMeasurementObject ()
 Returns the first marker object
Created in NX6.0.0. More...
 
NXString Name ()
 Returns the name
Created in NX6.0.0. More...
 
NXOpen::Motion::MotionSensorBuilder::Reference ReferenceFrame ()
 Returns the reference frame type
Created in NX6.0.0. More...
 
NXOpen::Motion::SelectMarkerReferenceMarker ()
 Returns the reference marker object
Created in NX6.0.0. More...
 
NXOpen::Motion::SelectMarkerRelativeMarker ()
 Returns the second marker object
Created in NX6.0.0. More...
 
void SetComponentType (NXOpen::Motion::MotionSensorBuilder::Component componentType)
 Sets the component type
Created in NX6.0.0. More...
 
void SetName (const NXString &name)
 Sets the name
Created in NX6.0.0. More...
 
void SetName (const char *name)
 Sets the name
Created in NX6.0.0. More...
 
void SetReferenceFrame (NXOpen::Motion::MotionSensorBuilder::Reference referenceFrame)
 Sets the reference frame type
Created in NX6.0.0. More...
 
void SetType (NXOpen::Motion::MotionSensorBuilder::Types type)
 Sets the sensor type
Created in NX6.0.0. More...
 
NXOpen::Motion::MotionSensorBuilder::Types Type ()
 Returns the sensor type
Created in NX6.0.0. 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::NXObjectCommit ()
 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::NXObjectGetObject ()
 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 NXOpen::Motion::MotionSensorBuilder
To create a new instance of this class, use NXOpen::Motion::MotionSensorCollection::CreateMotionSensorBuilder
Default values.

Property Value

ComponentType

LinearMagnitude

ReferenceFrame

Absolute

Type

Displacement


Created in NX6.0.0.

Member Enumeration Documentation

component enumeration type

Enumerator
ComponentLinearMagnitude 

linear magnitude component

ComponentX 

x component

ComponentY 

y component

ComponentZ 

z component

ComponentAngularMagnitude 

angular magnitude component

ComponentRx 

rx component

ComponentRy 

ry component

ComponentRz 

rz component

reference frame enumeration type

Enumerator
ReferenceAbsolute 

absolute reference frame

ReferenceRelative 

relative reference frame

ReferenceUserDefined 

user defined reference frame

sensor type

Enumerator
TypesDisplacement 

displacement sensor type

TypesVelocity 

velocity sensor type

TypesAcceleration 

acceleration sensor type

TypesForce 

force

Member Function Documentation

NXOpen::Motion::MotionSensorBuilder::Component NXOpen::Motion::MotionSensorBuilder::ComponentType ( )

Returns the component type
Created in NX6.0.0.



License requirements : None

NXOpen::SelectNXObject* NXOpen::Motion::MotionSensorBuilder::MeasurementObject ( )

Returns the first marker object
Created in NX6.0.0.



License requirements : None

NXString NXOpen::Motion::MotionSensorBuilder::Name ( )

Returns the name
Created in NX6.0.0.



License requirements : None

NXOpen::Motion::MotionSensorBuilder::Reference NXOpen::Motion::MotionSensorBuilder::ReferenceFrame ( )

Returns the reference frame type
Created in NX6.0.0.



License requirements : None

NXOpen::Motion::SelectMarker* NXOpen::Motion::MotionSensorBuilder::ReferenceMarker ( )

Returns the reference marker object
Created in NX6.0.0.



License requirements : None

NXOpen::Motion::SelectMarker* NXOpen::Motion::MotionSensorBuilder::RelativeMarker ( )

Returns the second marker object
Created in NX6.0.0.



License requirements : None

void NXOpen::Motion::MotionSensorBuilder::SetComponentType ( NXOpen::Motion::MotionSensorBuilder::Component  componentType)

Sets the component type
Created in NX6.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters
componentTypecomponenttype
void NXOpen::Motion::MotionSensorBuilder::SetName ( const NXString name)

Sets the name
Created in NX6.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters
namename
void NXOpen::Motion::MotionSensorBuilder::SetName ( const char *  name)

Sets the name
Created in NX6.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters
namename
void NXOpen::Motion::MotionSensorBuilder::SetReferenceFrame ( NXOpen::Motion::MotionSensorBuilder::Reference  referenceFrame)

Sets the reference frame type
Created in NX6.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters
referenceFramereferenceframe
void NXOpen::Motion::MotionSensorBuilder::SetType ( NXOpen::Motion::MotionSensorBuilder::Types  type)

Sets the sensor type
Created in NX6.0.0.



License requirements : mechanisms ("MECHANISMS")

Parameters
typetype
NXOpen::Motion::MotionSensorBuilder::Types NXOpen::Motion::MotionSensorBuilder::Type ( )

Returns the sensor type
Created in NX6.0.0.



License requirements : None


The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.