LogicObjectBuilder Class¶
-
class
NXOpen.Mechatronics.
LogicObjectBuilder
¶ Bases:
NXOpen.Mechatronics.SystemObjectBuilder
Represents a
NXOpen.Mechatronics.LogicObject
builderTo create a new instance of this class, use
NXOpen.Mechatronics.LogicObjectCollection.CreateLogicObjectBuilder
New in version NX8.5.0.
Properties¶
Property | Description |
---|---|
Aspect | Returns or sets the Aspect. |
InstanceName | Returns or sets the name of instance. |
LetterDescription | Returns or sets the letter description. |
LetterName | Returns or sets the letter name. |
Modified | Returns or sets the modified status. |
NavigatorObject | Returns the navigator object which holds the teamcenter attributes. |
ObjectInformation | Returns the object information builder, used to specify the information of logic object. |
Parent | Returns or sets the parent object. |
Tag | Returns the Tag for this object. |
TypeName | Returns or sets the Type Name used for. |
Methods¶
Method | Description |
---|---|
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. |
GetObject | Returns the object currently being edited by this builder. |
GetParameterData | Gets the parameter data. |
SetParameterData | Sets the parameter data. |
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. |
Structs¶
LogicObjectBuilderParameterData_Struct Struct | Defined Parameter Data Structure |
Property Detail¶
Aspect¶
-
LogicObjectBuilder.
Aspect
¶ Returns or sets the Aspect.
-------------------------------------
Getter Method
Signature
Aspect()
Returns: aspect Return type: str New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Aspect(aspect)
Parameters: aspect (str) – aspect New in version NX9.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
LetterDescription¶
-
LogicObjectBuilder.
LetterDescription
¶ Returns or sets the letter description.
-------------------------------------
Getter Method
Signature
LetterDescription()
Returns: Letter Description Return type: str New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
LetterDescription(letterDescription)
Parameters: letterDescription (str) – Letter Description New in version NX8.5.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
LetterName¶
-
LogicObjectBuilder.
LetterName
¶ Returns or sets the letter name.
-------------------------------------
Getter Method
Signature
LetterName()
Returns: Letter name Return type: str New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
LetterName(letterName)
Parameters: letterName (str) – Letter name New in version NX8.5.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
Modified¶
-
LogicObjectBuilder.
Modified
¶ Returns or sets the modified status.
-------------------------------------
Getter Method
Signature
Modified()
Returns: Return type: bool New in version NX8.5.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
-------------------------------------
Setter Method
Signature
Modified(modified)
Parameters: modified (bool) – New in version NX8.5.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
ObjectInformation¶
-
LogicObjectBuilder.
ObjectInformation
¶ Returns the object information builder, used to specify the information of logic object.
-------------------------------------
Getter Method
Signature
ObjectInformation()
Returns: object information Builder Return type: NXOpen.Mechatronics.ObjectInformationBuilder
New in version NX8.5.0.
License requirements: None.
Parent¶
-
LogicObjectBuilder.
Parent
¶ Returns or sets the parent object.
-------------------------------------
Getter Method
Signature
Parent()
Returns: Parent object Return type: NXOpen.NXObject
New in version NX8.5.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
-------------------------------------
Setter Method
Signature
Parent(parent)
Parameters: parent ( NXOpen.NXObject
) – Parent objectNew in version NX8.5.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
TypeName¶
-
LogicObjectBuilder.
TypeName
¶ Returns or sets the Type Name used for.
-------------------------------------
Getter Method
Signature
TypeName()
Returns: type name Return type: str New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
TypeName(typeName)
Parameters: typeName (str) – type name New in version NX9.0.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
Method Detail¶
GetParameterData¶
-
LogicObjectBuilder.
GetParameterData
¶ Gets the parameter data.
Signature
GetParameterData()
Returns: Parameter data array Return type: list of NXOpen.Mechatronics.LogicObjectBuilderParameterData_Struct
New in version NX8.5.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
SetParameterData¶
-
LogicObjectBuilder.
SetParameterData
¶ Sets the parameter data.
Signature
SetParameterData(parameterData)
Parameters: parameterData (list of NXOpen.Mechatronics.LogicObjectBuilderParameterData_Struct
) – Parameter data arrayNew in version NX8.5.0.
License requirements: nx_mcd_core (“MECHATRONICS CONCEPT DESIGNER”)
Validate¶
-
LogicObjectBuilder.
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.