FindInCollaborativeDesign Class¶
-
class
NXOpen.Assemblies.
FindInCollaborativeDesign
¶ Bases:
NXOpen.NXObject
FindInCollaborativeDesign is a searcher for performing simple searches in the context of a subset.
To get an instance of this object use
NXOpen.Assemblies.SubsetBuilder
New in version NX8.5.0.
Properties¶
Property | Description |
---|---|
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. |
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. |
GetNextUserAttribute | Gets the next attribute encountered on the object, if any, that satisfies the given iterator. |
GetPartitions | Retrieve the :py:class:`NXOpen.Assemblies.Partition`s found in the last search. |
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. |
GetSearchResultElements | Retrieve the :py:class:`NXOpen.Assemblies.SearchResultElement`s found in the last search. |
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 |
PerformFind | Generate the search results according to the search text. |
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. |
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. |
Enumerations¶
FindInCollaborativeDesignObjectType Enumeration | The type of object for which the search is performed. |
FindInCollaborativeDesignSearchType Enumeration | The attribute against which the search text is matched. |
Property Detail¶
IsOccurrence¶
-
FindInCollaborativeDesign.
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¶
-
FindInCollaborativeDesign.
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¶
-
FindInCollaborativeDesign.
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¶
-
FindInCollaborativeDesign.
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¶
-
FindInCollaborativeDesign.
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¶
-
FindInCollaborativeDesign.
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¶
-
FindInCollaborativeDesign.
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.
GetPartitions¶
-
FindInCollaborativeDesign.
GetPartitions
¶ Retrieve the :py:class:`NXOpen.Assemblies.Partition`s found in the last search.
Signature
GetPartitions()
Returns: Return type: list of NXOpen.Assemblies.Partition
New in version NX8.5.0.
License requirements: nx_4gd_integration (“4th Generation Design”)
GetSearchResultElements¶
-
FindInCollaborativeDesign.
GetSearchResultElements
¶ Retrieve the :py:class:`NXOpen.Assemblies.SearchResultElement`s found in the last search.
Signature
GetSearchResultElements()
Returns: Return type: list of NXOpen.Assemblies.SearchResultElement
New in version NX8.5.0.
License requirements: nx_4gd_integration (“4th Generation Design”)
PerformFind¶
-
FindInCollaborativeDesign.
PerformFind
¶ Overloaded method PerformFind
PerformFind(objectType, searchType, searchText)
PerformFind(partition, objectType, searchType, searchText)
PerformFind(objectType, searchType, criteriaTitles, criteriaValues)
-------------------------------------
Generate the search results according to the search text.
Signature
PerformFind(objectType, searchType, searchText)
Parameters: - objectType (
NXOpen.Assemblies.FindInCollaborativeDesignObjectType
) – - searchType (
NXOpen.Assemblies.FindInCollaborativeDesignSearchType
) – - searchText (str) –
New in version NX8.5.0.
License requirements: nx_4gd_integration (“4th Generation Design”)
-------------------------------------
Generate the search results according to the search text, searching only within the partition.
Signature
PerformFind(partition, objectType, searchType, searchText)
Parameters: - partition (
NXOpen.Assemblies.Partition
) – - objectType (
NXOpen.Assemblies.FindInCollaborativeDesignObjectType
) – - searchType (
NXOpen.Assemblies.FindInCollaborativeDesignSearchType
) – - searchText (str) –
New in version NX8.5.0.
License requirements: nx_4gd_integration (“4th Generation Design”)
-------------------------------------
Generate the search results according to the search criteria of advance search. Advanced search takes in detailed inputs to perform the search. The parameters “criteriaTitles” and “criteriaValues” are the internal property names and their values to be searched. The attribute/value pairs are combined logically using AND so that only objects matching ALL of the specified criteria are returned. The method can only be used to search for matches on Teamcenter properties that are string valued. It does not work for properties which are Object/LOV valued. To see how to spell the “real” attribute names rather than the displayed attribute (column) names, use Edit-> Options…-> General-> UI-> Sys Admin-> Real Property Name in the Rich Client.
Signature
PerformFind(objectType, searchType, criteriaTitles, criteriaValues)
Parameters: - objectType (
NXOpen.Assemblies.FindInCollaborativeDesignObjectType
) – - searchType (
NXOpen.Assemblies.FindInCollaborativeDesignSearchType
) – - criteriaTitles (list of str) – The query criteria titles
- criteriaValues (list of str) – The query criteria values
New in version NX11.0.0.
License requirements: nx_4gd_integration (“4th Generation Design”)
-------------------------------------
Print¶
-
FindInCollaborativeDesign.
Print
¶ Prints a representation of this object to the system log file.
Signature
Print()
New in version NX3.0.0.
License requirements: None.
SetName¶
-
FindInCollaborativeDesign.
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.