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

Represents a NXOpen::Mechatronics::Cam builder. More...

Inheritance diagram for NXOpen::Mechatronics::CamBuilder:
NXOpen::Mechatronics::CouplingBuilder NXOpen::Mechatronics::PhysicsConstraintBuilder NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  AddCamDiskToMasterOption { AddCamDiskToMasterOptionNone, AddCamDiskToMasterOptionEdit, AddCamDiskToMasterOptionReplace }
 Represents the option of add cam disk. More...
 
enum  AxisJointType { AxisJointTypeLinear, AxisJointTypeAngular }
 Represents the axis joint type. More...
 
enum  CreateCamDiskType { CreateCamDiskTypeCurve, CreateCamDiskTypeSolid }
 Represents the cam disk type. More...
 

Public Member Functions

bool AddCamDiskToMasterAxis (bool update)
 Add cam disk to master axis by ja. More...
 
NXOpen::Mechatronics::CamBuilder::AddCamDiskToMasterOption AddCamDiskToMasterJointOption ()
 Returns the add cam disk to master joint option. More...
 
void AddCurveFeature (NXOpen::Features::Feature *curveFeature)
 Sets one curve feature
Created in NX12.0.0. More...
 
NXOpen::PointCamDiskRefPoint ()
 Returns the cam disk reference point. More...
 
NXOpen::Mechatronics::CamBuilder::CreateCamDiskType CamDiskType ()
 Returns the cam disk type. More...
 
NXOpen::Mechatronics::CamProfileCamProfile ()
 Returns the cam profile. More...
 
bool CreateCamDisk ()
 Returns the toggle of create cam disk. More...
 
NXOpen::ExpressionExtrudeLength ()
 Returns the extrude length. More...
 
std::vector
< NXOpen::Features::Feature * > 
GetCurveFeatures ()
 Returns the curve feature. More...
 
NXOpen::Features::FeatureGetExtrudeFeature ()
 Returns the extrude feature. More...
 
NXOpen::Display::LayerSettingsBuilderLayerSettings ()
 Returns the layer setting builder
Created in NX12.0.0. More...
 
NXOpen::Mechatronics::CamBuilder::AxisJointType MasterAxisType ()
 Returns the master axis type. More...
 
NXOpen::ExpressionMasterOffset ()
 Returns the master offset. More...
 
NXOpen::ExpressionMasterScaleFactor ()
 Returns the master scale factor. More...
 
NXOpen::Mechatronics::MotionProfileMotionProfile ()
 Returns the motion profile. More...
 
int RefPointOption ()
 Returns the cam disk reference point option. More...
 
void SetAddCamDiskToMasterJointOption (NXOpen::Mechatronics::CamBuilder::AddCamDiskToMasterOption addOption)
 Sets the add cam disk to master joint option. More...
 
void SetCamDiskRefPoint (NXOpen::Point *refPoint)
 Sets the cam disk reference point. More...
 
void SetCamDiskType (NXOpen::Mechatronics::CamBuilder::CreateCamDiskType camDiskType)
 Sets the cam disk type. More...
 
void SetCamProfile (NXOpen::Mechatronics::CamProfile *profile)
 Sets the cam profile. More...
 
void SetCreateCamDisk (bool createOption)
 Sets the toggle of create cam disk. More...
 
void SetCurveFeatures (const std::vector< NXOpen::Features::Feature * > &curveFeatures)
 Sets the curve features
Created in NX12.0.0. More...
 
void SetExtrudeFeature (NXOpen::Features::Feature *extrudeFeature)
 Sets the extrude feature
Created in NX12.0.0. More...
 
void SetMasterAxisType (NXOpen::Mechatronics::CamBuilder::AxisJointType masterAxisType)
 Sets the master axis type. More...
 
void SetMotionProfile (NXOpen::Mechatronics::MotionProfile *profile)
 Sets the motion profile. More...
 
void SetRefPointOption (int refPointOption)
 Sets the cam disk reference point option. More...
 
void SetSlaveAxisType (NXOpen::Mechatronics::CamBuilder::AxisJointType slaveAxisType)
 Sets the slave axis type. More...
 
NXOpen::Mechatronics::CamBuilder::AxisJointType SlaveAxisType ()
 Returns the slave axis type. More...
 
NXOpen::ExpressionSlaveOffset ()
 Returns the slave offset. More...
 
NXOpen::ExpressionSlaveScaleFactor ()
 Returns the slave scale factor. More...
 
- Public Member Functions inherited from NXOpen::Mechatronics::CouplingBuilder
bool AllowSlip ()
 Returns the coulping can slip or not. More...
 
NXOpen::Mechatronics::SelectPhysicsJointMasterAxisJoint ()
 Returns the master axis joint. More...
 
void SetAllowSlip (bool allowSlip)
 Sets the coulping can slip or not. More...
 
void SetMasterAxisJoint (NXOpen::Mechatronics::PhysicsJoint *master)
 Sets the master axis. More...
 
void SetSlaveAxisJoint (NXOpen::Mechatronics::PhysicsJoint *slave)
 Sets the slave axis. More...
 
NXOpen::Mechatronics::SelectPhysicsJointSlaveAxisJoint ()
 Returns the slave axis joint. 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::Cam builder.


To create a new instance of this class, use NXOpen::Mechatronics::CamCollection::CreateCamBuilder
Default values.

Property Value

LayerSettings.LayerOption

Work


Created in NX7.5.1.

Member Enumeration Documentation

Represents the option of add cam disk.

Enumerator
AddCamDiskToMasterOptionNone 

None.

AddCamDiskToMasterOptionEdit 

Edit.

AddCamDiskToMasterOptionReplace 

Replace.

Represents the axis joint type.

Enumerator
AxisJointTypeLinear 

Linear.

AxisJointTypeAngular 

Angular.

Represents the cam disk type.

Enumerator
CreateCamDiskTypeCurve 

Curve.

CreateCamDiskTypeSolid 

Solid.

Member Function Documentation

bool NXOpen::Mechatronics::CamBuilder::AddCamDiskToMasterAxis ( bool  update)

Add cam disk to master axis by ja.

Returns

Created in NX12.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")
Parameters
updateupdate
NXOpen::Mechatronics::CamBuilder::AddCamDiskToMasterOption NXOpen::Mechatronics::CamBuilder::AddCamDiskToMasterJointOption ( )

Returns the add cam disk to master joint option.


Created in NX12.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

void NXOpen::Mechatronics::CamBuilder::AddCurveFeature ( NXOpen::Features::Feature curveFeature)

Sets one curve feature
Created in NX12.0.0.



License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
curveFeaturecurvefeature
NXOpen::Point* NXOpen::Mechatronics::CamBuilder::CamDiskRefPoint ( )

Returns the cam disk reference point.


Created in NX12.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

NXOpen::Mechatronics::CamBuilder::CreateCamDiskType NXOpen::Mechatronics::CamBuilder::CamDiskType ( )

Returns the cam disk type.


Created in NX12.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

NXOpen::Mechatronics::CamProfile* NXOpen::Mechatronics::CamBuilder::CamProfile ( )

Returns the cam profile.

This can be NXOpen::Mechatronics::CamProfile .
Created in NX9.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

bool NXOpen::Mechatronics::CamBuilder::CreateCamDisk ( )

Returns the toggle of create cam disk.


Created in NX12.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

NXOpen::Expression* NXOpen::Mechatronics::CamBuilder::ExtrudeLength ( )

Returns the extrude length.


Created in NX12.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

std::vector<NXOpen::Features::Feature *> NXOpen::Mechatronics::CamBuilder::GetCurveFeatures ( )

Returns the curve feature.

Returns

Created in NX12.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")
NXOpen::Features::Feature* NXOpen::Mechatronics::CamBuilder::GetExtrudeFeature ( )

Returns the extrude feature.

Returns

Created in NX12.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")
NXOpen::Display::LayerSettingsBuilder* NXOpen::Mechatronics::CamBuilder::LayerSettings ( )

Returns the layer setting builder
Created in NX12.0.0.



License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

NXOpen::Mechatronics::CamBuilder::AxisJointType NXOpen::Mechatronics::CamBuilder::MasterAxisType ( )

Returns the master axis type.


Created in NX7.5.1.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

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

Returns the master offset.


Created in NX7.5.1.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

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

Returns the master scale factor.


Created in NX9.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

NXOpen::Mechatronics::MotionProfile* NXOpen::Mechatronics::CamBuilder::MotionProfile ( )

Returns the motion profile.

This can be NXOpen::Mechatronics::MotionProfile .
Created in NX7.5.1.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

int NXOpen::Mechatronics::CamBuilder::RefPointOption ( )

Returns the cam disk reference point option.


Created in NX12.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

void NXOpen::Mechatronics::CamBuilder::SetAddCamDiskToMasterJointOption ( NXOpen::Mechatronics::CamBuilder::AddCamDiskToMasterOption  addOption)

Sets the add cam disk to master joint option.


Created in NX12.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
addOptionaddoption
void NXOpen::Mechatronics::CamBuilder::SetCamDiskRefPoint ( NXOpen::Point refPoint)

Sets the cam disk reference point.


Created in NX12.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
refPointref point
void NXOpen::Mechatronics::CamBuilder::SetCamDiskType ( NXOpen::Mechatronics::CamBuilder::CreateCamDiskType  camDiskType)

Sets the cam disk type.


Created in NX12.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
camDiskTypecamdisktype
void NXOpen::Mechatronics::CamBuilder::SetCamProfile ( NXOpen::Mechatronics::CamProfile profile)

Sets the cam profile.

This can be NXOpen::Mechatronics::CamProfile .
Created in NX9.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
profileprofile
void NXOpen::Mechatronics::CamBuilder::SetCreateCamDisk ( bool  createOption)

Sets the toggle of create cam disk.


Created in NX12.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
createOptioncreateoption
void NXOpen::Mechatronics::CamBuilder::SetCurveFeatures ( const std::vector< NXOpen::Features::Feature * > &  curveFeatures)

Sets the curve features
Created in NX12.0.0.



License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
curveFeaturescurvefeatures
void NXOpen::Mechatronics::CamBuilder::SetExtrudeFeature ( NXOpen::Features::Feature extrudeFeature)

Sets the extrude feature
Created in NX12.0.0.



License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
extrudeFeatureextrudefeature
void NXOpen::Mechatronics::CamBuilder::SetMasterAxisType ( NXOpen::Mechatronics::CamBuilder::AxisJointType  masterAxisType)

Sets the master axis type.


Created in NX7.5.1.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
masterAxisTypemasteraxistype
void NXOpen::Mechatronics::CamBuilder::SetMotionProfile ( NXOpen::Mechatronics::MotionProfile profile)

Sets the motion profile.

This can be NXOpen::Mechatronics::MotionProfile .
Created in NX7.5.1.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
profileprofile
void NXOpen::Mechatronics::CamBuilder::SetRefPointOption ( int  refPointOption)

Sets the cam disk reference point option.


Created in NX12.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
refPointOptionref point option
void NXOpen::Mechatronics::CamBuilder::SetSlaveAxisType ( NXOpen::Mechatronics::CamBuilder::AxisJointType  slaveAxisType)

Sets the slave axis type.


Created in NX7.5.1.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

Parameters
slaveAxisTypeslaveaxistype
NXOpen::Mechatronics::CamBuilder::AxisJointType NXOpen::Mechatronics::CamBuilder::SlaveAxisType ( )

Returns the slave axis type.


Created in NX7.5.1.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

NXOpen::Expression* NXOpen::Mechatronics::CamBuilder::SlaveOffset ( )

Returns the slave offset.


Created in NX9.0.0.

License requirements : nx_mcd_core ("MECHATRONICS CONCEPT DESIGNER")

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

Returns the slave scale factor.


Created in NX9.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.