'For loop' to exclude 'base component'
Hi @Mike_Y2. There are a few different possible ways to determine which referenced document is the 'original' one that the others are 'derived' from. One way would be to simply know that file's name, then check each document's file name to filter it out while iterating through them. If you used the Document.ReferencedDocuments collection instead of the Document.AllReferencedDocuments collection, that would only include 'directly' referenced documents, and not deeper referenced documents, but then you would have to use a 'recursive' routine for stepping down into the components within sub assemblies. If you do not want to have to include a hard-coded file name in your code anywhere, then we will have to dig deeper into some more complex stuff.
When we dig down into the properties of a part's PartComponentDefinition, we have the PartComponentDefinition.ReferenceComponents property, which returns a ReferenceComponents collection object. Since the 'make components' tool pretty much just derives parts of one part into another part, then at this point we would need to use the ReferenceComponents.DerivedPartComponents property to get its DerivedPartComponents collection object. This is where we could define & create new derived part components, if we wanted to, but will only need to iterate through its members. Each DerivedPartComponent object has the DerivedPartComponent.ReferencedDocumentDescriptor property, which returns a DocumentDescriptor. That object has the FullDocumentName property, but that does not always have the same value as the Document.FullFileName. The FullDocumentName will 'start' with the FullFileName value, but can then also include the 'member' name (for example, the iPart member name or ModelState member name) within "<" & ">" brackets. So, if you want to get a clean FullFileName, you may want to step further down into the DocumentDescriptor.ReferencedFileDescriptor property, which returns a FileDescriptor object. Then use its FileDescriptor.FullFileName property. Finally, you can store that value in a String type variable, or in a List(Of String) type variable, if there are multiple files like that which you have to keep in mind and avoid. Then when iterating through all referenced documents, you can check if the current referenced document's FullFileName equals the FullFileName of the derived parts' source file(s).
Wesley Crihfield
(Not an Autodesk Employee)
Hi @Mike_Y2
My recommendation is to loop through AllReferencedDocuments where the document is represented as an occurrence in the Assembly.
Example:
Dim oAsmDoc As AssemblyDocument = ThisDoc.Document
Dim oAsmDef As AssemblyComponentDefinition = oAsmDoc.ComponentDefinition
For Each oDoc As Document In oAsmDoc.AllReferencedDocuments.OfType(Of Document).Where(Function(x As Document) oAsmDef.Occurrences.AllReferencedOccurrences(x).Count > 0)
MsgBox(oDoc.FullDisplayName)
Next
Download my free Inventor Add-in – Hole Projector (compatible with Inventor 2021-2026.3)
Download the prerelease of Hole Projector for Inventor 2027
Here is one example code you can review and try out. I tried to include lots of 'comments' right within the code to explain what each line of code is attempting to do. I hope this helps some. I created a separate Function just for extracting the FullFileName(s) of any/all 'derived in' source files from any given Inventor Document. So, it iterates though all referenced documents one time just to collect those source file's FullFileNames to a collection, then you can iterate through them again to do what you want with each of them, while avoiding those source files.
Sub Main
Dim oDoc As Inventor.Document = ThisDoc.Document
'initialize the global variable for the collection of Strings
oDerivedInSourceFiles = New HashSet(Of String)
'get the collection of all referenced documents to a variable
Dim oRefDocs As Inventor.DocumentsEnumerator = oDoc.AllReferencedDocuments
'iterate through all referenced documents once to find all 'derived in source files'
For Each oRefDoc As Inventor.Document In oRefDocs
'this joins the ones returned from the custom Function into our main collection
oDerivedInSourceFiles.UnionWith(ExtractDerivedInPartSourceFiles(oRefDoc, oDerivedInSourceFiles))
Next 'oRefDoc
'now iterate through all referenced documents again, and do what you want
For Each oRefDoc As Inventor.Document In oRefDocs
'if this referenced document's FullFileName is in our collection,
'then it is a 'derived in source file', so skip over it
If oDerivedInSourceFiles.Contains(oRefDoc.FullFileName) Then Continue For
'<<< YOUR CODE HERE FOR WHAT YOU WANT TO DO WITH EACH REF DOC >>>
Next 'oRefDoc
End Sub
'variables declared between routines are 'global' (can be accessed by all routines)
'create a new collection of Strings, which does not maintain order, and does not allow duplicates
Dim oDerivedInSourceFiles As HashSet(Of String)
'this will try to extract any/all 'derived in' part component source file(s) FullFileName
'the Optional input/output HashSet can be used to add to an already existing HashSet
Function ExtractDerivedInPartSourceFiles(doc As Inventor.Document, _
Optional ByRef existingSet As HashSet(Of String) = Nothing) As HashSet(Of String)
'if this is not a 'Part', then this method is not intersted in it, so exit, and return Nothing
If Not TypeOf doc Is Inventor.PartDocument Then Return Nothing
'create a PartDocument type variable, and set this document as its value (enables recognition)
Dim oPDoc As Inventor.PartDocument = CType(doc, Inventor.PartDocument)
'get all of this part's 'derived in' part components
Dim oDPCs As DerivedPartComponents = oPDoc.ComponentDefinition.ReferenceComponents.DerivedPartComponents
'if there are none, then we are done here, exit routine, and return Nothing
If oDPCs.Count = 0 Then Return Nothing
'create a new collection of Strings, which does not maintain order, and does not allow duplicates
If existingSet Is Nothing Then existingSet = New HashSet(Of String)
For Each oDPC As DerivedPartComponent In oDPDc
'if it is no longer 'Linked' to the source file, then no useful info here
If Not oDPC.LinkedToFile Then Continue For
'if 'Link' is suppressed, then may not be able to access useful info here
If oDPC.SuppressLinkToFile Then Continue For
'get the DocumentDescriptor (describes native document reference)
Dim oDocDesc As DocumentDescriptor = oDPC.ReferencedDocumentDescriptor
'if missing, unresolved, suppressed, or disabled, then skip this one
If oDocDesc.ReferenceMissing OrElse oDocDesc.ReferenceSuppressed OrElse oDocDesc.ReferenceDisabled Then Continue For
'get the FileDescriptor (describes reference to a file)
Dim oFD As FileDescriptor = oDocDesc.ReferencedFileDescriptor
'if missing or disabled, then skip this one
If oFD.ReferenceMissing OrElse oFD.ReferenceDisabled Then Continue For
'add this File's FullFileName to our collection
existingSet.Add(oFD.FullFileName)
Next 'oDPC
'return that collection to the method that called this method to run
Return existingSet
End FunctionIf this solved your problem, or answered your question, please click ACCEPT SOLUTION .
Or, if this helped you, please click (LIKE or KUDOS) 👍.
Wesley Crihfield
(Not an Autodesk Employee)
Hi @Mike_Y2. If your primary intent is simply to skip over any/all referenced documents that there are not represented as components anywhere in your assembly, then yes, Jhoel Forshav's code seems very sufficient for that. My code is simply far more specific, and only looks for referenced documents that are the source parts that were derived into other parts in your assembly. If part of your goal was to isolate just those referenced documents or those files, to do something special with them, then my code example might have been a better choice. But it seems like your main intent here was simply to skip over them when iterating through all other referenced documents, which my code example could be seen as 'overkill' for that task. And yes, the error you mentioned was due to a typing mistake. "oDPDc" should have been "oDPCs", as defined the few lines of code above where that loop starts. I have used several different strategies over the years for skipping over referenced documents, referenced files, and assembly component occurrences, for one reason or another. Sometimes I get a bit overzealous 😁. But at least now you have both a working 'skip' method, and a 'code roadmap' of sorts, to where you can find those derived part source files. Good luck in your future Inventor automation endeavors.
Wesley Crihfield
(Not an Autodesk Employee)
That one is slightly more complicated to explain, but essentially it is possible that the custom method does not find any 'derived in' source part file FullFileNames, which may mean that that Function did not return anything. So, when it attempts to do the 'UnionWith' method to join that returned collection with the main collection, it does not allow that variable to represent 'Nothing' or an empty collection, therefore it throws an error. I obviously did not test this code before I posted it, because I had no use for it myself, and was apparently typing through it too fast, not paying attention to some of those types of details which would only show themselves when tested. So, since there were a couple of errors needing repairs so far, I decided it might be best if I simply posted an updated version of the code I posted above, even though it is not necessarily a 'solution' in this case, just for reference. I simplified the large custom Function by utilizing a Try...Catch...End Try statement. Since we are not yet providing any 'feedback' about when or why any of the 'checks' may have failed, and no one really cares in this case, it is sufficient to just skip over all that internal detail here, and still achieve usable functionality. I also included an extra check in the first loop of the 'Sub Main' area, to avoid the last error...at least that is what I assume caused it.
Sub Main
Dim oDoc As Inventor.Document = ThisDoc.Document
'create collection of Strings (duplicates not possible - does not maintain order)
Dim oDerivedInSourceFiles As HashSet(Of String) = New HashSet(Of String)
'get the collection of all referenced documents to a variable
Dim oRefDocs As Inventor.DocumentsEnumerator = oDoc.AllReferencedDocuments
'iterate through all referenced documents once to find all 'derived in source files'
For Each oRefDoc As Inventor.Document In oRefDocs
'if this is a part, which has any other parts derived into it,
'then get those source part files' FullFileNames
Dim oHS As HashSet(Of String) = ExtractDerivedInPartSourceFiles(oRefDoc)
'if any were found/returned, then add them to our main collection for use later
If (oHS IsNot Nothing) AndAlso (oHS.Count > 0) Then
'join this HashSet with the main HashSet
oDerivedInSourceFiles.UnionWith(oHS)
End If
Next 'oRefDoc
'now iterate through all referenced documents again, and do what you want
For Each oRefDoc As Inventor.Document In oRefDocs
'if this referenced document's FullFileName is in our collection,
'then it is a 'derived in source file', so skip over it
If oDerivedInSourceFiles.Contains(oRefDoc.FullFileName) Then Continue For
'<<< YOUR CODE HERE FOR WHAT YOU WANT TO DO WITH EACH REF DOC >>>
Next 'oRefDoc
End Sub
'this will try to extract any/all 'derived in' part component source file(s) FullFileName
Function ExtractDerivedInPartSourceFiles(doc As Inventor.Document) As HashSet(Of String)
'if this is not a 'Part', then this method is not intersted in it, so exit, and return Nothing
If Not TypeOf doc Is Inventor.PartDocument Then Return Nothing
'create a PartDocument type variable, and set this document as its value (enables recognition)
Dim oPDoc As Inventor.PartDocument = CType(doc, Inventor.PartDocument)
'create a new collection of Strings, which does not maintain order, and does not allow duplicates
Dim oHS As HashSet(Of String) = New HashSet(Of String)
'iterate through all 'derived in' part components (if any)
For Each oDPC As DerivedPartComponent In oPDoc.ComponentDefinition.ReferenceComponents.DerivedPartComponents
Try
'try to add its FullFileName into our collection of Strings
oHS.Add(oDPC.ReferencedDocumentDescriptor.ReferencedFileDescriptor.FullFileName)
Catch
End Try
Next 'oDPC
'return that collection to the method that called this method to run
Return oHS
End Function
Wesley Crihfield
(Not an Autodesk Employee)
