Klassendokumentation ELOLib_dll COMOS. Platform Klassendokumentation ELOLib_dll. Marken 1. ELOLib_dll. Programmierhandbuch A5E

Transkript

1 Marken 1 ELOLib_dll 2 COMOS Platform Programmierhandbuch 04/2012 A5E

2 Rechtliche Hinweise 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 mit Warndreieck bedeutet, dass eine leichte Körperverletzung eintreten kann, wenn die entsprechenden Vorsichtsmaßnahmen nicht getroffen werden. VORSICHT ohne Warndreieck bedeutet, dass Sachschaden eintreten kann, wenn die entsprechenden Vorsichtsmaßnahmen nicht getroffen werden. ACHTUNG bedeutet, dass ein unerwünschtes Ergebnis oder Zustand eintreten kann, wenn der entsprechende Hinweis nicht beachtet wird. 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: 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. Marken 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 Industry Sector Postfach NÜRNBERG DEUTSCHLAND A5E P 04/2012 Änderungen vorbehalten Copyright Siemens AG Alle Rechte vorbehalten

3 Inhaltsverzeichnis 1 Marken ELOLib_dll ELOLib.cls Public Functions Public Subs...10 Programmierhandbuch, 04/2012, A5E

4 Inhaltsverzeichnis 4 Programmierhandbuch, 04/2012, A5E

5 Marken 1 Marken Eingetragener Schutzrechtsvermerk: COMOS Programmierhandbuch, 04/2012, A5E

6 Marken 6 Programmierhandbuch, 04/2012, A5E

7 ELOLib_dll ELOLib.cls Public Functions VDECreateType VDECreateType(ByVal MainObject As Object, VDEType As String) As Boolean Gilt für VDEkonforme Kabel. Nach Änderung einer Spezifikation werden Typ und Querschnitt neu berechnet. GetColour GetColour(ByVal ComosConnector As IComosDConnector) As String Holt Farbinformationen aus einem Konnektor, der mittels Verbindungsinformation in einen Plan gesetzt wurde. GetConnectorLabel GetConnectorLabel(ByVal Conn As Object) As String Berechnet das Kennzeichen des Anschlusspunkts eines Hilfskontakts. GetAddressSpace Public Function GetAddressSpace(ByVal Karte As Object) As String Berechnet den Adressraum einer Karte. GetAddress GetAddress(ByVal Channel As Object) As String Berechnet die Adresse eines Kanals. GetAddrStop GetAddrStop(ByVal Karte As Object, ByVal IO As String) As String Berechnet die Stopadresse einer Karte. Programmierhandbuch, 04/2012, A5E

8 ELOLib_dll 2.1 ELOLib.cls BelongsToSameBridge BelongsToSameBridge(ByVal StartTerminal As IComosDDevice, _ ByVal PartnerTerminal As IComosDDevice, _ ByVal IO As String, ByRef CableIndex As String) As Boolean Findet heraus, ob zwei Klemmen zu selben Brücke gehören. ConnectBySLine ConnectBySLine(ByVal MSL As IComosDConnector) As String Setzt elektrische Verbindungen, wenn Einstrich-Verbindung erfolgt ist. DisConnectBySLine DisConnectBySLine(ByVal MSL As IComosDConnector) As String Löst elektrische Verbindungen, wenn Einstrich-Verbindung gelöst wurde. CreateConnection CreateConnection(ByRef CP1 As IComosDConnector, ByRef CP2 As IComosDConnector, _ ByVal Cable As IComosDDevice, ByVal Index As Integer, _ByVal Modus As Integer) As Boolean Erzeugt eine Verbindung mit Modus: Modus = -1: Verbindung lösen. Modus = 0: Wenn beide Konnektoren frei sind. Modus = 1: Wenn Konnektoren nicht frei sind, werden Rekonnektoren erzeugt. Modus = 2: Wenn versuchte Verbindung bereits existiert, erhält man das Ergebnis zurück. Modus = 3: Verbindung wird erzwungen, auch wenn bereits Verbindung existiert. SetWiresBySLine (ByVal MSL As IComosDConnector, ByVal Cable As IComosDDevice) As String Setzt Kabel in IT-Konnektoren, wenn das Kabel auf einem Einstrichanschluss aufgelegt wurde. ReleaseWiresBySLine ReleaseWiresBySLine(ByVal Cable As IComosDDevice) As String Löst Kabel in IT-Konnektoren, wenn das Kabel auf einem Einstrichanschluss aufgelegt wurde. 8 Programmierhandbuch, 04/2012, A5E

9 ELOLib_dll 2.1 ELOLib.cls CloseMarshallingConnections CloseMarshallingConnections(ByVal Document As IComosDDocument, ByVal Mode As Integer) As String Arbeitet alle Signale in den Objekten ab, die sich in den Drag&Drop-Boxen befinden und versucht die Rangierung zu schließen oder zu lösen. AssemblyAssign AssemblyAssign(ByVal SourceObject As IComosBaseObject, _ ByVal TargetObject As IComosBaseObject, _ ByVal Action As EActions, _ Optional ByVal Param As Variant, _ Optional ByVal SearchDetailClass As String = vbnullstring, _ Optional ByVal ActionDev As IComosDDevice = Nothing) As String Definition SourceObject = Object, was gemerged wird, z.b. Klemmleiste X1 oder wenn SearchDetailClass gesetzt ist, dann ist SourceObject = Owner (Anlage), wo man für alle Objekte mit DetailClass gleichnamige Objekte im Ziel sucht. TargetObject = Owner (Schrank), wodrunter man gleichnamiges Objekt (X1) sucht Siehe hierzu Abschnitt "AssemblyAssign" in der FD-Spezifikation "ELOLib - eblocks". ObjectAssign ObjectAssign(ByVal SourceObject As IComosBaseObject, _ ByVal TargetObject As IComosBaseObject, _ ByVal Action As EActions, _ Optional ByVal Param As Variant, _ Optional ByVal ActionDev As IComosDDevice = Nothing) As StringOn Error GoTo ComosStdErrorHandler Löst eine Aktion wie z.b. Kopiervorlage platzieren oder Objekt suchen aus (siehe hierzu FD- Spezifikation "ELOLib - eblocks"). UndoAction UndoAction(ByVal ActionDev As IComosDDevice) As String Programmierhandbuch, 04/2012, A5E

10 ELOLib_dll 2.1 ELOLib.cls EvalSearchString EvalSearchString(ByVal StartObj As IComosBaseObject, ByVal SearchString As String, _ Optional ByVal SkipEvalLast As Boolean = False, Optional ByRef NewName As String = vbnullstring) As IComosBaseObject Syntax: +L1\L2\B1 => absolute location search =U1\U2\B1 => absolute unit search X1\X2\B1 => relative search from StartObj, with possibility..\..\b1 => change to owner..(u)\b1 => change to owner by class (e.g. Unit) Sucht vom Startobjekt aus ein COMOS-Objekt anhand des übergebenen Suchstrings und liefert dieses zurück Public Subs MovePotConnections MovePotConnections(ByVal Node1 As IComosDDevice, ByVal Node2 As IComosDDevice) Alle Potentiale und Verbindungen vom einem zum anderen Knoten verschieben. Public Sub VDECreateWiresNew VDECreateWiresNew(ByVal MainObject As Object, ByVal VDEType As String) Legt die korrekte Adernreihenfolge für ein VDE-Kabel an. VDECreateWires VDECreateWires(ByVal MainObject As Object, ByVal VDEType As String) Adern für VDE-Kabel anlegen SetWireNumbersByCoord SetWireNumbersByCoord(ByVal ReportDocument As REPORTLib.Document) Nummeriert alle Adern eines Dokuments durch. 10 Programmierhandbuch, 04/2012, A5E

11 ELOLib_dll 2.1 ELOLib.cls SetCDevBySpecs SetCDevBySpecs(ByVal Dev As IComosDDevice, _ ByVal BaseString As String, _ ByVal SpecName1 As String, _ ByVal SpecName2 As String) Wechselt das Stammobjekt an Funktionen in Abhängigkeit von der Anzahl der Prozessanschlüsse. ConnectedObjectAsChild Public Sub ConnectedObjectAsChild(ByVal Con As IComosDConnector) Wenn eine Armatur mit einer Funktion verbunden wird, soll die Armatur unter die Funktion verschoben werden. Triathlon_Export Triathlon_Export(ByVal Document As IComosDDocument, ByVal Dateiname As String) Exportiert den Schaltschrankaufbau zur Software Triathlon. EnumerateReferences EnumerateReferences(ByVal Node As IComosDDevice, ByVal Start As Integer, ByVal Sort As String) Nummeriert unterhalb eines Knotens hierarchisch die Referenzen durch. Wird verwendet an Dokumentengruppe Hierarchie. EnumerateReferences MoveObjectsToBoard Public Sub MoveObjectsToBoard(ByVal Platte As IComosDDevice, ByVal Planart As String) Wird in Fluid verwendet. Objekte, die von einer Basisplatte umrahmt sind, ziehen unter diese um. DoImplementPotential Public Sub DoImplementPotential(ByVal SourcePot As IComosDDevice,ByVal TargetPot As IComosDDevice) Implementiert zwei Potentiale oder Potentialbündel aufeinander. UndoImplementPotential Public Sub UndoImplementPotential(ByVal SourcePot As IComosDDevice) Löst zwei Potentiale oder Potentialbündel voneinander. Programmierhandbuch, 04/2012, A5E

12 ELOLib_dll 2.1 ELOLib.cls 12 Programmierhandbuch, 04/2012, A5E