COMOS. Platform Klassendokumentation Device_dll. Public Enum 1. Klasse: Device 2. Klasse: Implement 3. Klasse: InfoToCreateVE 4.

Transkript

1 Public Enum 1 Klasse: Device 2 COMOS Platform Programmierhandbuch Klasse: Implement 3 Klasse: InfoToCreateVE 4 Klasse: Message 5 Klasse: MessagePack 6 05/2016 V 10.2 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 04/2016 Änderungen vorbehalten Copyright Siemens AG Alle Rechte vorbehalten

3 Inhaltsverzeichnis 1 Public Enum Enum emlabelruntype Enum ucesavewiretype Klasse: Device AImportXObjCreate CDeviceChange CheckByLocalCDevice ConnectConnectors ConnectionPossible ContactFullName ContactName ControlTypeConverter CopyObject CreateDeviceObject CreateDeviceObjectEx CreateTemplate CreateVE DeleteConnectionForDevice DeleteObject DeviceNewByPrototype DigitCountInName DisconnectConnectors DocumentAssume DocumentsSearchAndAssume ElementsCloseOrPaste ElementsOrderByKoord ElementsOrderByLabel FirstNumberInString GetCaptionForUnit GetCDevicesByStructureGroup GetCDevStruktCollection GetChildsForNew GetClassicTQBProgIdByControlType GetComosObjectAcrossProjects GetCObject GetComosObject GetConPossibleTable GetControlType GetDeviceByDocObj GetDeviceLevel GetIdentTextForComosObject GetLabelWithVariable GetMainDevice...26 Programmierhandbuch, 05/2016 V 10.2, A5E AA 3

4 Inhaltsverzeichnis GetStdControlType GetTmpCollection GetVlKpCollection InheritCheckIn IsControlTypeTopQueryBrowser IsInheritCheckIn IsMainDevice IsImplementation IsImplemented IsObjectSystemRO IsPropertyTranslatable IsSetAllowed IsSpecificationTranslatable IsSpecInVisible IsWriteAllowed IsWriteAllowedByValue LabelChangeStretch LanguageDescription LockedStatusText MaxNumberInLabel MaxNumberInLabels MegaClass NameMaske NextForString NextForStringLikeComos NextNameForComosCollection NextNameForDevice NextNameLikes PasteObject QueryXObjCreate SearchDefaultCables SearchOrIndexObject SelectPointer SetCableChannelForCable SetImplementation SetLabel SetLocation SetLock SetName SetObjectLabel SetPointer SetRunNumber SetRunNumberForElement SetSubObjbyCDevDesc SetUnit XObjInheritParent Public Sub CheckElementsAfterCDeviceChange CheckDocumntsAfterCDeviceChange Public Property AllowMultipleRequests Programmierhandbuch, 05/2016 V 10.2, A5E AA

5 Inhaltsverzeichnis ITC_SYSCATEGORIE ITC_SYSSHIELD CurrentMessagePack MaxRunLevels Klasse: Implement Implement Properties Public Functions CheckConnectors CheckSpecificationsValue DisconnectOldRequest EnableRestore InfoText IsEnabledRestoreRequest IsUsedAsImplementation IsUsedAsRequest Public Subs CopySpecificationsValue MoveConnectorsInfo MoveDocObjs MoveSpecificationLinks SetUnit Klasse: InfoToCreateVE Klasse: Message Klasse: MessagePack...59 Programmierhandbuch, 05/2016 V 10.2, A5E AA 5

6 Inhaltsverzeichnis 6 Programmierhandbuch, 05/2016 V 10.2, A5E AA

7 Public Enum Enum emlabelruntype Enum emlabelruntype emcrunasfirst = 0 emcrunasnext = 1 emcnotrun = 3 ' Label berechnen und zwar zum ersten Mal ' Label berechnen, die alten Werte benutzen ' Label nicht berechnen 1.2 Enum ucesavewiretype Diese Konstante steuert folgendes Kontextmenü: Interaktiver Report, Selektion eines Kabels: "Leitung > Lösen / Lösen (Adern beibehalten) x / Lösen (Adern beibehalten) y" Enum ucesavewiretype uccsavewirenone = 0 uccsavewireown = 1 uccsavewirepartner = 2 Wenn eine Verbindungslinie gelöscht wird auf der ein Kabel platziert ist, dann kann der Anwender mittels Kontextmenü entscheiden, ob die Kabelinformation noch an einem der beteiligten Objekte erhalten bleibt. Die Kabelinformation geht verloren. Die Adern und damit die Kabelinformation bleibt am eigenen Anschluss erhalten. Die Adern und damit die Kabelinformation bleibt am Ggenanschluss erhalten. Wenn die Adern erhalten bleiben, dann ist die Aderinformation auch im Klemmleisteneditor und in der Kabelliste sichtbar. Siehe auch DisconnectConnectors (Seite 17) Programmierhandbuch, 05/2016 V 10.2, A5E AA 7

8 Public Enum 1.2 Enum ucesavewiretype 8 Programmierhandbuch, 05/2016 V 10.2, A5E AA

9 AImportXObjCreate Inaktiv AImportXObjCreate ( ByVal XObjContainer as IComosBaseObject ) as Object Nur noch aus Kompatibilitätsgründen in der dll enthalten CDeviceChange Wechselt das Stammobjekt an einem Planungsobjekt CDeviceChange(ByVal Device As Object, ByVal CDevice As Object, Optional ByVal RunType As emlabelruntype, Optional ByVal CheckMasks As Boolean = True) As Boolean Device Ist das Planungsobjekt, für welches das Stammobjekt gewechselt wird. CDevice Ist das neue Stammobjekt. CheckMasks Ist optional und legt fest, ob die Maskeneingaben für Name und Label geprüft werden sollen. Boolean. Ist "True", wenn der Wechsel des Stammobjekts erfolgreich war. Programmierhandbuch, 05/2016 V 10.2, A5E AA 9

10 2.1.3 CheckByLocalCDevice Wechselt das Stammobjekt an einem Planungsobjekt CheckByLocalCDevice ( ByVal CDevice as IComosDCDevice, ByVal ScreenMessages as Boolean, ByVal CreateMessage as Boolean ) as IComosDCDevice CDevice (IComosDCDevice) COMOS-Objekt des Systemtyps CDevice ScreenMessages (Boolean) True: Im Fehlerfall wird die Meldung in einer MessageBox angezeigt False: Im Fehlerfall erfolgt eine allgemeine Ausgabe, zum Beispiel in DebugView CreateMessage (Boolean) True: Im Fehlerfall wird die Meldung in die COMOS-Fehlerliste eingetragen. Die Fehlerliste wird mittels "Prüfen" oder "Objekt-Test" angezeigt. False: Kein zusätzlicher Eintrag in die COMOS-Fehlerliste Rückgabe ist ein Stammobjekt aus des aktuellen Projekts. Das Stammobjekt muss einen Stammobjekt-Zeiger auf das angegebene Stammobjekt besitzen. Fehlerfall: Wenn mehrere Stammobjekte mit Verweis vorhanden sind, dann ist der leer. In Abhängigkeit der Einstellungen wird für den Endanwender eine Meldung als MessageBox oder DebugView-Ausgabe ausgegeben ConnectConnectors Verbindet zwei Anschlüsse miteinander ConnectConnectors(ByVal Connector1 As Object, ByVal Connector2 As Object, Optional ByVal ScreenMessages As Boolean = True) As Boolean Connector1 Ist der erste Anschluss. Connector2 Ist der zweite Anschluss. ScreenMessages Bestimmt, ob Fehlermeldungen sofort angezeigt werden sollen oder nicht. 10 Programmierhandbuch, 05/2016 V 10.2, A5E AA

11 Ist "True", wenn die beiden Anschlüsse erfolgreich miteinander verbunden wurden ConnectionPossible Prüft, ob man zwei Anschlüsse miteinander verbinden kann ConnectionPossible(ByVal Connector1 As Object, ByVal Connector2 As Object, Optional ByVal ScreenMessages As Boolean = True) As Integer Connector1 Ist der erste Anschluss. Connector2 Ist der zweite Anschluss. ScreenMessages Ist optional und bestimmt, ob Fehlermeldungen sofort angezeigt werden sollen oder nicht. 0 Wenn die Verbindung möglich ist. -1 Wenn es sich um einen undefinierten Fehler handelt. 1 Wenn es sich um dieselben Anschlüsse handelt. 2 Wenn die Anschlüsse unterschiedliche Layer haben. 3 Wenn die Anschlüsse unterschiedliche Kategorien haben. 4 Wenn die Anschlüsse unterschiedliche Adern besitzen. 5 Wenn einer oder beide Anschlüsse bereits besetzt sind. 6 Wenn einer oder beide Anschlüsse nicht vom Planungsobjekt sind ContactFullName Liefert AliasFullLabel des Anschlusses ContactFullName ( ByVal Connector as Object, Optional ByVal Device as Variant ) as String Programmierhandbuch, 05/2016 V 10.2, A5E AA 11

12 Connector (Object) Das COMOS-Objekt des Systemtyps Connector Device (Object) Das Eigentümerobjekt des Connector-Objektes Rückgabe Liefert den AliasFullLabel des angegebenen Anschlusses in folgendem Format: <Connector.AliasFullLabel>[ (<Eigentümerobjekt.Name>) ] Der Teil in Klammern ist optional und wird nur bei folgenden Rahmenbedingungen ausgegeben: Anwendern besitzt Administratorrechte Eigentümer-Objekte beistzen die Klasse Element Der Eigentümer ist dabei das angegebene Device oder der logische Eigentümer ContactName Liefert den Namen des Anschlusses ContactName ( ByVal Connector as Object ) as String Connector (Object) Das COMOS-Objekt des Systemtyps Connector Rückgabe Liefert den Namen des angegebenen Anschlusses so zurück, wie er in der Anschlussliste erscheint. Auswertungsreihenfolge: eigenes Kennzeichen, Kennzeichen des Eigentümers, Beschreibung, Name. Wenn der Typ nicht IComosDConnector ist oder der enthält, so ist der ein Leerstring ControlTypeConverter Intern ControlTypeConverter ( ByVal progid as String ) as String Zuordnung von Komponenten-ID nach altem Schema auf Komponenten-ID nach neuem Schema. 12 Programmierhandbuch, 05/2016 V 10.2, A5E AA

13 2.1.9 CopyObject Inaktiv CopyObject ( ByVal ObjectToCopy as Object ) as Object Nur noch aus Kompatibilitätsgründen in der dll enthalten CreateDeviceObject Legt ein Planungsobjekt an CreateDeviceObject(ByVal Owner As Object, ByVal CDevice As IComosDCDevice, Optional ByVal Name As String, Optional ByVal Class As String, Optional ByVal Unit As IComosBaseObject, Optional ByVal Location As IComosBaseObject) As Object Owner Der Eigentümer des Objekts. CDevice Ist das Stammobjekt. Name Ist optional und liefert den Namen des Objekts. Unit Ist optional und setzt den eventuellen Unit-Pointer. Location Ist optional und setzt den eventuellen Location-Pointer. Das neue Planungsobjekt CreateDeviceObjectEx Legt ein Planungsobjekt an CreateDeviceObjectEx(ByVal Owner As Object, ByVal CDevice As IComosDCDevice, Optional ByVal Name As String, Optional ByVal Class As String, Optional ByVal Unit As IComosBaseObject, Optional ByVal Location As IComosBaseObject, Optional ByVal WithMsg As Boolean = True) As Object Programmierhandbuch, 05/2016 V 10.2, A5E AA 13

14 Owner Der Eigentümer des Objekts. CDevice Ist das Stammobjekt. Name Ist optional und liefert den Namen des Objekts. Unit Ist optional und setzt den eventuellen Unit-Pointer. Location Ist optional und setzt den eventuellen Location-Pointer. WithMsg Ist optional und legt fest, ob eine Fehlermeldung angezeigt werden soll. Das neue Planungsobjekt CreateTemplate Kopiert eine Baugruppe ein CreateTemplate(ByVal Owner As IComosBaseObject, ByVal TemplateOwner As IComosDDevice, Optional ByVal CDevice As IComosDCDevice = Nothing) As Collection Owner Das Objekt, unter dem die Baugruppe eingefügt wird. TemplateOwner Kopiert die durch TemplateOwner angegebene Baugruppe ein. CDevice Wird verwendet, um zu entscheiden, ob die Anlegeoption "Normal" oder "Block" verwendet wird. Dieser wird nur dann verwendet, wenn er gesetzt ist. Eine Collection mit den neu erstellten Root-Objekten. 14 Programmierhandbuch, 05/2016 V 10.2, A5E AA

15 CreateVE Intern CreateVE ( ByVal CreateCount as Integer, ByVal MaxNumbers as _Collection, ByVal ElementsOwner as IComosBaseObject, ByVal VEInfos as _Collection ) as _Collection Intern DeleteConnectionForDevice Löst die Verbindung für das Planungsobjekt DeleteConnectionForDevice(ByVal DeviceObject As Object, ByVal ConnectorsLayer As String, Optional ByVal Side As String) DeviceObject Ist das Planungsobjekt. ConnectorsLayer Der Anschlusstyp, der gelöst werden muss. Side Optional. Ist die Anschlussseite: Input, Output oder alle ("I", "O", ""). Keiner DeleteObject Löscht das angegebene Objekt DeleteObject ( ByVal ObjectToDelete as Object ) as Boolean ObjectToDelete (Object) Das zu löschende COMOS-Objekt Programmierhandbuch, 05/2016 V 10.2, A5E AA 15

16 Unterstützte Typen: IComosDDevice In folgenden Fällen kann das Device nicht gelöscht werden: Das Device ist auf mindestens einem Dokument platziert oder Das Device besitzt mindestens ein Element, das auf mindestens einem Dokument platziert ist. IComosDDocObj Wenn das Objekt existiert und die Recht verfügbar sind, wird das DocObj gelöscht. Für andere Typen wird eine MessageBox mit einer Fehlermeldung angezeigt. True: Objekt gelöscht False: Alle sonstigen Fälle DeviceNewByPrototype Legt ein neues Planungsobjekt nach dem Muster eines bestehenden Planungsobjekts an Das neue Planungsobjekt, das erzeugt wird, hat das gleiche Stammobjekt, den gleichen Unit- Pointer, den gleichen Location-Pointer und die gleichen Spezifikationswerte wie der Prototyp. DeviceNewByPrototype(ByVal Prototype As IComosDDevice) As IComosDDevice Prototype Ein bestehendes Planungsobjekt. Ein neues Planungsobjekt DigitCountInName Inaktiv DigitCountInName ( ByVal ComosObject as Object ) as Integer Nur noch aus Kompatibilitätsgründen in der dll enthalten. 16 Programmierhandbuch, 05/2016 V 10.2, A5E AA

17 DisconnectConnectors Löst die Verbindung zwischen zwei Anschlüssen DisconnectConnectors(ByVal CurrentConnector As IComosDConnector, Optional ByVal PartnerCon As IComosDConnector, Optional ByVal SaveWireType As ucesavewiretype = uccsavewirenone) As Boolean CurrentConnector Ist der Anschluss. PartnerCon Optional. Ist der zweite Anschluss. SaveWireType Optional. Legt fest, ob mit der Verbindung auch die Adern, die zu der Verbindung gehören, gelöst werden sollen. Siehe auch Kapitel Enum ucesavewiretype (Seite 7) Ist "True", wenn die Operation erfolgreich war DocumentAssume Inaktiv DocumentAssume ( ByVal OwnerObject as IComosBaseObject, ByVal Document as Object ) as Object OwnerObject (IComosBaseObject) Der Eigentümer des zu erstellenden Dokuments Document (Object) Die Vorlage des zu erstellenden Dokuments Wenn das Dokument erzeugt wird, dann können folgende zwei Fälle auftreten: Das Dokument soll unterhalb eines Dokuments erzeugt werden Dokumentenpaketen DVM-Dokumente Es wird immer ein neues Dokument erstellt. Die Funktion ruft sich rekursiv auf für die Dokumente unter dem neuen Dokument. Alle anderen Fälle Das Dokument wird per Einfügen der Vorlage unter dem neuen Eigentümer angelegt. Programmierhandbuch, 05/2016 V 10.2, A5E AA 17

18 DocumentsSearchAndAssume Erzeugt alle vordefinierten Dokumente für ein gegebenes Planungsobjekt DocumentsSearchAndAssume(ByVal Device As Object) Device Ist das Planungsobjekt. Keiner ElementsCloseOrPaste Inaktiv ElementsCloseOrPaste ( ByVal WType as String, ByVal MainDevice as Object, ByVal Level as Integer, ByVal Class as String, Optional ByVal Number1 as Integer, Optional ByVal Number2 as Integer ) as Variant Nur noch aus Kompatibilitätsgründen in der dll enthalten ElementsOrderByKoord Sortiert Elemente ElementsOrderByKoord ( ByRef CurrentDevice as Object, ByRef SortType as String ) as Variant CurrentDevice (Object) Der Eigentümer, dessen Elemente untersucht werden SortType (String) Sortierungsverfahren. Zugelassene Werte: XY YX Die Funktion arbeitet folgende Schritte ab: 1. Erfassung aller platzierten Elementen des CurrentDevices der ersten Stufe 2. Speicherung der alten Namen und Kennzeichen 18 Programmierhandbuch, 05/2016 V 10.2, A5E AA

19 3. Sortierung der Elemente gemäß der Platzierung auf dem Dokument Sortierung erfolgt in Abhängigkeit von SortType in XY-Richtung oder in YX-Richtung 4. Neuvergabe der Namen und Kennzeichen gemäß der alten Reihenfolge der Namen Lücken werden nicht geschlossen. Anwendungsbeispiel: Klemmleistensortierung. Siehe auch ElementsOrderByLabel (Seite 19) ElementsOrderByLabel Sortiert Elemente ElementsOrderByLabel ( ByVal CurrentDevice as Object ) as Variant CurrentDevice (Object) Der Eigentümer, dessen Elemente untersucht werden Die Funktion arbeitet folgende Schritte ab: 1. Erfassung aller platzierten Elementen des CurrentDevices der ersten Stufe 2. Speicherung der alten Namen und Kennzeichen 3. Sortierung der Elemente gemäß der Reihenfolge der Kennzeichen 4. Neuvergabe der Namen und Kennzeichen gemäß der alten Reihenfolge Lücken werden nicht geschlossen. Anwendungsbeispiel: Klemmleistensortierung. Siehe auch ElementsOrderByKoord (Seite 18) FirstNumberInString Liefert die erste Nummer FirstNumberInString ( ByVal CurrentString as String ) as Integer Programmierhandbuch, 05/2016 V 10.2, A5E AA 19

20 CurrentString (String) Die zu untersuchende Zeichenfolge Liefert die erste Nummer aus einer Zeichenfolge zurück GetCaptionForUnit Liefert die Beschreibung der Anlage GetCaptionForUnit ( ByVal CurObject as IComosBaseObject ) as String CurObject (IComosBaseObject) Das Objekt, dessen Beschreibung man sucht. Unterstützte Typen: IComosDDevice IComosDDocument Die Funktion liefert einen der beiden folgenden Fälle: Ermittelt den GUnit-Pointer des mittels CurObject angegebenen Objekts und liefert die Beschreibung seiner Klasse aus der Klassenliste zurück. Voraussetzung: Das mittels GUnit gefundene Objekt hat eine der folgende Klassen: Position Function FunctionElement Signal Andernfalls ist der "Unit" GetCDevicesByStructureGroup Liefert Stammobjekte GetCDevicesByStructureGroup ( ByVal CDevice as IComosDCDevice, Optional ByVal WithDeleted as Boolean = False ) as IComosDCollection 20 Programmierhandbuch, 05/2016 V 10.2, A5E AA

21 CDevice (IComosDCDevice) Das Objekt, dessen CDevices gesucht werden WithDeleted (optional) (Boolean) Steuert, ob gelöschte CDevices berücksichtigt werden Liefert alle Stammobjekte des angegebenen Stammobjektes. Voraussetzung: Stammobjekte haben die Anlegeoption Gruppe Stammobjekte sind die keine Elemente Stammobjekte des dereferenzierten Stammobjektes werden mitberücksichtigt GetCDevStruktCollection Intern GetCDevStruktCollection ( ByVal Devs as IComosDCollection ) as _Collection Intern GetChildsForNew Liefert mögliche Stammobjekte für neue Objekte GetChildsForNew(ByVal Owner As Object, ByVal CDevice As IComosDCDevice, ByVal WithSubsFromBlock As Boolean) As Collection Owner (Object) Ist der Eigentümer. Zugelassene Typen: IComosDCDevice VBA.Collection IComosDCollection CDevice Nur intern. WithSubsFromBlock Nur intern. Legt fest, ob die Elemente aus der Anlegeoption "Block" berücksichtigt werden. IgnoreCheckTplLayer (optional) Nur intern. Programmierhandbuch, 05/2016 V 10.2, A5E AA 21

22 Ruft die Routine GetChildsForNewOne für alle angegebene Objekte auf. Letztlich liefert die Funktion mögliche Stammobjekte für das Anlegen neuer Objekte unter einem gegebenen Eigentümer. Eine Auflistung von Stammobjekten GetClassicTQBProgIdByControlType Intern GetClassicTQBProgIdByControlType ( ByVal ControlType as String ) as String Verarbeitung von ProgIDs von Abfragen zur weiteren Nutzung in XML-Connectoren GetComosObjectAcrossProjects Liefert ein Objekt GetComosObjectAcrossProjects ( ByVal WorkSet as IComosDWorkset, ByVal SystemUID as String, ByVal SystemType as Long, ByVal PathFullName as String, ByVal SearchAcrossProjects as Boolean ) as IComosBaseObject WorkSet (IComosDWorkset) Das aktuelle COMOS-Workset SystemUID (String) Die SystemUID des gesuchten Objektes SystemType (Long) Der SystemType des gesuchten Objektes PathFullName (String) Der PathFullName des gesuchten Objektes SearchAcrossProjects (Boolean) Nur intern relevant. Immer False verwenden Liefert ein COMOS-Objekt mit Hilfe seiner SystemUID und SystemType. 22 Programmierhandbuch, 05/2016 V 10.2, A5E AA

23 Zusätzlich gilt: wenn das Objekt im aktuellen Projekt nicht gefunden wird, dann wird es mittels PathFullName im Stammprojekt und Systemprojekt gesucht. Voraussetzung dafür ist, dass das Objekt einen der folgenden Systemtypen besitzt: CDevice StandardTable StandardValue GetCObject Liefert Stammobjekt für ein gegebenes Objekt. GetCObject(ByVal ComosObject As IComosBaseObject) As IComosDCDevice ComosObject Ist ein Comos-Objekt. Es werden die folgenden Objekttypen berücksichtigt: SystemTypeDevice SystemTypeUnit SystemTypeLocation SystemTypeCDevice SystemTypeProject SystemTypeDocument Ist das Stammobjekt GetComosObject Liefert ein Comos-Objekt nach den angegebenen n GetComosObject(ByVal WorkSet As IComosDWorkset, ByVal SystemUID As String, ByVal SystemType As Long, ByVal PathFullName As String) As IComosBaseObject WorkSet Ist das Comos-Workset. SystemUID Ist die SystemUID des Objekts. Programmierhandbuch, 05/2016 V 10.2, A5E AA 23

24 SystemType Ist der Systemtyp des Objekts. PathFullName Ist der PathFullName des Objekts, relativ zum Projekt. Das gefundene Comos-Objekt GetConPossibleTable xxx GetConPossibleTable ( ByVal Connector as IComosDConnector ) as IComosDStandardTable Connector (IComosDConnector) GetControlType Liefert den ControlTyp (ProgID) GetControlType ( ByVal ComosObj as IComosBaseObject ) as String ComosObj (IComosBaseObject) Das COMOS-Objekt Liefert den ControlTyp (ProgID) für das angegebene COMOS-Objekt. Der ControlTyp ist in den Eigenschaften des Stammobjektes sichtbar und änderbar. Zugelassen sind die Typen IComosDDevice und IComosDCDevice GetDeviceByDocObj Liefert das referenzierte Planungsobjekt von DocObj-Objekten GetDeviceByDocObj(ByVal DocObjObject As Object) As Object 24 Programmierhandbuch, 05/2016 V 10.2, A5E AA

25 DocObjObject Ist das DocObj-Objekt GetDeviceLevel Gibt die relative Stufe eines Elements in Bezug auf ein Hauptobjekt (MainDevice) an GetDeviceLevel(ByVal CurrentDevice As Object) As Integer CurrentDevice Ist das Planungsobjekt. Ist die Stufe, auf der sich das Element befindet GetIdentTextForComosObject Erzeugt den Standardanzeigetext für ein Comos-Objekt GetIdentTextForComosObject(ByVal ComosObject As IComosBaseObject) As String ComosObject Ist das Comos-Objekt, für das der Text erzeugt werden soll. Ist der Anzeigetext GetLabelWithVariable Inaktiv GetLabelWithVariable ( ByVal DeviceObject as Object, ByVal x as Double, ByVal Y as Double ) as String Nur noch aus Kompatibilitätsgründen in der dll enthalten. Programmierhandbuch, 05/2016 V 10.2, A5E AA 25

26 GetMainDevice Identisch mit der MainDevice-Funktion des Kernels. Ist aus Kompatibilitätsgründen vorhanden. Siehe hierzu auch Kernel-Dokumentation "comos.dll" GetMainDevice(ByVal CurrentDevice As Object) As Object GetStdControlType Intern GetStdControlType ( Optional ByVal ComosObject as IComosBaseObject, Optional ByRef Class as String, Optional ByRef SubClass as String ) as String Zuordnung von Komponenten-ID nach altem Schema auf Komponenten-ID nach neuem Schema GetTmpCollection Wandelt den ersten, unabhängig vom Typ, in IComosDCollection um GetTmpCollection(ByVal ComosObjects As Object, Optional ByVal STypes As VBA.Collection) As IComosDCollection ComosObjects Können ein oder mehrere Comos-Objekte sein. Es werden die folgenden Typen unterstützt: IComosBaseObject, VBACollection, IComosDCollection. STypes Ist optional und filtert das Objekt nach den angegebenen Typen heraus. Aufzählung von Objekten des Typs IComosDCollection GetVlKpCollection Inaktiv GetVlKpCollection ( ByVal Knoten as Object ) as Collection Nur noch aus Kompatibilitätsgründen in der dll enthalten. 26 Programmierhandbuch, 05/2016 V 10.2, A5E AA

27 InheritCheckIn Bucht das Objekt ein, wenn es möglich ist InheritCheckIn(ByVal ComosObject As Object, ByVal ShowMessage As Boolean, ByVal CreateMessage As Boolean) As Boolean ComosObject Ist das Objekt auf Planungsseite, das eingebucht werden soll. ShowMessage Zeigt Fehlermeldung an. CreateMessage Legt fest, dass die Fehlermeldungen in ein eigenes Message Pack geschrieben werden. Ist "True", wenn die Operation erfolgreich war IsControlTypeTopQueryBrowser Prüfung auf TopQBrowser IsControlTypeTopQueryBrowser ( ByVal ComosObj as IComosBaseObject ) as Boolean ComosObj (IComosBaseObject) Das COMOS-Objekt. Liefert zurück, ob der ControlTyp (ProgID) des COMOS-Objektes den Typ TopQBrowser enthält IsInheritCheckIn Bucht das Objekt ein, wenn es möglich ist. IsInheritCheckIn(ByVal ComosObject As Object) As Boolean ComosObject Ist das Objekt auf Planungsseite, das eingebucht werden soll. Programmierhandbuch, 05/2016 V 10.2, A5E AA 27

28 Ist "True", wenn die Operation erfolgreich war IsMainDevice Prüft, ob ein eingegebenes Objekt ein Hauptobjekt (MainDevice) ist IsMainDevice(ByVal CurrentDevice As Object) As Boolean CurrentDevice Ist das Planungsobjekt. Ist "True", wenn das Planungsobjekt ein Hauptobjekt (MainDevice) ist IsImplementation Prüft, ob ein Comos-Objekt als Implementierungs-Pointer für die eingegebene Anforderung gültig ist IsImplementation(ByVal ComosObject As IComosBaseObject, ByVal Request As IComosDDevice) As Boolean ComosObject Das geprüfte Planungsobjekt. Request Die eingegebene Anforderung. Ist "True", wenn man das geprüfte Objekt als Implementierung verwenden darf IsImplemented Prüft, ob das Objekt schon als Implementierung verwendet wurde IsImplemented(ByVal curobj As IComosDDevice) As Boolean 28 Programmierhandbuch, 05/2016 V 10.2, A5E AA

29 curobj Ist das zu prüfende Planungsobjekt. Ist "True", wenn das Objekt als Implementierung verwendet wurde IsObjectSystemRO Prüft, ob das Objekt schreibgeschützt ist IsObjectSystemRO(ByVal ComosObject As Object) As Boolean ComosObject Ist das Comos-Objekt, für das die Prüfung durchgeführt werden soll. Ist "True", wenn das Objekt schreibgeschützt ist IsPropertyTranslatable Püfung auf Übersetzbarkeit IsPropertyTranslatable ( ByVal ComosObject as IComosBaseObject, ByVal PropName as String, ByVal Prop as Variant ) as String ComosObj (IComosBaseObject) Das COMOS-Objekt. PropName (String) Die zu untersuchende Eigenschaft Prop (Variant) Optional für Eigenschaften mit Index Die Funktion überprüft, ob die angegebene Eigenschaft beim angegebenen COMOS-Objekt übersetzbar ist. Die Funktion wird aufgerufen, wenn im Einzelübersetzer oder Mengenübersetzer Texte geladen werden. Funktioniert nur für Attribute vom Typ Text. Programmierhandbuch, 05/2016 V 10.2, A5E AA 29

30 e Leerstring Die Eigenschaft ist übersetbar. Fehlermeldung Die Eigenschaft ist nicht übersetzbar oder schreibgeschützt IsSetAllowed Prüft, ob für ein eingegebenes Comos-Objekt ein Pointer gesetzt werden darf IsSetAllowed(ByVal ComosObject As IComosBaseObject, ByVal PointerObj As Object, ByVal PropName As String, ByVal WithMsg As Boolean, Optional ByVal CreateMessage As Boolean = True) As Boolean ComosObject Ist das Comos-Objekt, für das die Prüfung durchgeführt werden soll. PointerObj Der Pointer, der gesetzt werden soll. PropName Der Name der Property. Es werden die folgenden Properties unterstützt: CDevice Cobject Location Unit Alias Implementation Link.Object StandardTable Signal Potential Connected with Wire WithMsg Legt fest, ob eine Fehlermeldung angezeigt werden soll. CreateMessage Ist optional und legt fest, dass die Fehlermeldungen in ein eigenes Message Pack geschrieben werden. 30 Programmierhandbuch, 05/2016 V 10.2, A5E AA

31 Ist "True", wenn man den Pointer setzen darf IsSpecificationTranslatable Inaktiv IsSpecificationTranslatable ( ByRef SpecObj as IComosBaseObject ) as Boolean Nur noch aus Kompatibilitätsgründen in der dll enthalten IsSpecInVisible Prüfung auf Sichtbarkeit IsSpecInVisible ( ByVal ComosObj as Variant ) as Boolean ComosObj (Variant) Das COMOS-Objekt. Die Funktion prüft den Editiermodus und die Funktionsrechte des Benutzers und liefert zurück, ob das Attribut unterhalb des logischen Eigentümers für den Benutzer sichtbar ist. e True Das Objekt ist sichtbar False Das Objekt ist nicht sichtbar oder der Systemtyp des geprüften Objekts ist nicht IComosDSpecification IsWriteAllowed Prüft, ob man Wertetypen-Properties für ein Comos-Objekt ändern darf IsWriteAllowed(ByVal ComosObject As IComosBaseObject, Optional ByVal WithMsg As Boolean = False, Optional ByVal PropName As String, Optional ByVal Prop As Variant) As Boolean Programmierhandbuch, 05/2016 V 10.2, A5E AA 31

32 ComosObject Das Comos-Objekt, für das die Prüfung durchgeführt werden soll. WithMsg Legt fest, ob eine Fehlermeldung angezeigt werden soll. PropName Optional. Der Name der Property. Prop Optional. Ist der der Property. Ist "True", wenn die Property geändert werden darf IsWriteAllowedByValue Prüfung auf Schreib-Recht für die Property IsWriteAllowedByValue ( ByVal ComosObject as IComosBaseObject, Optional ByVal WithMsg as Boolean = Falsch, Optional ByVal PropName as String, Optional ByVal Prop as Variant, Optional ByVal vnewvalue as Variant ) as Boolean ComosObject Das Comos-Objekt, für das die Prüfung durchgeführt werden soll. WithMsg (optional) Legt fest, ob eine Fehlermeldung angezeigt werden soll. PropName (optional) Der Name der Property. Prop (optional) Optional für Eigenschaften mit Index. Ist der Index der Property. vnewvalue (optional) Optional. Ist der Wert, der gesetzt werden soll. Prüft, ob die angegebene Eigenschaft des angegebenen COMOS-Objekts editierbar ist und gibt im Negativfall eine Fehlermeldung zurück. In der Prüfung auf Schreibschutz werden folgende Gründe berücksichtigt: Rechte des Benutzers Funktionsrechte Zugehörigkeit zum aktuellen Projekt oder zu einem anderen Projekt Status für die Objektzustände "Objektsperrung" und "Systemobjekt" 32 Programmierhandbuch, 05/2016 V 10.2, A5E AA

33 Unterstützte Systemtypen: IComosDDevice, IComosDCDevice, IComosDSpecification, IComosDDocument, IComosDConnector, IComosDUser. Ist "True", wenn die Property geändert werden darf. Die Fehlermeldung wird ausgegeben über LockedStatusText (Seite 33) LabelChangeStretch Intern LabelChangeStretch ( ByVal CurElement as Object, ByVal NewLabel as String ) as Variant Interne Verarbeitung von Anschlusskennzeichen LanguageDescription Liefert die Beschreibung der Sprache LanguageDescription(ByVal Language As IComosDLanguage, Optional Index As Integer = -1) As String Language Ist das Comos-Sprachenobjekt. Index Optional. Ist der Index der Sprache in der Comos-Collection, in die übersetzt werden soll. Ist der Text in der ausgewählten Sprache LockedStatusText Liefert einen Text, der angibt, warum die Property eines Objekts geschützt ist LockedStatusText(ByVal ComosObject As IComosBaseObject, ByVal PropName As String, ByVal Prop As Variant) As String Programmierhandbuch, 05/2016 V 10.2, A5E AA 33

34 Ausgabefunktion für die Berechnungen von IsWriteAllowedByValue (Seite 32). ComosObject Ist das Comos-Objekt, bei dem die Property schreibgeschützt ist. PropName Der Name der Property, die schreibgeschützt ist. Prop der Property, die schreibgeschützt ist. Der Statustext, der in der Statuszeile der Applikation angezeigt wird MaxNumberInLabel Inaktiv MaxNumberInLabel ( ByVal MainDevice as Object, ByVal Class as String, Optional ByVal SearchLevelsCount as Integer ) as Collection Nur noch aus Kompatibilitätsgründen in der dll enthalten MaxNumberInLabels Inaktiv MaxNumberInLabels ( ByVal ComosObjects as Object, ByVal Class as String ) as Long Nur noch aus Kompatibilitätsgründen in der dll enthalten MegaClass Intern MegaClass ( ByVal ComosObject as Object ) as String Zuordnung von Typen nach altem Schema auf Klassen nach neuem Schema. 34 Programmierhandbuch, 05/2016 V 10.2, A5E AA

35 NameMaske Intern NameMaske ( ByVal OrigString as String ) as String Interne Berechnung von Namen-Masken NextForString Intern NextForString ( ByVal LastName as String ) as String Interne Berechnung von Namen-Masken NextForStringLikeComos Intern NextForStringLikeComos ( ByVal LastName as String ) as String Interne Berechnung von Namen-Masken NextNameForComosCollection Intern NextNameForComosCollection ( ByVal ComosCollection as Object, ByVal OrigName as String, Optional ByVal IsStart as Boolean, Optional ByVal ComosObject as Object ) as String Interne Berechnung von Namen-Masken bei Elementen NextNameForDevice Namen-Berechnung NextNameForDevice ( ByVal Device as IComosDDevice, Optional ByVal Prefix as String, Optional ByVal SourceCDevice as IComosDCDevice ) as String Programmierhandbuch, 05/2016 V 10.2, A5E AA 35

36 Device (IComosDDevice) Das COMOS-Objekt Prefix (optional) (String) Steuert, ob Meldungen in der Funktion MessagePack ausgegeben werden SourceCDevice (optional) (IComosDCDevice) Gewünschtes Stammobjekt Berechnet den neuen Namen für das angegebene Device-Objekt. Die Namenberechnung berücksichtigt folgende Vorgaben: Namen-Masken am Stammobjekt Namen-Masken am optional angegebenen SourceCDevice Die Einstellung Virtuell Bei der Berechnung des Namens existieren zwei Fälle: Wenn eine Maske definiert ist, dann gewinnt diese. Der neue Name wird von der Maske bestimmt. Wenn keine Maske existiert, dann wird der Name anhand der Einstellung Virtuell gebildet: Einstellung Virtuell ist aus: Der Name wird mittels der Methode NextNameLikes berechnet. Einstellung Virtuell ist an: Im Namen werden so viele? eingetragen wie die Anzahl der Stellen in der Einstellung Virtuell. Dieser Fall ist selten NextNameLikes Namen-Berechnung NextNameLikes ( ByVal ComosObject as Object, Optional ByVal Prefix as String ) as String Liefert NextName zurück und berücksichtigt dabei die Einstellung aus Project.s. Project.s legt unter anderem fest, wieviele wieviele Ziffern im Namen stehen PasteObject Inaktiv PasteObject ( ByVal OwnerObject as Object, ByVal DeviceObject as Object ) as Object 36 Programmierhandbuch, 05/2016 V 10.2, A5E AA

37 OwnerObject (Object) COMOS-Objekt, das der neue Eigentümer wird DeviceObject (Object) Das eingefügte COMOS-Objekt Erstellt eine Kopie des angegebenen Objektes unter dem Eigentümer und liefert das neu erstellte Objekt zurück. Ähnliche Funktion: Paste in der comos.dll QueryXObjCreate Inaktiv QueryXObjCreate ( ByVal XObjContainer as IComosBaseObject ) as Object Nur noch aus Kompatibilitätsgründen in der dll enthalten SearchDefaultCables xxx SearchDefaultCables ( ByVal CurrentDevice as IComosDDevice ) as Variant SearchOrIndexObject Unterscheidung zwischen Suchobjekt und Indexobjekt SearchOrIndexObject ( ByVal CurrentObject as IComosBaseObject ) as Integer CurrentObject (IComosBaseObject) Das COMOS-Objekt Überprüft, ob es sich bei dem angegebenen Objekt um ein Suchobjekt oder ein Indexobjekt handelt. Voraussetzung: Objekt ist von der Systeklasse IComosDDevice. Programmierhandbuch, 05/2016 V 10.2, A5E AA 37

38 e 1: Objekt ist ein Suchobjekt 2: Objekt ist ein Indexobjekt 0: In allen anderen Fällen SelectPointer Öffnet ein Fenster für eine Verweisauswahl SelectPointer(ByVal ComosObject As IComosBaseObject, ByVal PropName As String, Optional ByVal WithMsg As Boolean = False, Optional ByRef Cancel As Boolean = False) As IComosBaseObject ComosObject Ist das Dokument oder die Spezifikation. PropName Es werden nur zwei Properties unterstützt: CDocument und LinkObject. WithMsg Ist optional und legt fest, ob eine Fehlermeldung angezeigt werden soll. Cancel Ist optional. Bei Referenz Cancel = True, wenn die Aktion abgebrochen wird. Das ausgewählte Comos-Objekt SetCableChannelForCable xxx SetCableChannelForCable ( ByVal Cable as IComosDDevice, ByVal CableChannel as IComosDDevice ) as Variant 38 Programmierhandbuch, 05/2016 V 10.2, A5E AA

39 SetImplementation Implementiert die Anforderung SetImplementation(ByVal Request As IComosDDevice, ByVal Implementation As IComosDDevice, Optional ByVal WithMsgByReplace As Boolean = False) As Integer Request Ist das Anforderungsobjekt, das implementiert werden soll. Implementation Ist das Implementierungsobjekt. WithMsgByReplace Ist optional und legt fest, ob eine Fehlermeldung angezeigt werden soll. Ist 0, wenn die Implementierung erfolgreich war SetLabel Setzt ein Label für ein Comos-Objekt SetLabel(ByVal ComosObject As IComosBaseObject, ByVal NewLabel As String, Optional ByVal WithMsg As Boolean = False) As Boolean ComosObject Das Comos-Objekt, für das das Label gesetzt werden soll. NewLabel Der neue Name. WithMsg Ist optional und legt fest, ob eine Fehlermeldung angezeigt werden soll. Ist "True", wenn die Operation erfolgreich war. Programmierhandbuch, 05/2016 V 10.2, A5E AA 39

40 SetLocation Setzt den Location-Pointer für ein Comos-Objekt SetLocation(ByVal ComosObject As IComosBaseObject, ByVal PointerObj As Object, Optional ByVal WithMsg As Boolean = False) As Boolean ComosObject Das Comos-Objekt, für das der Location-Pointer gesetzt werden soll. PointerObj Der Location-Pointer, der gesetzt werden soll. WithMsg Ist optional und legt fest, ob eine Fehlermeldung angezeigt werden soll. Ist "True", wenn die Operation erfolgreich war SetLock Sperrt oder gibt ein Planungsobjekt frei SetLock(ByVal ComosObj As Object, ByVal vnewvalue As Boolean, ByVal Recursive As Integer, ByVal WithMsg As Boolean) As Boolean ComosObj Ist ein Planungsobjekt oder ein Dokument. vnewvalue Ist enweder "True" oder "False". Recursive Legt fest, ob die Child-Objekte auch gesperrt oder frei gegeben werden sollen. Es gibt die folgenden Werte: 0 Nicht rekursiv 1 Rekursiv 2 Mit Abfrage, ob rekursiv oder nicht rekursiv verfahren werden soll. WithMsg Legt fest, ob eine Fehlermeldung angezeigt werden soll. 40 Programmierhandbuch, 05/2016 V 10.2, A5E AA

41 SetName Setzt einen Namen für ein Comos-Objekt SetName(ByVal ComosObject As IComosBaseObject, ByVal NewName As String, Optional ByVal WithMsg As Boolean = False) As Boolean ComosObject Das Comos-Objekt, für das ein Name gesetzt werden soll. NewName Der neue Name. WithMsg Ist optional und legt fest, ob eine Fehlermeldung angezeigt werden soll. Ist "True", wenn die Operation erfolgreich war SetObjectLabel Inaktiv SetObjectLabel ( ByVal DocObjObject as Object ) as Boolean Nur noch aus Kompatibilitätsgründen in der dll enthalten SetPointer Prüft, ob ein Pointer gesetzt werden darf und setzt den Pointer, falls die Prüfung erfolgreich war SetPointer(ByVal ComosObject As IComosBaseObject, ByVal PointerObj As Object, ByVal PropName As String, Optional ByVal WithMsg As Boolean = False) As Boolean ComosObject Das Comos-Objekt, für das der Pointer gesetzt werden darf. PointerObj Das zu setzende Pointer-Objekt. Programmierhandbuch, 05/2016 V 10.2, A5E AA 41

42 PropName Der Name der Property. Es werden die folgenden Properties unterstützt: CDevice CObject CDocument Location Unit Alias Implementation Link.Object StandardTable Signal Potential ConnectedWith Wire Cable WithMsg Ist optional und legt fest, ob eine Fehlermeldung angezeigt werden soll. Ist "True", wenn die Operation erfolgreich war SetRunNumber Intern SetRunNumber ( ByVal Element as Object, ByVal RunNumber as Long, Optional ByVal Mode as String ) as Long Interne Berechnung von Namen-Masken SetRunNumberForElement Veraltet SetRunNumberForElement ( ByVal Element as Object, ByVal RunNumbers as _Collection, Optional ByVal Mode as String, Optional ByVal MainDevice as Object, Optional ByVal SearchLevelsCount as Integer ) as Collection 42 Programmierhandbuch, 05/2016 V 10.2, A5E AA

43 Berechnung von Kennzeichen SetSubObjbyCDevDesc Element erzeugen oder mittels Stammobjektzeiger ändern SetSubObjbyCDevDesc ( ByVal DeviceOwner as IComosBaseObject, ByVal DeviceName as String, ByVal CDeviceOwnerFullname as String, ByVal CDeviceDescription as String ) as Variant DeviceOwner (IComosBaseObject) Das COMOS-Objekt DeviceName (String) Der Element-Name CDeviceOwnerFullname (String) Der SystemFullName des Stammobjektes CDeviceDescription (String) Beschreibung des Stammobjektes Die Funktion durchläuft folgende Schritte: Gesucht wird unterhalb des Objekts DeviceOwner ein Element mit Namen DeviceName. DeviceOwner muss den Systemtyp IComosDDevice haben. Element ist nicht vorhanden: Element wird erzeugt Element ist vorhanden: Stammobjektzeiger wird bearbeitet wie im folgenden Schritt beschrieben In den Stammdaten ein Stammobjekt gesucht gemäß CDeviceOwnerFullname und CDeviceDescription. Das Stammobjekt wird Element als Stammobjektzeiger gesetzt SetUnit Setzt den Unit-Pointer für ein Comos-Objekt SetUnit(ByVal ComosObject As IComosBaseObject, ByVal PointerObj As Object, Optional ByVal WithMsg As Boolean = False) As Boolean Programmierhandbuch, 05/2016 V 10.2, A5E AA 43

44 2.2 Public Sub ComosObject Das Comos-Objekt, für das der Unit-Pointer gesetzt werden soll. PointerObj Der Unit-Pointer, der gesetzt werden soll. WithMsg Ist optional und legt fest, ob eine Fehlermeldung angezeigt werden soll. Ist "True", wenn die Operation erfolgreich war XObjInheritParent Berechnung der XObject-Quelle XObjInheritParent ( ByVal XObjContainer as IComosBaseObject ) as IComosDCDevice XObjContainer (IComosBaseObject) Das COMOS-Objekt Ermittelt für das angegebene COMOS-Objekt das Stammobjekt, das die Vererbungsquelle von XObject ist. Unterstützte Typen: IComosDCDevice, IComosDDevice. 2.2 Public Sub CheckElementsAfterCDeviceChange Stammobjektwechsel bei den Elementen CheckElementsAfterCDeviceChange ( ByVal Device as IComosDDevice, ByVal CDeviceOld as IComosDCDevice ) Device (IComosDDevice) Das COMOS-Objekt vom Systemtyp Device, dessen Stammobjekt gewechselt wurde CDeviceOld (IComosDCDevice) Das alte Stammobjekt 44 Programmierhandbuch, 05/2016 V 10.2, A5E AA

45 2.3 Public Property Die Routine führt für jedes alte Element des Device ein Stammobjektwechsel auf das jeweilige neue Element-Stammobjekt durch. Dabei werden bei den neuen Elementen auch dereferenzierte Elemente (letzte Stufe der Referenzierung) berücksichtigt, falls die Dereferenzierung-Einstellung am Element gesetzt ist. Ausnahme: bei Elementen mit Anlegemodus Block, Gruppe und Struktur findet kein Wechsel statt. Hier wird die Projektoption "Verhalten von Elementen bei Stammobjektwechsel" ausgewertet. In Abhängig dieser Projektoption gibt es zwei Fälle: Element wird sofort gelöscht Element wird vom alten Stammobjekt übernommen, falls es eine Namensgleichheit existiert und es nicht um ein virtuelles Element geht CheckDocumntsAfterCDeviceChange Prüfung auf Löschen von Dokumenten CheckDocumntsAfterCDeviceChange ( ByVal Device as IComosDDevice, ByVal CDeviceOld as IComosDCDevice ) Device (IComosDDevice) Das COMOS-Objekt des Systemtyp Document, dessen Stammobjekt gewechselt wurde CDeviceOld (IComosDCDevice) Das alte Stammobjekt Die Routine prüft nach dem Stammobjektwechsel für jedes Dokument des Device den Status. Name des Dokumentes ist beim alten und neuen Stammobjekt gleich: Das Dokument bleibt erhalten. Alle sonstigen Dokumente: Die Dokumente werden in die ErrorObjects-Liste eingetragen. Der Anwender entscheidet, was mit den Dokumenten in der Fehlerliste geschieht. 2.3 Public Property AllowMultipleRequests Steuerung der Mehrfachimplementierung AllowMultipleRequests ( ) as Boolean Die Property steuert, ob mehrere Anforderungen an dem Implementation-Zeiger eines Devices gesetzt werden können. Programmierhandbuch, 05/2016 V 10.2, A5E AA 45

46 2.3 Public Property ITC_SYSCATEGORIE Intern ITC_SYSCATEGORIE ( ) as String Interne Konstante ITC_SYSSHIELD Intern ITC_SYSSHIELD ( ) as String Interne Konstante CurrentMessagePack Zugehörigkeit zum MessagePack CurrentMessagePack ( ) as Object Liefert die aktuelle MessagePack-Membervariable zurück MaxRunLevels Intern MaxRunLevels ( ) as Integer Intern. 46 Programmierhandbuch, 05/2016 V 10.2, A5E AA

47 Klasse: Implement Implement Properties ITC_RequestInfo ITC_RequestInfo ( ) as String Intern. 3.2 Public Functions CheckConnectors Überprüft Anschlüsse anhand ihrer Namen, Typen und Subtypen CheckConnectors(ByVal DeviceFrom As IComosDDevice, ByVal DeviceTo As IComosDDevice, ByVal ConnectorType As String) As Integer DeviceFrom Ist ein Basisplanungsobjekt, dessen Anschlüsse gegen ein anderes Planungsobjekt geprüft werden sollen. DeviceTo Ist das Planungsobjekt, gegen das geprüft werden soll. ConnectorType Der Anschlusstyp, gegen den geprüft wird. 0 Prüfung ist OK. 4 Die Planungsobjekte haben unterschiedliche Anschlüsse. 8 Die Anschlüsse haben unterschiedliche Typen. 9 Die Anschlüsse haben unterschiedliche Subtypen. Programmierhandbuch, 05/2016 V 10.2, A5E AA 47

48 Klasse: Implement 3.2 Public Functions CheckSpecificationsValue Überprüft die Attribute von Planungsobjekten im Hinblick auf deren Inhalt CheckSpecificationsValue(ByVal DeviceFrom As IComosDDevice, ByVal DeviceTo As IComosDDevice, ByVal SpecNestedName As String) As Integer DeviceFrom Ist ein Basisplanungsobjekt, dessen Attribute gegen ein anderes Planungsobjekt geprüft werden sollen. DeviceTo Ist das Planungsobjekt, gegen das geprüft werden soll. SpecNestedName Der Name des Attributs, gegen das geprüft werden soll. 0 Die Prüfung war erfolgreich. 11 Es sind unterschiedliche Attribute vorhanden. 12 Die Attribute haben unterschiedliche Werte DisconnectOldRequest Löst eine Implementierung DisconnectOldRequest(ByVal Implementation As IComosDDevice) As IComosDDevice Implementation Ist ein Planungsobjekt. Ist das Planungsobjekt, das die gelöste Anforderung ist. 48 Programmierhandbuch, 05/2016 V 10.2, A5E AA

49 Klasse: Implement 3.2 Public Functions EnableRestore Teilt mit, ob das Lösen einer Implementierung möglich ist EnableRestore(ByVal Implementation As IComosDDevice, ByVal Request As IComosDDevice) As Boolean Implementation Ist das Echtgerät, das implementiert wurde. Request Ist die Anforderung, auf die implementiert wurde. Ist "True", wenn die Operation erfolgreich war InfoText Liefert Information zur Ergebnisnummer InfoText(ByVal NumberCode As Integer) As String NumberCode Ist die Ergebnisnummer. Informationstext IsEnabledRestoreRequest Gibt an, ob ein Planungsobjekt die Information zum Wiederherstellen einer Anforderung besitzt IsEnabledRestoreRequest(ByVal Implementation As IComosDDevice) As Boolean Implementation Ist das Planungsobjekt, das als Echtgerät fungiert. Programmierhandbuch, 05/2016 V 10.2, A5E AA 49

50 Klasse: Implement 3.2 Public Functions Ist "True", wenn die Operation erfolgreich war IsUsedAsImplementation Prüft, ob das Objekt schon als Implementierung an einem anderen Objekt gesetzt ist IsUsedAsImplementation(ByVal Device As IComosDDevice) As Boolean Device Das zu prüfende Planungsobjekt. Ist "True", wenn die Operation erfolgreich war IsUsedAsRequest Prüft, ob ein Objekt eine Implementierung besitzt IsUsedAsRequest(ByVal Device As IComosDDevice) As Boolean Device Das zu prüfende Planungsobjekt. Ist "True", wenn die Operation erfolgreich war. 50 Programmierhandbuch, 05/2016 V 10.2, A5E AA