CamProfileBuilder Class¶
-
class
NXOpen.Mechatronics.
CamProfileBuilder
¶ Bases:
NXOpen.Builder
Represents a
NXOpen.Mechatronics.CamProfile
builder.To create a new instance of this class, use
NXOpen.Mechatronics.CamProfileCollection.CreateCamProfileBuilder
New in version NX9.0.0.
Properties¶
Property | Description |
---|---|
CheckingG2Continuity | Returns or sets the indicator that a cam profile should check G2 continuous or not |
CyclicType | Returns or sets the cyclic type of a cam profile |
IsForElecCam | Returns or sets the indicator that a cam profile is designed for a electronic cam |
MasterMaximum | Returns the maximum master value |
MasterMinimum | Returns the minimum master value |
MasterUnit | Returns or sets the type of master joint |
Name | Returns or sets the cam profile name |
SlaveMaximum | Returns the maximum slave value. |
SlaveMinimum | Returns the minimum slave |
SlaveUnit | Returns or sets the type of slave joint or slave controller |
Tag | Returns the Tag for this object. |
Methods¶
Method | Description |
---|---|
AddElement | Add element to builder. |
AskElementByIndex | Ask segment element. |
AskElementsLength | Ask segments length. |
ClearElements | Clear elements . |
Commit | Commits any edits that have been applied to the builder. |
Destroy | Deletes the builder, and cleans up any objects created by the builder. |
EditElement | Edit the specific element of builder. |
FindElementIndex | Find the element index. |
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit. |
GetObject | Returns the object currently being edited by this builder. |
RemoveElementByIndex | Remove element by index. |
SetSegmentTable | Set segment table. |
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¶
CamProfileBuilderMasterValueUnit Enumeration | The master value unit indicates which type master joint is. |
CamProfileBuilderProfileCyclicType Enumeration | Indicates which cyclic type should be take. |
CamProfileBuilderSlaveValueUnit Enumeration | The master value unit indicates which type master joint is. |
Structs¶
CamProfileBuilderElement_Struct Struct | Contains segment information of a motion segment |
Property Detail¶
CheckingG2Continuity¶
-
CamProfileBuilder.
CheckingG2Continuity
¶ Returns or sets the indicator that a cam profile should check G2 continuous or not
-------------------------------------
Getter Method
Signature
CheckingG2Continuity()
Returns: Return type: bool New in version NX10.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
-------------------------------------
Setter Method
Signature
CheckingG2Continuity(checking)
Parameters: checking (bool) – New in version NX10.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
CyclicType¶
-
CamProfileBuilder.
CyclicType
¶ Returns or sets the cyclic type of a cam profile
-------------------------------------
Getter Method
Signature
CyclicType()
Returns: Return type: NXOpen.Mechatronics.CamProfileBuilderProfileCyclicType
New in version NX9.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
-------------------------------------
Setter Method
Signature
CyclicType(cyclicType)
Parameters: cyclicType ( NXOpen.Mechatronics.CamProfileBuilderProfileCyclicType
) –New in version NX9.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
IsForElecCam¶
-
CamProfileBuilder.
IsForElecCam
¶ Returns or sets the indicator that a cam profile is designed for a electronic cam
-------------------------------------
Getter Method
Signature
IsForElecCam()
Returns: Return type: bool New in version NX9.0.0.
Deprecated since version NX10.0.0: Set the boolean using
Mechatronics.CamProfileBuilder.CheckingG2Continuity
to query or edit it.License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
-------------------------------------
Setter Method
Signature
IsForElecCam(isForElecCam)
Parameters: isForElecCam (bool) – New in version NX9.0.0.
Deprecated since version NX10.0.0: Set the boolean using
Mechatronics.CamProfileBuilder.CheckingG2Continuity
to query or edit it.License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
MasterMaximum¶
-
CamProfileBuilder.
MasterMaximum
¶ Returns the maximum master value
-------------------------------------
Getter Method
Signature
MasterMaximum()
Returns: Return type: NXOpen.Expression
New in version NX9.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
MasterMinimum¶
-
CamProfileBuilder.
MasterMinimum
¶ Returns the minimum master value
-------------------------------------
Getter Method
Signature
MasterMinimum()
Returns: Return type: NXOpen.Expression
New in version NX9.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
MasterUnit¶
-
CamProfileBuilder.
MasterUnit
¶ Returns or sets the type of master joint
-------------------------------------
Getter Method
Signature
MasterUnit()
Returns: Return type: NXOpen.Mechatronics.CamProfileBuilderMasterValueUnit
New in version NX9.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
-------------------------------------
Setter Method
Signature
MasterUnit(masterUnit)
Parameters: masterUnit ( NXOpen.Mechatronics.CamProfileBuilderMasterValueUnit
) –New in version NX9.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
Name¶
-
CamProfileBuilder.
Name
¶ Returns or sets the cam profile name
-------------------------------------
Getter Method
Signature
Name()
Returns: Return type: str New in version NX9.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
-------------------------------------
Setter Method
Signature
Name(name)
Parameters: name (str) – New in version NX9.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
SlaveMaximum¶
-
CamProfileBuilder.
SlaveMaximum
¶ Returns the maximum slave value.
-------------------------------------
Getter Method
Signature
SlaveMaximum()
Returns: Return type: NXOpen.Expression
New in version NX9.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
SlaveMinimum¶
-
CamProfileBuilder.
SlaveMinimum
¶ Returns the minimum slave
-------------------------------------
Getter Method
Signature
SlaveMinimum()
Returns: Return type: NXOpen.Expression
New in version NX9.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
SlaveUnit¶
-
CamProfileBuilder.
SlaveUnit
¶ Returns or sets the type of slave joint or slave controller
-------------------------------------
Getter Method
Signature
SlaveUnit()
Returns: Return type: NXOpen.Mechatronics.CamProfileBuilderSlaveValueUnit
New in version NX9.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
-------------------------------------
Setter Method
Signature
SlaveUnit(slaveUnit)
Parameters: slaveUnit ( NXOpen.Mechatronics.CamProfileBuilderSlaveValueUnit
) –New in version NX9.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
Method Detail¶
AddElement¶
-
CamProfileBuilder.
AddElement
¶ Add element to builder.
Signature
AddElement(part, element)
Parameters: - part (
NXOpen.NXObject
) – - element (
NXOpen.Mechatronics.CamProfileBuilderElement_Struct
) –
New in version NX9.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
- part (
AskElementByIndex¶
-
CamProfileBuilder.
AskElementByIndex
¶ Ask segment element.
Signature
AskElementByIndex(index)
Parameters: index (int) – Returns: Return type: NXOpen.Mechatronics.CamProfileBuilderElement_Struct
New in version NX10.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
AskElementsLength¶
-
CamProfileBuilder.
AskElementsLength
¶ Ask segments length.
Signature
AskElementsLength()
Returns: Return type: int New in version NX10.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
ClearElements¶
-
CamProfileBuilder.
ClearElements
¶ Clear elements .
Signature
ClearElements()
New in version NX9.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
EditElement¶
-
CamProfileBuilder.
EditElement
¶ Edit the specific element of builder.
Signature
EditElement(index, part, element)
Parameters: - index (int) – The element index
- part (
NXOpen.NXObject
) – - element (
NXOpen.Mechatronics.CamProfileBuilderElement_Struct
) –
New in version NX9.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
FindElementIndex¶
-
CamProfileBuilder.
FindElementIndex
¶ Find the element index.
Signature
FindElementIndex(element)
Parameters: element ( NXOpen.Mechatronics.CamProfileBuilderElement_Struct
) –Returns: Return type: int New in version NX9.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
RemoveElementByIndex¶
-
CamProfileBuilder.
RemoveElementByIndex
¶ Remove element by index.
Signature
RemoveElementByIndex(index)
Parameters: index (int) – New in version NX9.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
SetSegmentTable¶
-
CamProfileBuilder.
SetSegmentTable
¶ Set segment table.
Signature
SetSegmentTable(segmentTableObject)
Parameters: segmentTableObject ( NXOpen.Mechatronics.CamProfile
) –New in version NX9.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
Validate¶
-
CamProfileBuilder.
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.