Holarch

Kılavuz · SysML v2

Bir SysML v1 modelini SysML v2'ye taşımak: adım adım bir geçiş

Bir SysML v1 modeli otomatik olarak SysML v2'ye dönüştürülebilir, ancak bir geçiş bir dosya dönüştürmesinden fazlasıdır: birinin dönüştürülmüş modelin nasıl görünmesi gerektiğine karar vermesi ve v1 modelinin söylediğini hâlâ söyleyip söylemediğini denetlemesi gerekir. Bu kılavuz, v1 modelinin envanterini çıkarmaktan geçişi tamamlamaya kadar sekiz adımda bir geçişi anlatır; küçük bir model dönüştürülür ve satır satır okunur.

Bu sayfada
  1. Başlamadan önce: yükseltme değil, bir çeviri
  2. 1. v1 modelinin envanterini çıkarın
  3. 2. Modeli SysML v1 aracından dışa aktarın
  4. 3. Bir pilot paketi dönüştürün
  5. 4. Dönüştürme raporunu okuyun
  6. Çözümlü bir örnek: küçük bir gezgin araç modeli
  7. 5. Yaklaşık dönüştürülen veya dışarıda bırakılanları yeniden işleyin
  8. 6. Önemli görünümleri yeniden oluşturun
  9. 7. v2 modelini denetleyin ve inceleyin
  10. 8. Geri kalanını dönüştürün ve geçişi tamamlayın
  11. Geçiş denetim listesi
  12. Sonra nereye gidilir

Başlamadan önce: yükseltme değil, bir çeviri

SysML v2, SysML v1 dosya biçiminin yeni bir sürümü değil, yeni bir dildir. Bloklar part definition olur, portlar port definition ile tiplenir, gereksinimler koşullar taşır ve diyagramlar modelin tanımladığı görünümler olur. SysML v1 ile v2 farkları tek tek açıklar.

Bir dönüştürücü mekanik kısmı yapar: SysML v2 karşılığı olan her öğe SysML v2'de yazılır ve geri kalanı raporlanır. Bir dönüştürücünün yapamadığı şey, ekibinizin yeni dili nasıl kullanmak istediğine karar vermektir. Geçişi bir sahibi, bir incelemesi ve v2 modelinin referans hâline geldiği bir noktası olan bir modelleme görevi olarak planlayın.

Bu kılavuz, bir SysML 1.x modelini bir SysML v2 projesine içe aktaran ve her öğeyi dönüştürüldü, yaklaşık veya dışarıda bırakıldı olarak raporlayan Holarch'ın dönüştürücüsünü kullanır. Planlama adımları hangi dönüştürücüyü kullanırsanız kullanın geçerlidir.

1. v1 modelinin envanterini çıkarın

Herhangi bir şeyi dışa aktarmadan önce modelin ne içerdiğini ve ona kimin bağlı olduğunu öğrenin. Kısa bir envanter daha sonraki yeniden çalışmayı önler.

  • Paketler ve sahipleri. En üst düzey paketleri, her birini kimin sürdürdüğünü ve diğer modellerin veya belgelerin hangilerine atıfta bulunduğunu listeleyin. Paketler, dönüştüreceğiniz ve inceleyeceğiniz birimdir.
  • Önemli diyagramlar. İnsanların incelemelerde ve belgelerde gerçekten kullandığı diyagramları not edin. Diyagram yerleşimleri SysML v2'ye aktarılmaz, bu yüzden bunlar yeniden oluşturacağınız görünümler olur.
  • Profiller ve stereotipler. Kendi stereotiplerinizi ve etiketli değerlerini listeleyin. Bunlar metadata definition olur ve yeni modeldeki anlamları üzerinde yeniden uzlaşılması gerekir.
  • Kod olarak yazılmış davranış. OCL'deki, bir eylem dilindeki veya bir aracın betik dilindeki opak davranışlar, koşullar ve kısıtlar özgün dillerinde metin olarak tutulur; çevrilmezler.
  • Adsız öğeler. Adı olmayan öğelere işaret eden ilişkiler, öğelere adlarıyla atıfta bulunan SysML v2 metninde yazılamaz. İz sürdüğünüz öğeleri şimdi, v1 aracında adlandırın.
  • Boyut. Holarch bir seferde en fazla 64 MB ve 250.000 öğelik bir dosya dönüştürür. Daha büyük modeller paket paket dışa aktarılır.

2. Modeli SysML v1 aracından dışa aktarın

Dönüştürücü, modeli SysML v1 araçlarının yazdığı değişim biçimi olan XMI'dan okur. Her araç onu biraz farklı dışa aktarır:

AraçNe içe aktarılmalı
Cameo Systems Modeler, MagicDraw.mdzip proje dosyası veya File → Export To → Eclipse UML2 (v5.x) XMI File ve .xmi dosyası
Enterprise ArchitectPaketi seçin, Publish → Export XML, XMI 2.1'i seçin ve .xml dosyasını içe aktarın. Proje dosyaları (.eap, .qea) doğrudan okunmaz.
IBM RhapsodyXMI araç takımından bir XMI 2.x dışa aktarımı
Eclipse PapyrusModelin .uml dosyası

Dışa aktarılan dosyayı geçiş kayıtlarıyla birlikte saklayın: incelemenizin başvurduğu tam v1 girdisidir.

3. Bir pilot paketi dönüştürün

Temsil edici ama en büyük olmayan bir paketle başlayın: yapısı, arayüzleri, bir miktar davranışı ve gereksinimleri olan bir alt sistem. Pilot, tüm ekibi buna adamadan önce modelinizin dönüştürmesinin nasıl göründüğünü gösterir.

  1. Bir SysML v2 projesi oluşturun veya dönüştürülen modelin gireceği projeyi açın ve Model → İçe ve dışa aktarma düğmesine tıklayın.
  2. İçe aktar altında bir pilot için Yeni bir SysML v2 projesine seçin; böylece başka hiçbir şeye dokunulmaz.
  3. Dışa aktarılan dosyayı kutuya bırakın. Bir ilerleme kartı aşamaları gösterir: XMI dosyasını okuma, SysML v2'ye dönüştürme, sonucu denetleme.

Henüz hiçbir şey içe aktarılmadı. Sonraki ekran, dönüştürme raporuyla birlikte önizlemedir.

4. Dönüştürme raporunu okuyun

Önizlemenin üstündeki SysML v1'den dönüştürme, dönüştürülen, yaklaşık dönüştürülen ve dışarıda bırakılan öğelerin sayısını ve SysML v2 metninin sorunsuz denetlenip denetlenmediğini verir. v1 modelinin her öğesinin bir sonucu vardır:

  • Dönüştürüldü: öğenin doğrudan bir SysML v2 karşılığı vardır; örneğin bir part def olan bir blok.
  • Yaklaşık: öğe değiştirilmiş bir biçimde tutulur; örneğin bir seçim üzerinden geçen bir geçiş, yol başına bir geçiş olur. Bunlar anlamın v1 modelinden farklı olabileceği yerlerdir.
  • Dışarıda bırakıldı: SysML v2'de bir karşılığı yoktur veya öğe dosyada bulunmayan bir şeye işaret eder.

Yaklaşık dönüştürülen ve dışarıda bırakılan öğeleri listelemek için Göster kullanın. Her satır öğeyi, SysML v1 türünü, SysML v2 adıyla neye dönüştüğünü ve nedenini verir. Sonucu okumak için SysML v2 metnini göster bölümünü açın ve raporu bir CSV dosyası olarak saklamak için Raporu indir düğmesine tıklayın. CSV, 5. adımın iş listesidir: nedene göre sıralayın ve her gruba bir sahip atayın.

Çözümlü bir örnek: küçük bir gezgin araç modeli

Bir gezegen gezgini aracının güç yolunun üç paketten oluşan küçük bir SysML v1 modeli:

PaketSysML v1 öğeleri
TypesW birimli bir değer türü Power; bir blok Charge; iki giden akış özelliği olan bir arayüz bloğu Power Interface: charge (bir Charge) ve voltage (bir Real)
Yapıbattery ve computer parça özellikleri, 120 W'lık bir power budget değer özelliği, portları arasında bir bağlayıcı power bus ve onun üzerinde Charge taşıyan bir öğe akışı power flow içeren kapsüllenmiş bir blok Rover. Bir proxy portu out olan bir blok Battery; eşlenik bir proxy portu in ve bir tam portu raw olan bir blok Computer. İkisi de etiketli değerlerle bir kullanıcı stereotipi «Hardware» taşır. Ucu ilişkilendirmeye ait olan bir ilişkilendirme.
GereksinimlerR-1 Mission ve R-2 Power Margin gereksinimleri; R-2, R-1'den türetilmiş; R-2 battery parçası tarafından karşılanır; Computer'dan Battery'ye bir iz

Dönüştürüldüğünde şöyle okunur. Listeleme, dönüştürücünün çıktısıdır, değiştirilmemiştir:

package 'Rover Model' {
  package Types {
    attribute def Power :> ISQ::PowerValue;
    part def Charge;
    port def 'Power Interface' {
      out item charge : Charge;
      out attribute voltage : ScalarValues::Real;
    }
  }
  package Structure {
    part def Rover {
      doc /* Six-wheeled science rover. */
      @SysMLv1Library::BlockData { isEncapsulated = true; }
      part battery : Battery;
      part computer : Computer;
      attribute 'power budget' : Types::Power = 120 [SI::W];
      connection 'power bus' connect battery.'out' to computer.'in';
      satisfy Requirements::'Power Margin' by battery;
      flow 'power flow' of Types::Charge from battery.'out' to computer.'in';
    }
    part def Battery {
      @'SysML v1 Profiles'::rov::Hardware { qualified = "true"; vendor = "Acme Cells"; }
      port 'out' : Types::'Power Interface';
      attribute capacity : Types::Power;
    }
    part def Computer {
      @'SysML v1 Profiles'::rov::Hardware { vendor = "Orbital Logic"; }
      port 'in' : ~Types::'Power Interface';
      part raw : Types::Charge {
        @SysMLv1Library::PortData { isFullPort = true; }
      }
    }
  }
  package Requirements {
    requirement <'R-1'> Mission {
      doc /* The rover shall explore the landing site. */
    }
    requirement <'R-2'> 'Power Margin' {
      doc /* Keep a 50 % power margin. */
    }
    connection : DerivationConnections::Derivation connect 'Power Margin' to Mission;
    dependency from Structure::Computer to Structure::Battery {
      @SysMLv1Library::TraceData { isTrace = true; }
    }
  }
}

package 'SysML v1 Profiles' {
  package rov {
    metadata def Hardware {
      attribute qualified : ScalarValues::String;
      attribute vendor : ScalarValues::String;
    }
  }
}

v1 modelinin her bölümüne ne oldu:

  • Birimli değer türü. Watt cinsinden Power, standart kitaplığın ISQ::PowerValue türünü özelleştirir ve varsayılan değer birimiyle yazılır: 120 [SI::W]. Birimi eşlenmiş bir SI birimi olmayan bir değer türü, birimi belgelerinde yazılı olarak bir reel sayı kalır ve yaklaşık olarak raporlanır.
  • Bloklar ve özellikler. Bloklar part def olur, parça özellikleri part olur. Bloğun isEncapsulated özelliğinin SysML v2'de anahtar sözcüğü yoktur; bu yüzden SysMLv1Library::BlockData meta verisi olarak tutulur.
  • Arayüz bloğu ve portlar. Arayüz bloğu, akış özellikleri yönlü öznitelikler olan bir port def olur: blok tipli olan için out item, değer için out attribute. Eşlenik proxy portu ~Types::'Power Interface' ile tiplenir. Tam port SysMLv1Library::PortData meta verisiyle bir parça olur, çünkü bir SysML v2 portu bir port definition ile tiplenir.
  • Bağlayıcı ve öğe akışı. Bağlayıcı iki port arasında bir connection olur, üzerindeki öğe akışı da aynı portlar arasında Charge taşıyan bir flow olur.
  • Gereksinimler. Her gereksinim kimliğini kısa ad olarak, <'R-1'>, metnini de doc olarak korur. Satisfy ilişkisi, karşılayan parçaya sahip olan bloğun içinde yer alır; derive ilişkisi bir türetme bağlantısı olur; iz, SysMLv1Library::TraceData ile bir bağımlılık olur.
  • Kullanıcı stereotipi. «Hardware», 'SysML v1 Profiles' paketinde bir metadata def olur ve etiketli değerleriyle her bloğa uygulanır. İki uygulaması yaklaşık olarak raporlanır: etiket değerleri, profildeki türleri ne olursa olsun metin özniteliklerine dönüştü.
  • İlişkilendirme. Sınıfı olmayan bir ilişkilendirmenin burada SysML v2 karşılığı yoktur ve ilişkilendirmeye ait ucu da dönüştürülmez. İkisi de dışarıda bırakıldı olarak raporlanır; yapıyı bloklardaki özellikler taşır.

Bu modelin raporu: 31 öğe, 27 dönüştürüldü, 2 yaklaşık, 2 dışarıda bırakıldı ve metin hiç hata ve uyarı olmadan denetlenir. 'power budget' veya 'out' (bir SysML v2 anahtar sözcüğü) gibi düz tanımlayıcı olmayan adlar, v1 yazımlarını korumaları için tırnak içine alınır.

5. Yaklaşık dönüştürülen veya dışarıda bırakılanları yeniden işleyin

Raporun yaklaşık ve dışarıda bırakılan satırlarını nedene göre gözden geçirin. Çoğu neden birkaç karardan birini gerektirir:

Raporun söylediğiNeye karar verilmeli
Bir port, arayüz bloğu olmayan bir blokla tiplenmiş; tipsiz bir port olduSınırı geçen özelliklerle bir port definition tanımlayın ve portu onunla tipleyin.
Bir seçim, kavşak, çatal veya birleşme üzerinden geçişler; her yol bir geçiş olduBirleştirilen koşulların v1 diyagramının kastettiğini hâlâ söyleyip söylemediğini denetleyin; yolların artık daha kolay okunduğu yerlerde sadeleştirin.
Bir tetikleyici belge olarak tutulduAnlamın açık olduğu yerlerde değişiklik ve zaman tetikleyicilerini, bir süreden sonra accept after gibi SysML v2 tetikleyicileri olarak yeniden yazın.
Bir birim, Holarch'ın eşlediği bir SI birimi değil; değer türü bir reel sayıStandart bir niceliğin uyup uymadığına karar verin veya reel sayıyı ve belgelenmiş birimi koruyun.
Çağrı, opak veya kabul eylemi dışında bir eylem türü düz bir eylem olduGönderme ve diğer özel eylemleri aynı işi yapan SysML v2 eylemiyle yeniden yazın.
Faaliyet bölümleri dönüştürülmezBir kulvar yerine, hangi parçanın ne yaptığını parçanın içinde perform ile belirtin.
Adı olmayan bir öğeye işaret ediyorHedefi v1 aracında adlandırıp yeniden dönüştürün veya ilişkiyi v2 modelinde ekleyin.
Adı aynı yerde iki kez kullanılıyor; bir sonekle yeniden adlandırıldıHer öğeye ne olduğunu söyleyen bir ad verin.
Etiketli değerler meta verinin metin öznitelikleri olduMeta veri özniteliklerine ihtiyaç duydukları türleri verin ve her stereotipin artık ne anlama geldiği konusunda uzlaşın.

İki tür metin, sorunsuz dönüştürülse bile bir göz atmayı gerektirir. Opak gövdeler, language "OCL" /* … */ gibi özgün dillerinde metinsel temsiller olarak tutulur; Holarch yalnızca SysML veya KerML ile yazılmış gövdeleri denetler, bu yüzden modelin değerlendirmesi gereken yerlerde bir koşulu veya kısıtı bir SysML ifadesi olarak yeniden yazın. Ve birebir çeviriler v1 geçici çözümlerini korur; örneğin yalnızca bir değer ayarlamak için yapılmış özelliğe özgü türler: SysML v2'de bunlar kullanımlar üzerindeki düz yeniden tanımlamalardır. Yeniden düşünülmesi gerekenler yaygın olanları listeler.

6. Önemli görünümleri yeniden oluşturun

Diyagramlar ve yerleşimleri dönüştürülmez. 1. adımdaki diyagram listesini alın ve hâlâ gereken her biri için bir görünüm oluşturun: yapı ve gereksinimler için bir general view, parçalar ve bağlantılar için bir interconnection view, faaliyetler için bir action flow view, durum makineleri için bir state transition view. Yalnızca insanların kullandığını yeniden oluşturun; model her durumda diğer her şeyi tutar. Bkz. görünümler başvurusu.

7. v2 modelini denetleyin ve inceleyin

  • Metin sorunsuz denetlenir. İçe aktarma, herhangi bir şey değişmeden önce dönüştürülen metnin denetimini gösterir; yeniden işlemenizden sonra Düzenleyici siz yazarken yeni sorunları işaretler.
  • Sayılar eşleşir. v1 modeli ile v2 modeli arasında birkaç sayıyı karşılaştırın: gereksinimler, parçalar, portlar, bağlantılar, doğrulama ilişkileri. Rapordan açıklayamadığınız bir fark bakmaya değer.
  • Modeli kullanan kişiler onu inceler. Pilot paketi sahipleriyle birlikte, yaklaşık dönüştürülen öğelerden ve yeniden oluşturulan görünümlerden başlayarak gözden geçirin.
  • Kararları kaydedin. Portlar, tetikleyiciler, birimler ve stereotipler için üzerinde karar kıldığınız modelleme kalıplarını yazın; böylece geçişin geri kalanı onları izler.

8. Geri kalanını dönüştürün ve geçişi tamamlayın

Kalan paketleri birer birer aynı SysML v2 projesine dönüştürün. Her içe aktarma aynı önizlemeyi gösterir: projede zaten bulunan bir paket Değişti veya Değişmedi, yeni bir paket Yeni olarak görünür ve hangi paketlerin içe aktarılacağını siz seçersiniz. Her içe aktarma bir geri alma adımıdır.

v2 modeli incelenene kadar v1 modelini referans olarak tutun, ardından onu dondurun ve SysML v2 projesini kayıt modeli yapın. O noktadan itibaren değişiklikler yalnızca v2 modeline girer.

Geçiş denetim listesi

  • Paketler, sahipler ve önemli diyagramlar listelendi.
  • İlişkilerin işaret ettiği öğelerin adları var.
  • Dışa aktarılan XMI dosyası geçiş kayıtlarıyla birlikte saklanıyor.
  • Bir pilot paket dönüştürüldü, raporu indirildi ve her yaklaşık ve dışarıda bırakılan satır için bir karar var.
  • Portlar, tetikleyiciler, birimler ve stereotipler için modelleme kalıpları yazıldı.
  • Gereken görünümler yeniden oluşturuldu; metin sorunsuz denetleniyor.
  • Modelin kullanıcıları pilotu inceledi.
  • Kalan paketler aynı şekilde dönüştürüldü ve v1 modeli donduruldu.

Sonra nereye gidilir

Cameo Systems Modeler, MagicDraw, Enterprise Architect, Rhapsody ve Eclipse Papyrus ilgili sahiplerinin ticari markalarıdır. Holarch onlarla bağlantılı değildir ve onlar tarafından onaylanmamıştır.