Rule Class

class NXOpen.VisualReporting.Rule

Bases: NXOpen.NXObject

A rule within a NXOpen.VisualReporting.VisualReport.

New in version NX7.0.0.

Properties

Property Description
ActiveClassifier Returns or sets the active NXOpen.VisualReporting.Classifier in this NXOpen.VisualReporting.Rule for a multiple properties report.
FilterCondition Returns or sets the filter NXOpen.VisualReporting.Condition from this NXOpen.VisualReporting.Rule.
IsOccurrence Returns whether this object is an occurrence or not.
JournalIdentifier Returns the identifier that would be recorded in a journal for this object.
Name Returns the custom name of the object.
OwningComponent Returns the owning component, if this object is an occurrence.
OwningPart Returns the owning part of this object
Prototype Returns the prototype of this object if it is an occurrence.
Tag Returns the Tag for this object.

Methods

Method Description
CreateAttributeIterator Create an attribute iterator
DeleteAllAttributesByType Deletes all attributes of a specific type.
DeleteAttributeByTypeAndTitle Deletes an attribute by type and title.
DeleteUserAttribute Deletes the first attribute encountered with the given Type, Title.
DeleteUserAttributes Deletes the attributes on the object, if any, that satisfy the given iterator
FindObject Finds the NXOpen.NXObject with the given identifier as recorded in a journal.
GetAttributeTitlesByType Gets all the attribute titles of a specific type.
GetBooleanUserAttribute Gets a boolean attribute by Title and array Index.
GetClassifiers Returns the NXOpen.VisualReporting.Classifier`s associated with this :py:class:`NXOpen.VisualReporting.Rule.
GetComputationalTimeUserAttribute Gets a time attribute by Title and array Index.
GetIntegerAttribute Gets an integer attribute by title.
GetIntegerUserAttribute Gets an integer attribute by Title and array Index.
GetIsSmartGroupDateEnabled The NXOpen.VisualReporting.ClassifierDateGroupMethodOption in this NXOpen.VisualReporting.Classifier in the NXOpen.VisualReporting.Rule will be determined by the overall date range of all reported objects.
GetNextUserAttribute Gets the next attribute encountered on the object, if any, that satisfies the given iterator.
GetPdmReferenceAttributeValue Gets the value of PDM Reference attribute for given object.
GetRealAttribute Gets a real attribute by title.
GetRealUserAttribute Gets a real attribute by Title and array Index.
GetReferenceAttribute Gets the reference string (not the calculated value) of a string attribute that uses a reference string.
GetStringAttribute Gets a string attribute value by title.
GetStringUserAttribute Gets a string attribute by Title and array Index.
GetTimeAttribute Gets a time attribute by title.
GetTimeUserAttribute Gets a time attribute by Title and array Index.
GetUserAttribute Gets the first attribute encountered on the object, if any, with a given Title, Type and array Index.
GetUserAttributeAsString Gets the first attribute encountered on the object, if any, with a given title, type and array index.
GetUserAttributeCount Gets the count of set attributes on the object, if any, that satisfy the given iterator.
GetUserAttributeLock Determine the lock of the given attribute.
GetUserAttributeSize Gets the size of the first attribute encountered on the object, if any, with a given Title and Type.
GetUserAttributeSourceObjects Returns an array of objects from which this object presents attributes.
GetUserAttributes Gets all the attributes that have been set on the given object, if any, that satisfy the given iterator.
GetUserAttributesAsStrings Gets all the attributes that have been set on the given object.
HasUserAttribute Determines if an attribute exists on the object, that satisfies the given iterator
Print Prints a representation of this object to the system log file.
SetAttribute Creates or modifies an integer attribute.
SetBooleanUserAttribute Creates or modifies a boolean attribute with the option to update or not.
SetIsSmartGroupDateEnabled The NXOpen.VisualReporting.ClassifierDateGroupMethodOption in this NXOpen.VisualReporting.Classifier in the NXOpen.VisualReporting.Rule will be determined by the overall date range of all reported objects.
SetName Sets the custom name of the object.
SetPdmReferenceAttribute Sets the value of PDM Reference attribute on the object.
SetReferenceAttribute Creates or modifies a string attribute which uses a reference string.
SetTimeAttribute Creates or modifies a time attribute.
SetTimeUserAttribute Creates or modifies a time attribute with the option to update or not.
SetUserAttribute Creates or modifies an attribute with the option to update or not.
SetUserAttributeLock Lock or unlock the given attribute.

Property Detail

ActiveClassifier

Rule.ActiveClassifier

Returns or sets the active NXOpen.VisualReporting.Classifier in this NXOpen.VisualReporting.Rule for a multiple properties report.

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

Getter Method

Signature ActiveClassifier

Returns:
Return type:NXOpen.VisualReporting.Classifier

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature ActiveClassifier

Parameters:activeClassifier (NXOpen.VisualReporting.Classifier) –

New in version NX8.0.0.

License requirements: nx_visual_reporting (“Visual Reporting”)

FilterCondition

Rule.FilterCondition

Returns or sets the filter NXOpen.VisualReporting.Condition from this NXOpen.VisualReporting.Rule.

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

Getter Method

Signature FilterCondition

Returns:
Return type:NXOpen.VisualReporting.Condition

New in version NX7.0.0.

License requirements: None.

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

Setter Method

Signature FilterCondition

Parameters:filterCondition (NXOpen.VisualReporting.Condition) –

New in version NX8.0.0.

License requirements: nx_visual_reporting (“Visual Reporting”)

IsOccurrence

Rule.IsOccurrence

Returns whether this object is an occurrence or not.

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

Getter Method

Signature IsOccurrence

Returns:This object is an occurrence
Return type:bool

New in version NX3.0.0.

License requirements: None.

JournalIdentifier

Rule.JournalIdentifier

Returns the identifier that would be recorded in a journal for this object.

This may not be the same across different releases of the software.

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

Getter Method

Signature JournalIdentifier

Returns:
Return type:str

New in version NX3.0.0.

License requirements: None.

Name

Rule.Name

Returns the custom name of the object.

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

Getter Method

Signature Name

Returns:
Return type:str

New in version NX3.0.0.

License requirements: None.

OwningComponent

Rule.OwningComponent

Returns the owning component, if this object is an occurrence.

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

Getter Method

Signature OwningComponent

Returns:
Return type:NXOpen.Assemblies.Component

New in version NX3.0.0.

License requirements: None.

OwningPart

Rule.OwningPart

Returns the owning part of this object

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

Getter Method

Signature OwningPart

Returns:The owning part of this object or null if it does not have an owner
Return type:NXOpen.BasePart

New in version NX3.0.0.

License requirements: None.

Prototype

Rule.Prototype

Returns the prototype of this object if it is an occurrence.

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

Getter Method

Signature Prototype

Returns:The prototype of this object or null if this object is not an occurrence
Return type:NXOpen.INXObject

New in version NX3.0.0.

License requirements: None.

Method Detail

FindObject

Rule.FindObject

Finds the NXOpen.NXObject with the given identifier as recorded in a journal.

An object may not return the same value as its JournalIdentifier in different versions of the software. However newer versions of the software should find the same object when FindObject is passed older versions of its journal identifier. In general, this method should not be used in handwritten code and exists to support record and playback of journals.

An exception will be thrown if no object can be found with the given journal identifier.

Signature FindObject(journalIdentifier)

Parameters:journalIdentifier (str) – Journal identifier of the object
Returns:
Return type:NXOpen.INXObject

New in version NX3.0.0.

License requirements: None.

GetClassifiers

Rule.GetClassifiers

Returns the NXOpen.VisualReporting.Classifier`s associated with this :py:class:`NXOpen.VisualReporting.Rule.

Signature GetClassifiers()

Returns:
Return type:list of NXOpen.VisualReporting.Classifier

New in version NX8.0.0.

License requirements: None.

GetIsSmartGroupDateEnabled

Rule.GetIsSmartGroupDateEnabled

The NXOpen.VisualReporting.ClassifierDateGroupMethodOption in this NXOpen.VisualReporting.Classifier in the NXOpen.VisualReporting.Rule will be determined by the overall date range of all reported objects.

For example, if the date range spans over 18 monthes, group by year will be used, otherwise if it is over 3 months, group by month will be used. If the date range is small, within 2 weeks, group by day will be used.

Only valid for a NXOpen.VisualReporting.Classifier whose NXOpen.VisualReporting.ClassifierGroupingMethodOption is NXOpen.VisualReporting.ClassifierGroupingMethodOption.Automatic or NXOpen.VisualReporting.ClassifierGroupingMethodOption.SemiAutomatic and the NXOpen.VisualReporting.PropertyDatatypeOption on the NXOpen.VisualReporting.Property is NXOpen.VisualReporting.PropertyDatatypeOption.Date.

Signature GetIsSmartGroupDateEnabled(classifier)

Parameters:classifier (NXOpen.VisualReporting.Classifier) –
Returns:
Return type:bool

New in version NX8.5.0.

License requirements: None.

Print

Rule.Print

Prints a representation of this object to the system log file.

Signature Print()

New in version NX3.0.0.

License requirements: None.

SetIsSmartGroupDateEnabled

Rule.SetIsSmartGroupDateEnabled

The NXOpen.VisualReporting.ClassifierDateGroupMethodOption in this NXOpen.VisualReporting.Classifier in the NXOpen.VisualReporting.Rule will be determined by the overall date range of all reported objects.

Signature SetIsSmartGroupDateEnabled(classifier, isSmartGroupDateEnabled)

Parameters:

New in version NX8.5.0.

License requirements: nx_visual_reporting (“Visual Reporting”)

SetName

Rule.SetName

Sets the custom name of the object.

NOTE: This method should not be used to edit a read-only object such as a Mirrored PMI object. If it is, the changes will be overridden when the part is updated.

Signature SetName(name)

Parameters:name (str) –

New in version NX3.0.0.

License requirements: None.