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

Represents a NXOpen::Mechatronics::GraphControl builder
To create a new instance of this class, use NXOpen::Mechatronics::GraphControlCollection::CreateGraphControlBuilder

Created in NX8.0.0. More...

Inheritance diagram for NXOpen::Mechatronics::GraphControlBuilder:
NXOpen::Mechatronics::PhysicsConstraintBuilder NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  EndAction { EndActionRestartfromBeginning, EndActionDeactivateGraphControl }
 the action in the end of graph. More...
 
enum  MasterJointType { MasterJointTypeLinear, MasterJointTypeRotary }
 the Master axis types. More...
 
enum  MasterType { MasterTypeTime, MasterTypeAxis, MasterTypeSignal }
 the Master types. More...
 
enum  MasterValueUnit { MasterValueUnitLinear, MasterValueUnitRotary, MasterValueUnitTime }
 the Master Unit types. More...
 
enum  SlaveValueUnit { SlaveValueUnitLinearPosition, SlaveValueUnitRotaryPosition, SlaveValueUnitLinearSpeed, SlaveValueUnitRotarySpeed }
 the Slave Unit types. More...
 

Public Member Functions

NXOpen::Mechatronics::CamProfileCamProfile ()
 Returns a cam profile that contains a number of curves that describes the dependency of the motion of a Slave Axis with respect to the Master Axis. More...
 
NXOpen::Mechatronics::GraphControlBuilder::EndAction GraphEndAction ()
 Returns the graph end action. More...
 
NXOpen::ExpressionInitialTime ()
 Returns the initial offset. More...
 
NXOpen::Mechatronics::GraphControlBuilder::MasterJointType MasterAxisType ()
 Returns the master axis type
Created in NX9.0.0. More...
 
NXOpen::Mechatronics::GraphControlBuilder::MasterType MasterBaseType ()
 Returns the master type
Created in NX11.0.0. More...
 
NXOpen::ExpressionMasterOffset ()
 Returns an offset that specifies from the master axis zero point relative to the path zero point for path interpolation. More...
 
NXOpen::ExpressionMasterScaleFactor ()
 Returns the transformation that is described between the normalized representation to the absolute values. More...
 
NXOpen::Mechatronics::GraphControlBuilder::MasterValueUnit MasterUnit ()
 Returns the master value unit
Created in NX9.0.0. More...
 
NXOpen::Mechatronics::MotionProfileMotionProfile ()
 Returns the motion profile. More...
 
NXOpen::Mechatronics::SelectPhysicsConstraintSelectAxisControl ()
 Returns the select axis control. More...
 
NXOpen::Mechatronics::SelectPhysicsJointSelectMasterJoint ()
 Returns the select axis joint. More...
 
NXOpen::Mechatronics::SelectAdapterSignalSelectMasterSignal ()
 Returns the select axis joint. More...
 
void SetCamProfile (NXOpen::Mechatronics::CamProfile *profile)
 Sets a cam profile that contains a number of curves that describes the dependency of the motion of a Slave Axis with respect to the Master Axis. More...
 
void SetGraphEndAction (NXOpen::Mechatronics::GraphControlBuilder::EndAction graphEndAction)
 Sets the graph end action. More...
 
void SetMasterAxisType (NXOpen::Mechatronics::GraphControlBuilder::MasterJointType type)
 Sets the master axis type
Created in NX9.0.0. More...
 
void SetMasterBaseType (NXOpen::Mechatronics::GraphControlBuilder::MasterType type)
 Sets the master type
Created in NX11.0.0. More...
 
void SetMasterUnit (NXOpen::Mechatronics::GraphControlBuilder::MasterValueUnit masterType)
 Sets the master value unit
Created in NX9.0.0. More...
 
void SetMotionProfile (NXOpen::Mechatronics::MotionProfile *profile)
 Sets the motion profile. More...
 
void SetSlaveUnit (NXOpen::Mechatronics::GraphControlBuilder::SlaveValueUnit slaveType)
 Sets the slave value unit
Created in NX9.0.0. More...
 
NXOpen::ExpressionSlaveOffset ()
 Returns an offset that specifies from the master slave zero point relative to the path zero point for path interpolation. More...
 
NXOpen::ExpressionSlaveScaleFactor ()
 Returns the transformation that is described between the normalized representation to the absolute values. More...
 
NXOpen::Mechatronics::GraphControlBuilder::SlaveValueUnit SlaveUnit ()
 Returns the slave value unit
Created in NX9.0.0. More...
 
NXOpen::ExpressionValueOffset ()
 Returns the value offset. More...
 
- Public Member Functions inherited from NXOpen::Mechatronics::PhysicsConstraintBuilder
NXString Name ()
 Returns the name. More...
 
void SetName (const NXString &name)
 Sets the name. More...
 
void SetName (const char *name)
 Sets the name. 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::Mechatronics::GraphControl builder
To create a new instance of this class, use NXOpen::Mechatronics::GraphControlCollection::CreateGraphControlBuilder

Created in NX8.0.0.


Member Enumeration Documentation

the action in the end of graph.

Enumerator
EndActionRestartfromBeginning 

restart from the beginning of graph.

EndActionDeactivateGraphControl 

deactivate this graph control.

the Master axis types.

Enumerator
MasterJointTypeLinear 

Linear.

MasterJointTypeRotary 

Rotary.

the Master types.

Enumerator
MasterTypeTime 

Time.

MasterTypeAxis 

Axis.

MasterTypeSignal 

Signal.

the Master Unit types.

Enumerator
MasterValueUnitLinear 

Linear.

MasterValueUnitRotary 

Rotary.

MasterValueUnitTime 

Time.

the Slave Unit types.

Enumerator
SlaveValueUnitLinearPosition 

Linear Position.

SlaveValueUnitRotaryPosition 

Rotary Position.

SlaveValueUnitLinearSpeed 

Linear Speed.

SlaveValueUnitRotarySpeed 

Rotary Speed.

Member Function Documentation

NXOpen::Mechatronics::CamProfile* NXOpen::Mechatronics::GraphControlBuilder::CamProfile ( )

Returns a cam profile that contains a number of curves that describes the dependency of the motion of a Slave Axis with respect to the Master Axis.

This can be NXOpen::Mechatronics::CamProfile .


Created in NX9.0.0.

License requirements : None

NXOpen::Mechatronics::GraphControlBuilder::EndAction NXOpen::Mechatronics::GraphControlBuilder::GraphEndAction ( )

Returns the graph end action.


Created in NX8.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

NXOpen::Expression* NXOpen::Mechatronics::GraphControlBuilder::InitialTime ( )

Returns the initial offset.


Created in NX8.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

NXOpen::Mechatronics::GraphControlBuilder::MasterJointType NXOpen::Mechatronics::GraphControlBuilder::MasterAxisType ( )

Returns the master axis type
Created in NX9.0.0.



License requirements : None

NXOpen::Mechatronics::GraphControlBuilder::MasterType NXOpen::Mechatronics::GraphControlBuilder::MasterBaseType ( )

Returns the master type
Created in NX11.0.0.



License requirements : None

NXOpen::Expression* NXOpen::Mechatronics::GraphControlBuilder::MasterOffset ( )

Returns an offset that specifies from the master axis zero point relative to the path zero point for path interpolation.


Created in NX9.0.0.

License requirements : None

NXOpen::Expression* NXOpen::Mechatronics::GraphControlBuilder::MasterScaleFactor ( )

Returns the transformation that is described between the normalized representation to the absolute values.

It applied to slave axis.
Created in NX9.0.0.

License requirements : None

NXOpen::Mechatronics::GraphControlBuilder::MasterValueUnit NXOpen::Mechatronics::GraphControlBuilder::MasterUnit ( )

Returns the master value unit
Created in NX9.0.0.



License requirements : None

NXOpen::Mechatronics::MotionProfile* NXOpen::Mechatronics::GraphControlBuilder::MotionProfile ( )

Returns the motion profile.

This can be NXOpen::Mechatronics::MotionProfile .
Created in NX8.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

NXOpen::Mechatronics::SelectPhysicsConstraint* NXOpen::Mechatronics::GraphControlBuilder::SelectAxisControl ( )

Returns the select axis control.

This can be a NXOpen::Mechatronics::SpeedControl , NXOpen::Mechatronics::PositionControl .
Created in NX8.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

NXOpen::Mechatronics::SelectPhysicsJoint* NXOpen::Mechatronics::GraphControlBuilder::SelectMasterJoint ( )

Returns the select axis joint.

This can be a * NXOpen::Mechatronics::HingeJoint , NXOpen::Mechatronics::SlidingJoint , NXOpen::Mechatronics::CylindricalJoint .
Created in NX9.0.0.

License requirements : None

NXOpen::Mechatronics::SelectAdapterSignal* NXOpen::Mechatronics::GraphControlBuilder::SelectMasterSignal ( )

Returns the select axis joint.

This can be a * NXOpen::Mechatronics::AdapterSignal .
Created in NX10.0.0.

License requirements : None

void NXOpen::Mechatronics::GraphControlBuilder::SetCamProfile ( NXOpen::Mechatronics::CamProfile profile)

Sets a cam profile that contains a number of curves that describes the dependency of the motion of a Slave Axis with respect to the Master Axis.

This can be NXOpen::Mechatronics::CamProfile .


Created in NX9.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
profileprofile
void NXOpen::Mechatronics::GraphControlBuilder::SetGraphEndAction ( NXOpen::Mechatronics::GraphControlBuilder::EndAction  graphEndAction)

Sets the graph end action.


Created in NX8.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
graphEndActiongraphendaction
void NXOpen::Mechatronics::GraphControlBuilder::SetMasterAxisType ( NXOpen::Mechatronics::GraphControlBuilder::MasterJointType  type)

Sets the master axis type
Created in NX9.0.0.



License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
typetype
void NXOpen::Mechatronics::GraphControlBuilder::SetMasterBaseType ( NXOpen::Mechatronics::GraphControlBuilder::MasterType  type)

Sets the master type
Created in NX11.0.0.



License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
typetype
void NXOpen::Mechatronics::GraphControlBuilder::SetMasterUnit ( NXOpen::Mechatronics::GraphControlBuilder::MasterValueUnit  masterType)

Sets the master value unit
Created in NX9.0.0.



License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
masterTypemastertype
void NXOpen::Mechatronics::GraphControlBuilder::SetMotionProfile ( NXOpen::Mechatronics::MotionProfile profile)

Sets the motion profile.

This can be NXOpen::Mechatronics::MotionProfile .
Created in NX8.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
profileprofile
void NXOpen::Mechatronics::GraphControlBuilder::SetSlaveUnit ( NXOpen::Mechatronics::GraphControlBuilder::SlaveValueUnit  slaveType)

Sets the slave value unit
Created in NX9.0.0.



License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
slaveTypeslavetype
NXOpen::Expression* NXOpen::Mechatronics::GraphControlBuilder::SlaveOffset ( )

Returns an offset that specifies from the master slave zero point relative to the path zero point for path interpolation.


Created in NX9.0.0.

License requirements : None

NXOpen::Expression* NXOpen::Mechatronics::GraphControlBuilder::SlaveScaleFactor ( )

Returns the transformation that is described between the normalized representation to the absolute values.

It applied to slave axis.
Created in NX9.0.0.

License requirements : None

NXOpen::Mechatronics::GraphControlBuilder::SlaveValueUnit NXOpen::Mechatronics::GraphControlBuilder::SlaveUnit ( )

Returns the slave value unit
Created in NX9.0.0.



License requirements : None

NXOpen::Expression* NXOpen::Mechatronics::GraphControlBuilder::ValueOffset ( )

Returns the value offset.


Created in NX8.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")


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