CanonMRTestBuilder Class¶
-
class
NXOpen.Display.CanonMRTestBuilder¶ Bases:
NXOpen.BuilderSupports debug dialog DisplayUI::UICompCanonMRTest in testing DSS and CGP functions for the Canon MR display system.
To create a new instance of this class, use
NXOpen.DebugSession.CreateCanonMrtestBuilder()Default values.
Property Value CanonMRUpdating 0 ImageUsage None New in version NX7.5.2.
Properties¶
| Property | Description |
|---|---|
| CanonMRUpdating | Returns or sets the Canon MR updating state. |
| ImageFile | Returns or sets a JPEG file containing the image to be displayed as the background and/or foreground. |
| ImageUsage | Returns or sets a value that indicates how the image is specified to CGP. |
| SelectedObjects | Returns the selected objects for which the Canon MR mask attribute is to be enabled. |
| Tag | Returns the Tag for this object. |
Methods¶
| Method | Description |
|---|---|
| ClearMaskObjects | Disables the Canon MR mask attribute for all objects. |
| 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. |
| 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¶
| CanonMRTestBuilderImageUsageType Enumeration | Indicates how the image identified by ImageFile is specified to CGP. |
Property Detail¶
CanonMRUpdating¶
-
CanonMRTestBuilder.CanonMRUpdating¶ Returns or sets the Canon MR updating state.
When this state is enabled, automatic or implicit CGP display updating is disabled.
-------------------------------------Getter Method
Signature
CanonMRUpdatingReturns: Return type: bool New in version NX7.5.2.
License requirements: None.
-------------------------------------Setter Method
Signature
CanonMRUpdatingParameters: canonMRUpdating (bool) – New in version NX7.5.2.
License requirements: None.
ImageFile¶
-
CanonMRTestBuilder.ImageFile¶ Returns or sets a JPEG file containing the image to be displayed as the background and/or foreground.
-------------------------------------Getter Method
Signature
ImageFileReturns: Return type: str New in version NX7.5.2.
License requirements: None.
-------------------------------------Setter Method
Signature
ImageFileParameters: filename (str) – New in version NX7.5.2.
License requirements: None.
ImageUsage¶
-
CanonMRTestBuilder.ImageUsage¶ Returns or sets a value that indicates how the image is specified to CGP.
-------------------------------------Getter Method
Signature
ImageUsageReturns: Return type: NXOpen.Display.CanonMRTestBuilderImageUsageTypeNew in version NX7.5.2.
License requirements: None.
-------------------------------------Setter Method
Signature
ImageUsageParameters: imageUsage ( NXOpen.Display.CanonMRTestBuilderImageUsageType) –New in version NX7.5.2.
License requirements: None.
SelectedObjects¶
-
CanonMRTestBuilder.SelectedObjects¶ Returns the selected objects for which the Canon MR mask attribute is to be enabled.
-------------------------------------Getter Method
Signature
SelectedObjectsReturns: Return type: NXOpen.SelectNXObjectListNew in version NX7.5.2.
License requirements: None.
Method Detail¶
ClearMaskObjects¶
-
CanonMRTestBuilder.ClearMaskObjects¶ Disables the Canon MR mask attribute for all objects.
Signature
ClearMaskObjects()New in version NX7.5.2.
License requirements: None.
Validate¶
-
CanonMRTestBuilder.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.