CamBuilder Class¶

class NXOpen.Mechatronics.CamBuilder¶

Bases: NXOpen.Mechatronics.CouplingBuilder

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

New in version NX7.5.1.

Properties¶

Property	Description
AddCamDiskToMasterJointOption	Returns or sets the add cam disk to master joint option.
AllowSlip	Returns or sets the coulping can slip or not.
CamDiskRefPoint	Returns or sets the cam disk reference point.
CamDiskType	Returns or sets the cam disk type.
CamProfile	Returns or sets the cam profile.
CreateCamDisk	Returns or sets the toggle of create cam disk.
ExtrudeLength	Returns the extrude length.
LayerSettings	Returns the layer setting builder
MasterAxisJoint	Returns the master axis joint.
MasterAxisType	Returns or sets the master axis type.
MasterOffset	Returns the master offset.
MasterScaleFactor	Returns the master scale factor.
MotionProfile	Returns or sets the motion profile.
Name	Returns or sets the name.
RefPointOption	Returns or sets the cam disk reference point option.
SlaveAxisJoint	Returns the slave axis joint.
SlaveAxisType	Returns or sets the slave axis type.
SlaveOffset	Returns the slave offset.
SlaveScaleFactor	Returns the slave scale factor.
Tag	Returns the Tag for this object.

Methods¶

Method	Description
AddCamDiskToMasterAxis	Add cam disk to master axis by ja
AddCurveFeature	Sets one curve feature
Commit	Commits any edits that have been applied to the builder.
Destroy	Deletes the builder, and cleans up any objects created by the builder.
GetCommittedObjects	For builders that create more than one object, this method returns the objects that are created by commit.
GetCurveFeatures	Returns the curve feature
GetExtrudeFeature	Returns the extrude feature
GetObject	Returns the object currently being edited by this builder.
SetCurveFeatures	Sets the curve features
SetExtrudeFeature	Sets the extrude feature
SetMasterAxisJoint	Sets the master axis.
SetSlaveAxisJoint	Sets the slave axis.
ShowResults	Updates the model to reflect the result of an edit to the model for all builders that support showing results.
Validate	Validate whether the inputs to the component are sufficient for commit to be called.

Enumerations¶

CamBuilderAddCamDiskToMasterOption Enumeration	Represents the option of add cam disk.
CamBuilderAxisJointType Enumeration	Represents the axis joint type.
CamBuilderCreateCamDiskType Enumeration	Represents the cam disk type.

Property Detail¶

AddCamDiskToMasterJointOption¶

CamBuilder.AddCamDiskToMasterJointOption¶

Returns or sets the add cam disk to master joint option.

-------------------------------------

Getter Method

Signature AddCamDiskToMasterJointOption

Returns:
Return type:	`NXOpen.Mechatronics.CamBuilderAddCamDiskToMasterOption`

New in version NX12.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

-------------------------------------

Setter Method

Signature AddCamDiskToMasterJointOption

Parameters:	addOption (`NXOpen.Mechatronics.CamBuilderAddCamDiskToMasterOption`) –

New in version NX12.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

CamDiskRefPoint¶

CamBuilder.CamDiskRefPoint¶

Returns or sets the cam disk reference point.

-------------------------------------

Getter Method

Signature CamDiskRefPoint

Returns:
Return type:	`NXOpen.Point`

New in version NX12.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

-------------------------------------

Setter Method

Signature CamDiskRefPoint

Parameters:	refPoint (`NXOpen.Point`) –

New in version NX12.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

CamDiskType¶

CamBuilder.CamDiskType¶

Returns or sets the cam disk type.

-------------------------------------

Getter Method

Signature CamDiskType

Returns:
Return type:	`NXOpen.Mechatronics.CamBuilderCreateCamDiskType`

New in version NX12.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

-------------------------------------

Setter Method

Signature CamDiskType

Parameters:	camDiskType (`NXOpen.Mechatronics.CamBuilderCreateCamDiskType`) –

New in version NX12.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

CamProfile¶

CamBuilder.CamProfile¶

Returns or sets the cam profile.

This can be NXOpen.Mechatronics.CamProfile.

-------------------------------------

Getter Method

Signature CamProfile

Returns:
Return type:	`NXOpen.Mechatronics.CamProfile`

New in version NX9.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

-------------------------------------

Setter Method

Signature CamProfile

Parameters:	profile (`NXOpen.Mechatronics.CamProfile`) –

New in version NX9.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

CreateCamDisk¶

CamBuilder.CreateCamDisk¶

Returns or sets the toggle of create cam disk.

-------------------------------------

Getter Method

Signature CreateCamDisk

Returns:
Return type:	bool

New in version NX12.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

-------------------------------------

Setter Method

Signature CreateCamDisk

Parameters:	createOption (bool) –

New in version NX12.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

ExtrudeLength¶

CamBuilder.ExtrudeLength¶

Returns the extrude length.

-------------------------------------

Getter Method

Signature ExtrudeLength

Returns:
Return type:	`NXOpen.Expression`

New in version NX12.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

LayerSettings¶

CamBuilder.LayerSettings¶

Returns the layer setting builder

-------------------------------------

Getter Method

Signature LayerSettings

Returns:
Return type:	`NXOpen.Display.LayerSettingsBuilder`

New in version NX12.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

MasterAxisType¶

CamBuilder.MasterAxisType¶

Returns or sets the master axis type.

-------------------------------------

Getter Method

Signature MasterAxisType

Returns:
Return type:	`NXOpen.Mechatronics.CamBuilderAxisJointType`

New in version NX7.5.1.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

-------------------------------------

Setter Method

Signature MasterAxisType

Parameters:	masterAxisType (`NXOpen.Mechatronics.CamBuilderAxisJointType`) –

New in version NX7.5.1.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

MasterOffset¶

CamBuilder.MasterOffset¶

Returns the master offset.

-------------------------------------

Getter Method

Signature MasterOffset

Returns:
Return type:	`NXOpen.Expression`

New in version NX7.5.1.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

MasterScaleFactor¶

CamBuilder.MasterScaleFactor¶

Returns the master scale factor.

-------------------------------------

Getter Method

Signature MasterScaleFactor

Returns:
Return type:	`NXOpen.Expression`

New in version NX9.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

MotionProfile¶

CamBuilder.MotionProfile¶

Returns or sets the motion profile.

This can be NXOpen.Mechatronics.MotionProfile.

-------------------------------------

Getter Method

Signature MotionProfile

Returns:
Return type:	`NXOpen.Mechatronics.MotionProfile`

New in version NX7.5.1.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

-------------------------------------

Setter Method

Signature MotionProfile

Parameters:	profile (`NXOpen.Mechatronics.MotionProfile`) –

New in version NX7.5.1.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

RefPointOption¶

CamBuilder.RefPointOption¶

Returns or sets the cam disk reference point option.

-------------------------------------

Getter Method

Signature RefPointOption

Returns:
Return type:	int

New in version NX12.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

-------------------------------------

Setter Method

Signature RefPointOption

Parameters:	refPointOption (int) –

New in version NX12.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

SlaveAxisType¶

CamBuilder.SlaveAxisType¶

Returns or sets the slave axis type.

-------------------------------------

Getter Method

Signature SlaveAxisType

Returns:
Return type:	`NXOpen.Mechatronics.CamBuilderAxisJointType`

New in version NX7.5.1.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

-------------------------------------

Setter Method

Signature SlaveAxisType

Parameters:	slaveAxisType (`NXOpen.Mechatronics.CamBuilderAxisJointType`) –

New in version NX7.5.1.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

SlaveOffset¶

CamBuilder.SlaveOffset¶

Returns the slave offset.

-------------------------------------

Getter Method

Signature SlaveOffset

Returns:
Return type:	`NXOpen.Expression`

New in version NX9.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

SlaveScaleFactor¶

CamBuilder.SlaveScaleFactor¶

Returns the slave scale factor.

-------------------------------------

Getter Method

Signature SlaveScaleFactor

Returns:
Return type:	`NXOpen.Expression`

New in version NX9.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

Method Detail¶

AddCamDiskToMasterAxis¶

CamBuilder.AddCamDiskToMasterAxis¶

Add cam disk to master axis by ja

Signature AddCamDiskToMasterAxis(update)

Parameters:	update (bool) –
Returns:
Return type:	bool

New in version NX12.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

AddCurveFeature¶

CamBuilder.AddCurveFeature¶

Sets one curve feature

Signature AddCurveFeature(curveFeature)

Parameters:	curveFeature (`NXOpen.Features.Feature`) –

New in version NX12.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

GetCurveFeatures¶

CamBuilder.GetCurveFeatures¶

Returns the curve feature

Signature GetCurveFeatures()

Returns:
Return type:	list of `NXOpen.Features.Feature`

New in version NX12.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

GetExtrudeFeature¶

CamBuilder.GetExtrudeFeature¶

Returns the extrude feature

Signature GetExtrudeFeature()

Returns:
Return type:	`NXOpen.Features.Feature`

New in version NX12.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

SetCurveFeatures¶

CamBuilder.SetCurveFeatures¶

Sets the curve features

Signature SetCurveFeatures(curveFeatures)

Parameters:	curveFeatures (list of `NXOpen.Features.Feature`) –

New in version NX12.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

SetExtrudeFeature¶

CamBuilder.SetExtrudeFeature¶

Sets the extrude feature

Signature SetExtrudeFeature(extrudeFeature)

Parameters:	extrudeFeature (`NXOpen.Features.Feature`) –

New in version NX12.0.0.

License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)

Validate¶

CamBuilder.Validate¶

Validate whether the inputs to the component are sufficient for commit to be called.

If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.

Signature Validate()

Returns:	Was self validation successful
Return type:	bool

New in version NX3.0.1.

License requirements: None.

CamBuilder Class¶

Properties¶

Methods¶

Enumerations¶

Property Detail¶

AddCamDiskToMasterJointOption¶

CamDiskRefPoint¶

CamDiskType¶

CamProfile¶

CreateCamDisk¶

ExtrudeLength¶

LayerSettings¶

MasterAxisType¶

MasterOffset¶

MasterScaleFactor¶

MotionProfile¶

RefPointOption¶

SlaveAxisType¶

SlaveOffset¶

SlaveScaleFactor¶

Method Detail¶

AddCamDiskToMasterAxis¶

AddCurveFeature¶

GetCurveFeatures¶

GetExtrudeFeature¶

SetCurveFeatures¶

SetExtrudeFeature¶

Validate¶

NXOpen Python API Reference

Navigation

Related Topics