iLogic: Dokumententypen

Im vorherigen Post iLogic: Struktureller Aufbau konnte bereits Bekanntschaft mit zwei unterschiedlichen Dokumententypen gemacht werden: kAssemblyDocumentObject und kDrawingDocumentObject. Doch woher kommen diese Bezeichnungen und wie viele gibt es von ihnen? Dokumentiert sind diese Objekte auf der Autodesk Webseite zur Inventor API.

Documenttypes

Zur Auswahl und Abfrage stehen folgende DocumentTypes. Relevant für die tägliche Arbeit als Konstrukteur sind allerdings nur die ersten drei, nämlich Bauteil, Baugruppe und technische Zeichnung.

Dem geschulten Auge stellen sich sofort zwei Fragen:

• Wie unterscheide ich ein Standard-Bauteil von einem Blechbauteil?
• Wie unterscheide ich eine Standard-Baugruppe von einer Schweißbaugruppe?

Um diese Fragen zu beantworten, stellt die Inventor API ein Property namens DocumentSubType zur Verfügung.

DocumentSubTypes

Sämtliche zur Verfügung stehenden DocumentSubTypes sind auf der Autodesk Webseite gelistet. DocumentSubTypes werden mit Hilfe von GUIDs angegeben. Das steht für Global Unique Identitfier. Diese GUID ist eine Zeichenfolge vom Typ String, die stellvertretend für einen Dokumententyp steht.

Parts

Assemblies

Drawing

Design Element

Presentations

Design View Document

Codebeispiele

Im folgenden ein paar Beispiele, die sowohl den DocumentType abfragen, als auch die GUID nutzen.

Abfragen des DocumentTypes

Wer generell ermitteln möchte, ob es sich bei einem Dokument bspw. um ein Bauteil handelt, kann dies wie im vorangegangenen Post iLogic: Struktureller Aufbau beschrieben folgendermaßen erreichen:

Dim oDoc As Document = ThisDoc.Document

If oDoc.DocumentType = kPartDocumentObject Then
    MsgBox("Das geöffnete Dokument ist ein Bauteil.")
Else
    MsgBox("Das geöffnete Dokument ist kein Bauteil.")
End If

Alternativ kann auch explizit der DocumentTypeEnum bei der Abfrage verwendet werden. Das Ergebnis ist das selbe:

Dim oDoc As Document = ThisDoc.Document

If oDoc.DocumentType = DocumentTypeEnum.kPartDocumentObject Then
    MsgBox("Das geöffnete Dokument ist ein Bauteil.")
Else
    MsgBox("Das geöffnete Dokument ist kein Bauteil.")
End If

Faustformel: Möchte man lediglich grob Ermitteln, ob es sich bei einem Dokument bspw. um ein Bauteil, eine Baugruppe oder eine Zeichnung handelt, reicht eine Abfrage des DocumentType.

Abfragen des DocumentSubTypes

Faustformel: Möchte man eine spezifischere Abfrage tätigen, die nicht nur prüft ob es sich bei einem Dokument bspw. um ein Bauteil, sondern explizit um ein Blechtbauteil handelt, muss der DocumentSubType in Verbindung mit der GUID genutzt werden:

Dim oDoc as Document = ThisDoc.Document
Dim oSubType as String = oDoc.DocumentSubType.DocumentSubTypeID

If oSubType = "{9C464203-9BAE-11D3-8BAD-0060B0CE6BB4}" then
    MessageBox ("Das Bauteil ist ein Blechbauteil.")
Else 
    MessageBox ("Das Bauteil ist kein Blechbauteil.")
End if

Weitergedacht

Im vorherigen Post iLogic: Struktureller Aufbau wurden Funktionen und Subroutinen vorgestellt. Wer häufig eine Unterscheidung zwischen Standard-Bauteilen und Blechbauteilen oder zwischen Standard-Baugruppen und Schweißbaugruppen benötigt, kann eine solche Abfrage auch in einer Funktion abbilden und wiederverwenden. Diese kann dann wiederum mit der Abfrage des DocumentType kombiniert werden:

Sub Main()
    Dim oDoc As Document = ThisDoc.Document

    If oDoc.DocumentType = kPartDocumentObject Then
        If IsSheetMetal() Then
            MsgBox("Das Bauteil ist ein Blechbauteil")
        Else
            MsgBox("Das Bauteil ist zwar ein Bauteil, aber kein Blechbauteil.)
        End If
    End If
End Sub


Private Function IsSheetMetal() As Boolean
    If ThisDoc.Document.DocumentSubType.DocumentSubTypeID = "{9C464203-9BAE-11D3-8BAD-0060B0CE6BB4}" Then
        Return True
    Else 
        Return False
    End if
End Function