Condition Class¶
-
class
NXOpen.VisualReporting.
Condition
¶ Bases:
NXOpen.NXObject
A Condition within a
NXOpen.VisualReporting.Rule
.New in version NX7.0.0.
Properties¶
Property | Description |
---|---|
Datatype | Returns the NXOpen.VisualReporting.PropertyDatatypeOption of this NXOpen.VisualReporting.Condition . |
Description | Returns or sets the description for this NXOpen.VisualReporting.Condition . |
HasUserSpecifiedValue | Returns or sets whether this NXOpen.VisualReporting.Condition requires user input. |
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. |
OperatorType | Returns or sets the NXOpen.VisualReporting.ConditionOperatorOption of this NXOpen.VisualReporting.Condition . |
OwningComponent | Returns the owning component, if this object is an occurrence. |
OwningPart | Returns the owning part of this object |
ParentCondition | Returns the parent condition of this NXOpen.VisualReporting.Condition . |
Property | Returns or sets the NXOpen.VisualReporting.Property of this NXOpen.VisualReporting.Condition . |
Prototype | Returns the prototype of this object if it is an occurrence. |
Tag | Returns the Tag for this object. |
Type | Returns the NXOpen.VisualReporting.ConditionTypeOption of this NXOpen.VisualReporting.Condition Note that this NXOpen.VisualReporting.Condition.Type cannot be modified. |
UserPrompt | Returns or sets the user prompt for this NXOpen.VisualReporting.Condition . |
Value | Returns or sets the value of this NXOpen.VisualReporting.Condition . |
Methods¶
Method | Description |
---|---|
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 encountered with the given Type with option to update or not. |
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. |
GetChildCondition | Return the specified child Condition from this NXOpen.VisualReporting.Condition @return |
GetChildConditions | Returns all the child Conditions in this NXOpen.VisualReporting.Condition @return |
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. |
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, of the given type. |
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. |
GetUserAttributesAsStrings | Gets all the attributes that have been set on the given object. |
HasUserAttribute | Determines if an attribute with the given Title, Type and array Index is present on the object Unset attributes will not be detected by this function, as its purpose is to test for the actual presence of the attribute on the object. |
IsChildCondition | Returns whether the given NXOpen.VisualReporting.Condition is an immediate child of this condition @return |
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. |
SetName | Sets the custom name of 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. |
Enumerations¶
ConditionOperatorOption Enumeration | Represents the possible operator type options. |
ConditionTypeOption Enumeration | Represents the possible type options for a NXOpen.VisualReporting.Condition . |
Property Detail¶
Datatype¶
-
Condition.
Datatype
¶ Returns the
NXOpen.VisualReporting.PropertyDatatypeOption
of thisNXOpen.VisualReporting.Condition
.The returned data type will never be
NXOpen.VisualReporting.PropertyDatatypeOption.Unknown
.Note that this
NXOpen.VisualReporting.Condition.Datatype
cannot be modified. Instead it is specified when creating thisNXOpen.VisualReporting.Condition
by using the appropriate function: -NXOpen.VisualReporting.VisualReportBuilder.CreateStringCondition
-NXOpen.VisualReporting.VisualReportBuilder.CreateIntegerCondition
-NXOpen.VisualReporting.VisualReportBuilder.CreateRealCondition
-NXOpen.VisualReporting.VisualReportBuilder.CreateBooleanCondition
Note that the
NXOpen.VisualReporting.Condition`s created using the following functions do not have :py:class:`NXOpen.VisualReporting.PropertyDatatypeOption`s and calling this function will cause an error for these: - :py:meth:`NXOpen.VisualReporting.VisualReportBuilder.CreateAndCondition
-NXOpen.VisualReporting.VisualReportBuilder.CreateOrCondition
-NXOpen.VisualReporting.VisualReportBuilder.CreateNotCondition
-------------------------------------
Getter Method
Signature
Datatype()
Returns: Return type: NXOpen.VisualReporting.PropertyDatatypeOption
New in version NX7.0.0.
License requirements: None.
Description¶
-
Condition.
Description
¶ Returns or sets the description for this
NXOpen.VisualReporting.Condition
.Only valid for a
NXOpen.VisualReporting.Condition
whoseNXOpen.VisualReporting.Condition.Type
isNXOpen.VisualReporting.ConditionTypeOption.ValueCondition
-------------------------------------
Getter Method
Signature
Description()
Returns: Return type: str New in version NX7.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Description(description)
Parameters: description (str) – New in version NX8.0.0.
License requirements: nx_visual_reporting (“Visual Reporting”)
HasUserSpecifiedValue¶
-
Condition.
HasUserSpecifiedValue
¶ Returns or sets whether this
NXOpen.VisualReporting.Condition
requires user input.Only valid for a
NXOpen.VisualReporting.Condition
whoseNXOpen.VisualReporting.Condition.Type
isNXOpen.VisualReporting.ConditionTypeOption.ValueCondition
-------------------------------------
Getter Method
Signature
HasUserSpecifiedValue()
Returns: Return type: bool New in version NX7.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
HasUserSpecifiedValue(isUserSpecified)
Parameters: isUserSpecified (bool) – New in version NX8.0.0.
License requirements: nx_visual_reporting (“Visual Reporting”)
IsOccurrence¶
-
Condition.
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¶
-
Condition.
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¶
-
Condition.
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.
OperatorType¶
-
Condition.
OperatorType
¶ Returns or sets the
NXOpen.VisualReporting.ConditionOperatorOption
of thisNXOpen.VisualReporting.Condition
.Only valid for a
NXOpen.VisualReporting.Condition
whoseNXOpen.VisualReporting.Condition.Type
isNXOpen.VisualReporting.ConditionTypeOption.ValueCondition
-------------------------------------
Getter Method
Signature
OperatorType()
Returns: Return type: NXOpen.VisualReporting.ConditionOperatorOption
New in version NX7.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
OperatorType(operatorType)
Parameters: operatorType ( NXOpen.VisualReporting.ConditionOperatorOption
) –New in version NX8.0.0.
License requirements: nx_visual_reporting (“Visual Reporting”)
OwningComponent¶
-
Condition.
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¶
-
Condition.
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.
ParentCondition¶
-
Condition.
ParentCondition
¶ Returns the parent condition of this
NXOpen.VisualReporting.Condition
.If this condition has no parent or if the parent isn’t a condition then this returns None.
Note that this
NXOpen.VisualReporting.Condition.ParentCondition
cannot be modified. Instead it is determined when inserting thisNXOpen.VisualReporting.Condition
in theNXOpen.VisualReporting.Rule
by using the appropriate function: -NXOpen.VisualReporting.VisualReportBuilder.SetFilterConditionOfRule
-NXOpen.VisualReporting.VisualReportBuilder.AddChildToCondition
-------------------------------------
Getter Method
Signature
ParentCondition()
Returns: Return type: NXOpen.VisualReporting.Condition
New in version NX7.0.0.
License requirements: None.
Property¶
-
Condition.
Property
¶ Returns or sets the
NXOpen.VisualReporting.Property
of thisNXOpen.VisualReporting.Condition
.If the
NXOpen.VisualReporting.Property
is set to None, then it is deleted. Only valid for aNXOpen.VisualReporting.Condition
whoseNXOpen.VisualReporting.Condition.Type
isNXOpen.VisualReporting.ConditionTypeOption.ValueCondition
-------------------------------------
Getter Method
Signature
Property()
Returns: Return type: NXOpen.VisualReporting.Property
New in version NX7.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Property(property)
Parameters: property ( NXOpen.VisualReporting.Property
) –New in version NX8.0.0.
License requirements: nx_visual_reporting (“Visual Reporting”)
Prototype¶
-
Condition.
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.
Type¶
-
Condition.
Type
¶ Returns the
NXOpen.VisualReporting.ConditionTypeOption
of thisNXOpen.VisualReporting.Condition
Note that this
NXOpen.VisualReporting.Condition.Type
cannot be modified.Instead it is determined when creating this
NXOpen.VisualReporting.Condition
by using the appropriate function: -NXOpen.VisualReporting.VisualReportBuilder.CreateStringCondition
-NXOpen.VisualReporting.VisualReportBuilder.CreateIntegerCondition
-NXOpen.VisualReporting.VisualReportBuilder.CreateRealCondition
-NXOpen.VisualReporting.VisualReportBuilder.CreateBooleanCondition
-NXOpen.VisualReporting.VisualReportBuilder.CreateAndCondition
-NXOpen.VisualReporting.VisualReportBuilder.CreateOrCondition
-NXOpen.VisualReporting.VisualReportBuilder.CreateNotCondition
-------------------------------------
Getter Method
Signature
Type()
Returns: Return type: NXOpen.VisualReporting.ConditionTypeOption
New in version NX7.0.0.
License requirements: None.
UserPrompt¶
-
Condition.
UserPrompt
¶ Returns or sets the user prompt for this
NXOpen.VisualReporting.Condition
.Only useful for a condition where
NXOpen.VisualReporting.Condition.HasUserSpecifiedValue
is true. Only valid for aNXOpen.VisualReporting.Condition
whoseNXOpen.VisualReporting.Condition.Type
isNXOpen.VisualReporting.ConditionTypeOption.ValueCondition
-------------------------------------
Getter Method
Signature
UserPrompt()
Returns: Return type: str New in version NX7.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
UserPrompt(userPrompt)
Parameters: userPrompt (str) – New in version NX8.0.0.
License requirements: nx_visual_reporting (“Visual Reporting”)
Value¶
-
Condition.
Value
¶ Returns or sets the value of this
NXOpen.VisualReporting.Condition
.Only valid for a
NXOpen.VisualReporting.Condition
whoseNXOpen.VisualReporting.Condition.Type
isNXOpen.VisualReporting.ConditionTypeOption.ValueCondition
-------------------------------------
Getter Method
Signature
Value()
Returns: Return type: str New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Value(conditionValue)
Parameters: conditionValue (str) – New in version NX8.0.0.
License requirements: nx_visual_reporting (“Visual Reporting”)
Method Detail¶
FindObject¶
-
Condition.
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.
GetChildCondition¶
-
Condition.
GetChildCondition
¶ Return the specified child Condition from this
NXOpen.VisualReporting.Condition
Signature
GetChildCondition(index)
Parameters: index (int) – The index of the returned Condition. Returns: Return type: NXOpen.VisualReporting.Condition
New in version NX7.0.0.
License requirements: None.
GetChildConditions¶
-
Condition.
GetChildConditions
¶ Returns all the child Conditions in this
NXOpen.VisualReporting.Condition
Signature
GetChildConditions()
Returns: Return type: list of NXOpen.VisualReporting.Condition
New in version NX7.0.0.
License requirements: None.
IsChildCondition¶
-
Condition.
IsChildCondition
¶ Returns whether the given
NXOpen.VisualReporting.Condition
is an immediate child of this conditionSignature
IsChildCondition(childCondition)
Parameters: childCondition ( NXOpen.VisualReporting.Condition
) – The possible child ConditionReturns: Return type: bool New in version NX7.0.0.
License requirements: None.
Print¶
-
Condition.
Print
¶ Prints a representation of this object to the system log file.
Signature
Print()
New in version NX3.0.0.
License requirements: None.
SetName¶
-
Condition.
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.