COMOS. Platform Klassendokumentation RevisionMaster_dll. Klasse: RevisionInfo 1. Klasse: RevisionMaster 2. Programmierhandbuch

Transkript

1 Klasse: RevisionInfo 1 Klasse: RevisionMaster 2 COMOS Platform Klassendokumentation RevisionMaster_dll Programmierhandbuch 03/2017 V A5E AA

2 Rechtliche Hinweise Warnhinweiskonzept Dieses Handbuch enthält Hinweise, die Sie zu Ihrer persönlichen Sicherheit sowie zur Vermeidung von Sachschäden beachten müssen. Die Hinweise zu Ihrer persönlichen Sicherheit sind durch ein Warndreieck hervorgehoben, Hinweise zu alleinigen Sachschäden stehen ohne Warndreieck. Je nach Gefährdungsstufe werden die Warnhinweise in abnehmender Reihenfolge wie folgt dargestellt. GEFAHR bedeutet, dass Tod oder schwere Körperverletzung eintreten wird, wenn die entsprechenden Vorsichtsmaßnahmen nicht getroffen werden. WARNUNG bedeutet, dass Tod oder schwere Körperverletzung eintreten kann, wenn die entsprechenden Vorsichtsmaßnahmen nicht getroffen werden. VORSICHT bedeutet, dass eine leichte Körperverletzung eintreten kann, wenn die entsprechenden Vorsichtsmaßnahmen nicht getroffen werden. ACHTUNG bedeutet, dass Sachschaden eintreten kann, wenn die entsprechenden Vorsichtsmaßnahmen nicht getroffen werden. Beim Auftreten mehrerer Gefährdungsstufen wird immer der Warnhinweis zur jeweils höchsten Stufe verwendet. Wenn in einem Warnhinweis mit dem Warndreieck vor Personenschäden gewarnt wird, dann kann im selben Warnhinweis zusätzlich eine Warnung vor Sachschäden angefügt sein. Qualifiziertes Personal Das zu dieser Dokumentation zugehörige Produkt/System darf nur von für die jeweilige Aufgabenstellung qualifiziertem Personal gehandhabt werden unter Beachtung der für die jeweilige Aufgabenstellung zugehörigen Dokumentation, insbesondere der darin enthaltenen Sicherheits- und Warnhinweise. Qualifiziertes Personal ist auf Grund seiner Ausbildung und Erfahrung befähigt, im Umgang mit diesen Produkten/Systemen Risiken zu erkennen und mögliche Gefährdungen zu vermeiden. Bestimmungsgemäßer Gebrauch von Siemens-Produkten Beachten Sie Folgendes: Marken WARNUNG Siemens-Produkte dürfen nur für die im Katalog und in der zugehörigen technischen Dokumentation vorgesehenen Einsatzfälle verwendet werden. Falls Fremdprodukte und -komponenten zum Einsatz kommen, müssen diese von Siemens empfohlen bzw. zugelassen sein. Der einwandfreie und sichere Betrieb der Produkte setzt sachgemäßen Transport, sachgemäße Lagerung, Aufstellung, Montage, Installation, Inbetriebnahme, Bedienung und Instandhaltung voraus. Die zulässigen Umgebungsbedingungen müssen eingehalten werden. Hinweise in den zugehörigen Dokumentationen müssen beachtet werden. Alle mit dem Schutzrechtsvermerk gekennzeichneten Bezeichnungen sind eingetragene Marken der Siemens AG. Die übrigen Bezeichnungen in dieser Schrift können Marken sein, deren Benutzung durch Dritte für deren Zwecke die Rechte der Inhaber verletzen kann. Haftungsausschluss Wir haben den Inhalt der Druckschrift auf Übereinstimmung mit der beschriebenen Hard- und Software geprüft. Dennoch können Abweichungen nicht ausgeschlossen werden, so dass wir für die vollständige Übereinstimmung keine Gewähr übernehmen. Die Angaben in dieser Druckschrift werden regelmäßig überprüft, notwendige Korrekturen sind in den nachfolgenden Auflagen enthalten. Siemens AG Division Process Industries and Drives Postfach NÜRNBERG DEUTSCHLAND A5E AA P 02/2017 Änderungen vorbehalten Copyright Siemens AG Alle Rechte vorbehalten

3 Inhaltsverzeichnis 1 Klasse: RevisionInfo RevisionInfo: Function RevisionInfo: Property Klasse: RevisionMaster RevisionMaster: Function RevisionMaster: Property...7 Programmierhandbuch, 03/2017 V10.2.1, A5E AA 3

4 Inhaltsverzeichnis 4 Programmierhandbuch, 03/2017 V10.2.1, A5E AA

5 Klasse: RevisionInfo RevisionInfo: Function GetReleasedRevision GetReleasedRevision(Optional Index As Long = -1) As IComosDDevice Gibt das letzte freigegebene Revisionsobjekt zurück. Index Der Index beginnt bei 0. Wenn kein Parameter gesetzt ist, dann wird das letzte Revisionsobjekt zurückgegeben. Voreinstellung: -1. Wenn kein Parameter gesetzt ist, dann wird -1 verwendet. Der Parameter -1 gibt das letzte Revisionsobjekt zurück. GetReleasedRevisionFile GetReleasedRevisionFile(Optional Index As String = -1, Optional ByVal RevIndex As Long = -1) As String Gibt von der letzten freigegebenen Revisionsdatei den Pfad zurück. Index Der Index beginnt bei 0. Wenn kein Parameter gesetzt ist, dann wird die letzte Revisionsdatei ausgewertet. Voreinstellung: -1. Wenn kein Parameter gesetzt ist, dann wird -1 verwendet. Beim Parameter -1 wird die letzte Revisionsdatei ausgewertet. RevIndex Nur noch aus Kompatibilitätsgründen vorhanden. Nicht mehr verwenden. 1.2 RevisionInfo: Property Document Get Document() As Object Gibt das revisionierte Dokument zurück. Revision Get Revision() As String Gibt in einem gemeinsamen String den RevisionsIndex, das Revisionskennzeichen und die Revisionsbeschreibung zurück. Trennzeichen: Semikolon (";") Programmierhandbuch, 03/2017 V10.2.1, A5E AA 5

6 Klasse: RevisionInfo 1.2 RevisionInfo: Property RevisionState Get RevisionState() As String Gibt in einem gemeinsamen String für das aktuelle Revisionsobjekt den Revisionsschritt, das Revisionsschrittkennzeichen und die Revisionsschrittbeschreibung zurück. CurrentRevision Get CurrentRevision() As IComosDDevice Gibt das aktuelle Revisionsobjekt zurück. 6 Programmierhandbuch, 03/2017 V10.2.1, A5E AA

7 Klasse: RevisionMaster RevisionMaster: Function DoRevision DoRevision(Optional ByVal ElmDescription As String = "", Optional ByVal ElmSign As String = "") As edorevres Erzeugt den nächsten Revisionsschritt. ElmDescription Beschreibung des Revisionsschritts. Fehlt die Angabe, wird ein automatisch erzeugter Text verwendet. ElmSign Revisionschrittkennzeichen des Revisionsschritts. Fehlt die Angabe, wird ein automatisch erzeugter Text verwendet. CreateRevision CreateRevision(ByVal Document As IComosBaseObject) As IComosDDevice Erzeugt eine neue Revision (*-Revision). GetNextRevisionName GetNextRevisionName(Optional ByVal PlantRev As IComosDDevice) As Long Gibt den nächsten Revisionsindex zurück. PlantRev Gibt den nächsten Revisionsindex vom gesetzten Revisionsobjekt zurück. Fehlt die Angabe, wird das akuelle Revisionsobjekt verwendet. GetLastRev GetLastRev() As IComosDDevice Gibt das letzte Revisionsobjekt zurück. 2.2 RevisionMaster: Property CurrentRevision Get CurrentRevision() As IComosDDevice Gibt das aktuelle Revisionsobjekt zurück. Programmierhandbuch, 03/2017 V10.2.1, A5E AA 7

8 Klasse: RevisionMaster 2.2 RevisionMaster: Property RevDescription Let RevDescription(ByVal vnewvalue As String) Setzt die Beschreibung am aktuellen Revisionsobjekt. RevDescription Get RevDescription() As String Gibt die Beschreibung vom aktuellen Revisionsobjekt zurück. Document Get Document() As Object Gibt das revisionierte Dokumentobjekt zurück. Document Set Document(ByVal vnewvalue As Object) Setzt das zu revisionierende Dokument. 8 Programmierhandbuch, 03/2017 V10.2.1, A5E AA