Holarch

SysML v2

SysML v2 텍스트 표기법

Holarch가 지원하는 SysML v2 언어를 Hybrid Car 데모의 예제와 함께 설명하고, 실행되는 검사와 읽기 전용 표준 라이브러리를 소개합니다.

사용 방법 →

이 페이지의 내용
  1. 개요
  2. 개념
    1. 요소, 소유자, 정규화된 이름
    2. 패키지
    3. 임포트와 가시성
    4. 정의와 사용
    5. 타입 지정, 특수화, 재정의
    6. 다중성
    7. 값과 단위
    8. 구조: 포트, 연결, 인터페이스, 바인딩, 흐름
    9. 동작: 액션
    10. 동작: 상태
    11. 요구사항, 제약 조건, 검증
    12. 유스케이스
    13. 뷰
    14. 주석, 문서화, 메타데이터
    15. 개체, 스냅샷, 타임 슬라이스
    16. 가변 요소, 변형, 구성
    17. 텍스트 표현
  3. 사용 방법
    1. 구조 모델링하기
    2. 단위와 함께 값 지정하기
    3. 동작 기술하기
    4. 요구사항을 작성하고 추적하기
    5. 값을 TBD 또는 TBR로 표시하기
    6. 라이브러리 이름 찾기
  4. 예제: 세단의 요구사항 읽기
  5. 팁과 흔한 실수
  6. Holarch가 지원하는 것
    1. 해석하지 않고 작성된 그대로 보존됨
    2. 아직 사용할 수 없음
  7. 검사
  8. 표준 라이브러리
  9. 제한 사항
  10. 관련 페이지

개요

SysML v2는 시스템을 이름 있는 요소의 트리로 기술하며, 이를 텍스트로 작성합니다. Holarch는 OMG SysML v2 사양에 기반한 SysML v2 텍스트 표기법을 지원합니다. 텍스트는 편집기에서 작성하며, Holarch는 같은 요소를 브라우저, 뷰, 표, 수명 주기 페이지에 표시합니다.

이 페이지는 Hybrid Car(SysML v2) 데모의 예제로 표기법을 설명합니다. 그런 다음 Holarch가 지원하는 내용, 텍스트에 대해 실행하는 검사, 표준 라이브러리를 나열합니다.

개념

요소, 소유자, 정규화된 이름

최상위 패키지를 제외한 모든 요소에는 소유자가 하나 있습니다. 요소의 정규화된 이름은 소유자 이름을 차례로 ::로 이은 것입니다. 데모에서 파워트레인 정의의 배터리는 Vehicles::Powertrain::battery입니다.

공백이나 기타 특수 문자가 있는 이름은 작은따옴표로 묶습니다: 'Fuel Tank'. 꺾쇠괄호 안의 짧은 이름은 요소에 두 번째의 짧은 식별자를 줍니다: requirement def <'VR-1'> CurbMass. Holarch는 요구사항의 짧은 이름을 그 번호로 사용합니다.

패키지

패키지는 폴더처럼 요소를 묶습니다. 패키지는 중첩할 수 있습니다. 각 최상위 패키지는 편집기에서 문서 하나입니다.

package Vehicles {
    doc /* A hybrid passenger car: structure, interfaces and variants. */

    private import ScalarValues::*;
    private import ISQ::*;
    private import SI::*;
}

임포트와 가시성

임포트는 다른 패키지의 멤버를 짧은 이름으로 볼 수 있게 합니다.

  • import ISQ::*;는 ISQ의 멤버를 임포트합니다.
  • import VehicleRequirements::**;는 중첩된 요소의 멤버까지 임포트합니다(재귀).
  • import Vehicles::Car;는 요소 하나를 임포트합니다.
  • import Vehicles::*[@SysML::PartDefinition];은 한 종류의 멤버만 임포트합니다(필터링된 임포트).

private, protected, public은 멤버나 임포트를 다른 누가 볼 수 있는지 정합니다. 데모는 private import를 써서, 이 패키지를 다시 임포트하는 패키지로 임포트가 전달되지 않게 합니다.

임포트 없이 쓰려면 정규화된 이름을 씁니다. ISQ::MassValue는 어디서나 확인되지만, MassValue는 ISQ가 임포트된 곳에서만 확인됩니다.

alias는 요소에 두 번째 이름을 줍니다: alias Hybrid for Car;.

정의와 사용

정의는 어떤 종류의 것을 기술합니다. 사용은 다른 요소 안에서 정의를 한 번 사용한 것입니다. 대부분의 키워드는 두 형태로 존재합니다.

정의사용의미
part def Battery;part battery : Battery;시스템, 서브시스템 또는 구성 요소
attribute def TirePressure;attribute mass : MassValue = 45 [kg];값(흔히 단위 포함)
item def Fuel;item fuel : Fuel;흐르거나 다루어지는 것
port def FuelPort { … }port fuelOut : FuelPort;파트의 연결 지점
connection def … / interface def FuelLine { … }interface fuel : FuelLine connect …;파트나 포트 사이의 연결
action def ProduceTorque { … }action produce : ProduceTorque;동작: 입력을 받아 출력을 내는 단계
state def PowertrainStates { … }state off;동작: 상태와 그 전이
constraint def MassLimit { … }constraint …;값에 대한 Boolean 조건
calc def PowerToWeight { … }calc …;return 값이 있는 계산
requirement def <'VR-1'> CurbMass { … }requirement <'VR-1.1'> sedanMass : CurbMass;요구사항
use case def DriveToWork { … }use case commute : DriveToWork;유스케이스
analysis def PowerToWeightAnalysis { … }analysis sedanPowerToWeight : …;분석 케이스
verification def CurbMassTest { … }verification sedanWeighing : CurbMassTest;검증 케이스
view def RequirementsView { … }view driveCycleFlow : ActionFlowView { … }모델의 뷰
enum def DriveMode { … }attribute mode : DriveMode;고정된 값의 집합

정의 안에 중첩된 멤버는 그 정의의 모든 사용에 속합니다. part frontAxle : Axle;은 Axle의 differential, leftWheel, rightWheel을 반복하지 않고도 가집니다.

타입 지정, 특수화, 재정의

네 가지 연산자가 정의와 사용을 관계 짓습니다. 각 연산자에는 키워드 형태도 있습니다.

연산자키워드의미예
:defined by사용의 타입을 정의로 지정합니다part engine : Engine;
정의에 쓰인 :>specializes정의가 다른 정의의 한 종류이며 그 멤버를 상속합니다part def FuelTank :> Component
사용에 쓰인 :>subsets사용이 다른 사용의 부분 집합입니다part spareWheel :> wheels;
:>>redefines상속된 사용을 대체합니다(예: 값을 주기 위해)attribute redefines mass = 18 [kg];
~포트를 켤레로 만듭니다. 포트의 in과 out 피처가 서로 바뀝니다port fuelIn : ~FuelPort;

재정의는 변형이나 구성된 파트가 상속받은 것을 바꾸는 방법입니다. 데모에서 SportCar는 재정의로 스페어 휠을 없앱니다.

part def SportCar :> Car {
    attribute topSpeed : SpeedValue = 210 [km/h];
    part redefines spare [0];
}

abstract는 직접 인스턴스가 없는 정의를 표시합니다(abstract part def Component). ref는 소유되지 않는 참조를 표시합니다. in, out, inout은 피처나 매개변수의 방향을 정합니다. end는 연결 또는 인터페이스 정의의 끝을 표시합니다.

다중성

대괄호 안의 다중성은 개수를 나타냅니다.

  • [2]: 정확히 두 개. part runabout : CityCar [2];
  • [0..1]: 선택 사항. part spare : Wheel [0..1];
  • [1..*]와 [*]: 하나 이상, 개수 제한 없음.
  • [0]: 없음. 상속된 파트를 없앨 때 사용합니다.
  • 경계에는 식을 쓸 수 있습니다. ordered와 nonunique는 대괄호 뒤에 옵니다.

값과 단위

=는 값을 바인딩합니다. :=는 바뀔 수 있는 초기값을 줍니다. default는 재정의로 대체할 수 있는 기본값을 줍니다.

attribute maxCurbMass : MassValue = 1650 [kg];
attribute minBatteryCapacity : EnergyValue = 1.2 [kW*h];
attribute minPowerToWeight = 40 [W/kg];
attribute topSpeed : SpeedValue = 210 [km/h];

수량은 대괄호 안에 단위가 있는 숫자입니다. 단위는 *, /, ^로 조합합니다([m/s^2]). MassValue 같은 수량 종류는 ISQ에서, kg 같은 단위는 SI(또는 USCustomaryUnits)에서 옵니다. Holarch는 차원을 검사하므로 MassValue에 5 [s]를 지정하면 오류입니다.

식에는 산술, 비교(<=, ==), 논리 연산자(and, or, not, implies), 조건식 if c ? a else b, 피처 체인(car.powertrain.battery.capacity), 계산 호출(PowerToWeight(power, mass)), 그리고 ->sum, ->size, ->select, ->collect 같은 시퀀스 연산을 사용합니다. Holarch는 값, 제약 조건, 뷰, 분석 페이지에서 단위와 함께 식을 평가합니다.

구조: 포트, 연결, 인터페이스, 바인딩, 흐름

파트는 포트를 통해 연결됩니다.

part def Powertrain {
    part tank : FuelTank;
    part engine : Engine;
    interface fuel : FuelLine connect tank.fuelOut to engine.fuelIn;
    connect controller.engineCtl to engine.ecu;
    port output : TorquePort;
    bind output = transmission.output;
}
  • connect a to b;는 두 파트나 포트를 잇습니다.
  • 인터페이스는 포트 사이의 타입이 있는 연결입니다. 인터페이스 정의는 끝에 이름을 붙입니다: interface def FuelLine { end supply : FuelPort; end consumer : ~FuelPort; }.
  • 연결이나 인터페이스의 각 끝에는 이름과 다중성을 줄 수 있습니다: interface motorShaft : Shaft connect [1] driver ::> motor.output to [1] driven ::> transmission.motorIn;. 이름 있는 끝은 연결의 피처이므로 motorShaft.driver로 참조합니다.
  • bind a = b;는 두 피처가 같다는 것을 나타냅니다(바인딩 커넥터).
  • flow of Fuel from supply.fuel to produce.fuel;은 한 피처에서 다른 피처로 아이템을 운반합니다. message는 파트 사이에 아이템을 이벤트로 보냅니다.

동작: 액션

액션 정의는 단계(액션 사용), 매개변수, 단계의 순서를 담습니다.

action def DriveCycle {
    in attribute targetSpeed : Real;
    first start then switchOn;
    action switchOn { attribute duration : DurationValue = 2 [s]; }
    then fork split;
    then supply;
    then produce;
    action supply : SupplyFuel;
    action produce : ProduceTorque;
    flow of Fuel from supply.fuel to produce.fuel;
    first supply then ready;
    first produce then ready;
    join ready;
}
  • 후속 관계는 단계의 순서를 정합니다: first a then b;, 또는 a 바로 뒤의 then b;. start와 done은 시작과 끝입니다.
  • 제어 노드: 병렬 경로에는 fork와 join, 대안에는 decide와 merge를 씁니다. 결정 뒤의 가드가 있는 후속 관계는 if speed > 30 then cruise;로 쓰며, else brake;는 기본 분기입니다.
  • 종료: terminate;는 둘러싼 액션을 아직 실행 중인 단계와 함께 즉시 끝냅니다. then terminate;는 이를 이전 단계 뒤에 둡니다. terminate x;는 발생 x를 끝냅니다.
  • 기타 액션: accept는 신호를 기다리고, send는 신호를 보내고, assign x := expr;는 값을 바꾸고, if는 블록을 실행하거나 건너뛰며, while … { … } until …;과 for v in seq { … }는 블록을 반복합니다.
  • 동작의 할당: 파트는 액션을 perform하며(perform action trip : DriveCycle;, perform trip.supply;), allocate a to b;는 한 요소를 다른 요소에 할당합니다.

동작: 상태

상태 정의는 상태와 그 사이의 전이를 담습니다.

state def PowertrainStates {
    entry; then off;
    state off;
    accept StartRequest then hybrid;
    state hybrid {
        entry action startEngine;
        do action driveHybrid;
        exit action stopEngine;
    }
    transition recharged first hybrid if charge > 60 then electric;
}
  • entry; then off;는 초기 상태를 정합니다.
  • 전이에는 트리거(accept StartRequest), 선택적 가드(if charge > 20), 선택적 효과(do …)가 있습니다. 짧은 형태는 원본 상태 뒤에 오고, 긴 형태는 transition name first a … then b;입니다.
  • 모델에서 전이의 트리거와 효과는 독립된 요소입니다. 즉 수신 액션과 액션(send, assign, perform, terminate 또는 이름 있는 액션)입니다. 브라우저는 이를 전이 아래에 trigger와 effect로 표시합니다. 이들은 전이 자신의 accepter와 effect이므로 모델의 다른 부분에서 이름으로 참조할 수 있습니다. chargerStates.plugIn.effect.sentMessage는 시퀀스 모델이 바인딩하는 것처럼 효과가 보내는 메시지입니다.
  • 포트를 통한 트리거는 그 포트가 운반하는 것을 수신해야 합니다. 데모의 ChargeManager에서 accept connectCharger : ChargerConnected via chargePort는 포트의 in connected : ChargerConnected와 일치합니다. 효과 send new ChargeRequest() to controller는 파트로 보냅니다. 속성 같은 값은 메시지를 받을 수 없습니다.
  • entry, do, exit 액션은 상태에 들어갈 때, 상태에 있는 동안, 상태를 떠날 때 실행됩니다. parallel 상태에는 동시에 모두 활성인 영역이 있습니다.
  • 파트는 상태를 exhibit합니다: exhibit state powertrainStates : PowertrainStates;.

요구사항, 제약 조건, 검증

요구사항은 문장을 doc에, 적용 대상 요소를 subject로, 검사 가능한 조건을 require constraint로 담습니다.

requirement def <'VR-1'> CurbMass {
    doc /* The car's curb mass shall not exceed the mass limit. */
    subject car : Car;
    attribute limit : MassValue;
    require constraint { car.curbMass <= limit }
}

satisfy carSpec by fleet.sedan;
  • assume constraint는 요구사항이 가정하는 조건을 나타냅니다. 그 조건이 성립하지 않으면 해당 요구사항과 그 안에 중첩된 요구사항은 충족된 것으로 간주되며, 이를 둘러싼 요구사항과 다른 중첩 요구사항은 계속 검사됩니다. actor, stakeholder, frame concern은 요구사항이 누구와 무엇을 위한 것인지 지정합니다.
  • satisfy R by part;는 파트가 요구사항을 충족한다는 것을 나타냅니다.
  • 검증 케이스는 목표 안에서 요구사항을 검증합니다: objective { verify carSpec.sedanMass; }. return verdict : Boolean = …;을 반환할 수 있습니다.
  • 분석 케이스에는 주제, 목표, 그리고 모든 입력에 값이 있을 때 Holarch가 평가하는 return 결과가 있습니다. 값이 없는 케이스의 속성은 목표의 == 방정식으로부터 풉니다(미지수가 있는 분석 케이스).
  • connection : Derivation connect original to derived;는 파생 요구사항을 기록합니다. #refinement dependency x to R;은 세분화를 기록합니다.
  • dependency from a to b;는 일반적인 추적을 기록합니다.

유스케이스

use case def DriveToWork { subject car : Car; actor driver : Driver; objective { … } include use case startCar : StartCar; }. 유스케이스 사용은 정의의 주제와 액터를 가져옵니다.

뷰

뷰는 모델의 일부를 보여 줍니다. 뷰의 타입은 표준 뷰 정의로 지정하며, 보여 줄 대상을 expose합니다.

view driveCycleFlow : StandardViewDefinitions::ActionFlowView {
    expose DriveCycle;
}

filter는 요소의 범위를 좁힙니다(filter @SysML::RequirementUsage;). render는 렌더링 방식을 선택합니다. viewpoint는 뷰가 다루어야 할 관심사를 정합니다. 각 뷰 종류는 SysML v2 뷰에서 설명합니다.

주석, 문서화, 메타데이터

  • doc /* text */는 소유자를 문서화합니다. 모델의 일부이며, 요구사항에서는 요구사항 텍스트입니다.
  • comment about x /* text */는 다른 요소에 대한 모델 안의 메모입니다.
  • // text와 //* text */는 텍스트에만 있는 메모입니다. Holarch는 이를 텍스트에 유지하지만 모델 요소는 아닙니다.
  • 메타데이터는 요소에 주석을 답니다. 본문 안의 @TBD { owner = "Powertrain lead"; }, 접두사로 쓰는 #TBR attribute limit …, 또는 외부에서 쓰는 metadata Capability about Vehicles::Car;가 있습니다.
  • 사용자 정의 키워드: 어떤 메타데이터 정의든 키워드로 쓸 수 있습니다. #safetyCritical part controller : Controller;는 컨트롤러에 메타데이터 SafetyCritical(짧은 이름 <safetyCritical>)을 표시합니다. 메타데이터 정의는 표시할 수 있는 대상을 제한할 수 있습니다. :>> annotatedElement : SysML::PartDefinition;은 파트 정의만 허용합니다.
  • 의미 메타데이터: SemanticMetadata를 특수화하는 메타데이터 정의는 기본 타입을 정합니다: :>> baseType = faults meta SysML::Usage;. 그러면 이 메타데이터로 표시된 모든 요소가 기본 타입을 특수화합니다. 사용은 기본 사용의 부분 집합이 되고, 정의는 기본 정의 또는 기본 사용의 정의를 특수화합니다. 따라서 #fault def BatteryOverheat;와 #fault overheat : BatteryOverheat;는 결함이며 Fault의 피처를 가집니다. 의미 메타데이터가 있으면 이 두 줄처럼 언어 키워드를 생략할 수 있으며, 브라우저는 이를 키워드와 함께 표시합니다(#fault def). 외부에서 작성한 metadata Fault about x;는 x를 결함으로 만들지 않습니다. 검사가 경고하고 x 자체에 #fault를 표시하도록 제안합니다.
  • 고유한 의미가 있는 메타데이터: 메타데이터 정의의 피처는 그 메타데이터를 사용할 때마다 반드시 지정해야 하는 것이며, 정의의 제약 조건은 그 피처에 대해 성립해야 합니다. metadata def SafetyRating { attribute level : Natural; assert constraint { level >= 1 and level <= 4 } }이 있으면 검사는 @SafetyRating;(level 없음)과 @SafetyRating { level = 7; }(범위 밖)을 보고하며, @SafetyRating { level = 4; }은 문제없습니다. 정의에 값이나 default가 있거나 [0..1]로 선언된 피처는 생략할 수 있습니다. 각 값은 피처의 타입에 맞아야 합니다. Boolean에는 true 또는 false, String에는 따옴표로 묶은 텍스트, Integer에는 정수(Natural은 0 이상, Positive는 0 초과), 열거형에는 HazardAnalysis::fmea 같은 그 값 중 하나를 씁니다. 검사는 그 밖의 값과, 맞지 않는 정의의 기본값을 보고합니다. 메타데이터 본문은 정의의 피처에 값만 줄 수 있으며(level = 4;), abstract metadata def는 적용할 수 없습니다. Hybrid Car 데모는 컨트롤러를 @SafetyRating { level = 4; }로 평가하고 배터리의 검토를 @SafetyReview { method = HazardAnalysis::fmea; closed = true; }로 기록합니다. 편집기에서 삽입 ▾ → 메타데이터 정의는 피처와 규칙이 있는 정의를 시작하고, 메타데이터 적용은 본문 안에 메타데이터를 적용합니다. 텍스트를 쓰지 않으려면 정의나 사용을 선택하고 속성 패널의 Metadata 섹션을 사용합니다. 메타데이터 추가는 프로젝트의 메타데이터 정의 중 하나를 적용합니다. 그러면 각 피처에 필드가 생깁니다(열거형이나 Boolean은 값 목록, String은 일반 텍스트이며 Holarch가 따옴표로 묶어 씁니다. 정의의 기본값이 힌트로 표시되고, 기본값이 없는 피처는 필수로 표시됩니다). 해당 메타데이터에 대한 검사의 발견 사항은 그 아래에 표시되며, 제거는 메타데이터를 떼어 냅니다. 각 변경은 실행 취소 한 번으로 되돌릴 수 있습니다. 표준 라이브러리의 메타데이터와 Holarch 자체의 메타데이터(시뮬레이션, 목표, 가변성)는 고유한 컨트롤을 가지며 여기에 나열되지 않습니다.

개체, 스냅샷, 타임 슬라이스

개체는 종류가 아니라 전 생애에 걸친 하나의 특정한 것입니다. 예를 들어 일련번호가 있는 자동차 한 대입니다. 스냅샷은 한 순간의 그것이고, 타임 슬라이스는 그 생애의 한 기간입니다. 둘 다 자신을 소유한 발생에 속하고 그 피처를 가지므로, 그 피처에 고유한 값을 줄 수 있습니다.

individual part def Car_VIN1234 :> Car {
    snapshot atDelivery { attribute :>> mileage = 0 [km]; }
    timeslice firstOwner { attribute ownerName : String = "Dana Reyes"; }
    snapshot atService { attribute :>> mileage = 15000 [km]; }
    first atDelivery then atService;
    assert constraint mileageGrows { atDelivery.mileage <= atService.mileage }
}
  • individual은 종류 키워드 앞에 오거나(individual part def, individual item def) 단독으로 씁니다(individual def Plate_77;). individual로 작성한 사용은 정확히 하나의 개체 정의로 타입이 지정됩니다: individual car1 : Car_VIN1234;.
  • snapshot과 timeslice는 파트, 아이템, 액션 또는 기타 발생 안에서 종류 키워드 앞에 오거나 단독으로 씁니다. then timeslice secondOwner;는 타임 슬라이스를 그 앞의 멤버 뒤에 순서 짓습니다.
  • 스냅샷이나 타임 슬라이스 안의 값은 먼저 그 안에서, 다음으로 개체에서, 그다음 그 정의에서 읽습니다. 예제에서 atService.mileage는 15,000 km이고 제약 조건이 성립합니다.
  • 발생만 개체, 스냅샷, 타임 슬라이스가 될 수 있습니다. 속성과 열거형은 값입니다.
  • 아키텍처 → 파트, 데이터베이스 뷰, 그리드 뷰에서 인스턴스 열은 각 파트 정의의 개체를 나열합니다(part sedan : Car의 경우 Car_VIN1234). 즉 그 정의를 특수화하는 개체 정의와 그 정의가 타입을 지정하는 개체 사용입니다. Individual(Yes)과 부분(Snapshot 또는 Time slice)도 열로 쓸 수 있습니다(Columns ▾ → SysML v2). 모델에 개체가 생기면 파트 페이지에 인스턴스가 기본으로 표시되고, Table (CSV) 내보내기에 세 열이 포함됩니다. 정의 내보내기는 이 값을 가진 각 요소에 대해 이를 나열합니다.
  • 속성 패널에서 피처 아래의 발생은 Individual을 설정하고, 사용의 경우 Whole life, Time slice, 스냅샷을 설정합니다. 브라우저의 종류 필터에는 개체가 있고, 행의 ⋯ 메뉴에는 새 스냅샷…과 새 타임 슬라이스…가 있습니다. 일반 뷰는 상자 머리글에 «individual part def», «snapshot», «timeslice»를 표시하고, 상자의 스냅샷과 타임 슬라이스를 별도 구획에 나열하며, 상자 사이의 후속 관계를 점선 화살표로 그립니다. Arrange ▾ → Arrange as Timeline은 이를 왼쪽에서 오른쪽으로 정렬합니다. Hybrid Car 데모에서 일반 뷰 carLifeline은 Car_VIN1234의 스냅샷과 타임 슬라이스를 보여 줍니다.

가변 요소, 변형, 구성

가변 요소는 설계의 한 지점에서 허용되는 선택지를 나열하며, 각 선택지가 변형입니다. 가변 요소 정의(variation part def)는 재사용할 수 있는 선택지 집합이고, 가변 요소 사용(variation part charger)은 한 설계 안의 지점입니다. 구성은 각 지점마다 변형 하나를 고릅니다.

variation part def BatteryPack :> Battery {
  variant part standardPack { attribute :>> capacity = 1.4 [kW*h]; }
  variant part largePack { attribute :>> capacity = 12 [kW*h]; }
}
part def CarLine :> Car {
  part pack : BatteryPack;
  variation part charger : Component {
    variant part noCharger;
    variant part wallbox;
  }
  assert constraint wallboxNeedsLargePack { charger == charger::wallbox implies pack == BatteryPack::largePack }
}
part plugInHybrid : CarLine {
  @HolarchConfiguration;
  part :>> pack = BatteryPack::largePack;
  part :>> charger = charger::wallbox;
}
  • 변형은 가변 요소의 피처를 가지며 이를 재정의할 수 있습니다. BatteryPack이 Battery이므로 largePack에는 capacity가 있습니다.
  • 종류 키워드 없는 variant x;는 기존 사용 x를 선택지 중 하나로 만들며, 이름은 x를 따릅니다.
  • 가변 요소는 변형(및 정의, 주석, 메타데이터, 임포트)만 소유합니다. 가변 요소는 이미 추상이므로 abstract를 붙이면 중복이라고 알려 줍니다.
  • 값으로 변형을 선택합니다: part :>> pack = BatteryPack::largePack;. 해당 지점의 변형이 아닌 선택은 오류입니다.
  • 지점에 선택이 없는 동안에는 그 값을 알 수 없으므로, 그에 대한 단언은 충족도 위반도 되지 않습니다. 구성에서는 선택된 변형의 값을 사용합니다.
  • 구성은 @HolarchConfiguration(HolarchVariability 패키지, 표준 라이브러리의 Holarch 아래)으로 표시합니다. 그러면 편집기가 아직 선택하지 않은 각 지점을 알려 줍니다.
  • 편집기에서 삽입 ▾은 다음을 각각 작성합니다: 가변 요소(패키지 수준에서는 정의, 파트 안에서는 지점), 변형(가변 요소 안), Configuration과 변형 선택(구성 안).
  • Hybrid Car 데모에서 CarLine에는 지점이 두 개(pack과 charger) 있고, selfChargingHybrid와 plugInHybrid는 그 구성입니다. 단언이 표준 팩과 월박스의 조합을 배제합니다.

텍스트 표현

텍스트 표현은 요소를 다른 언어로 작성합니다. 요소 본문 안에 rep language "Python" /* … */로 씁니다. 본문은 텍스트로 보존됩니다. 모델은 그 주위의 SysML이 선언하는 것이며, Holarch는 본문을 실행하지 않습니다.

  • Hybrid Car 데모에서 DriveWheels는 계산을 Python으로 담고 있습니다: rep language "Python" /* wheel_speed = torque.value * GEAR_RATIOS[gear] / WHEEL_RADIUS */.
  • "sysml" 또는 "kerml" 본문은 검사됩니다. SpeedLimit은 rep language "sysml" /* speed <= limit */로 작성되어 있으며, Holarch는 이를 직접 작성한 제약 조건처럼 평가합니다.
  • 편집기는 SysML 및 KerML 본문을 색이 입혀진 배경 위의 코드로 강조 표시합니다. 다른 언어는 주석 텍스트로 표시됩니다.
  • 속성 패널의 표현 섹션은 각 표현을 언어 및 본문과 함께 나열합니다. 정의나 사용에서 표현 추가를 클릭하면 표현을 추가하고, 제거를 클릭하면 삭제합니다.
  • 액션 흐름 뷰는 정의에 표현이 있는 액션에 그 언어를 중괄호로 표시합니다(예: {Python}).
  • 알려진 언어: SysML, KerML, OCL, Alf, Python, JavaScript, MATLAB, Modelica, C, 자연어(naturalLanguage, English, text). 이름 뒤의 버전은 무시됩니다(OCL2.0, Python 3).
  • 본문에는 주석을 끝내는 */를 넣을 수 없습니다.

Holarch 자체의 토론 댓글, 레이블, 담당자, 마감일은 모델 옆에 보관되며 텍스트에 기록되지 않습니다.

사용 방법

구조 모델링하기

  1. 편집기에서 패키지를 엽니다(또는 + 새 패키지를 클릭합니다).
  2. 연결 지점의 종류마다 방향이 있는 피처(out attribute torque : TorqueValue;)를 가진 port def를 작성합니다.
  3. 구성 요소의 종류마다 속성과 포트를 가진 part def를 작성합니다.
  4. 조립체에 대해 구성 요소마다 part가 있는 part def를 작성합니다.
  5. 파트를 연결합니다: connect a.p to b.q; 또는 interface name : Def connect a.p to b.q;.
  6. 입력을 멈춥니다. 상태 줄에 적용됨이 표시되고 브라우저에 새 요소가 나타납니다.

삽입 ▾(또는 ⌃⇧Space / Ctrl+Shift+Space)은 이러한 구문을 채울 필드와 함께 대신 작성해 줍니다. 구문 삽입을 참조하십시오.

단위와 함께 값 지정하기

  1. 패키지 맨 위에서 수량 종류와 단위를 임포트합니다: private import ISQ::*;와 private import SI::*;.
  2. 속성의 타입을 수량 종류로 지정하고 값을 줍니다: attribute mass : MassValue = 45 [kg];.
  3. 속성을 상속하는 정의에서는 고유한 값으로 재정의합니다: attribute redefines mass = 18 [kg];.
  4. 값을 가리킵니다. 단위가 수량 종류에 맞지 않으면 오류 카드가 나타납니다.

동작 기술하기

  1. in 및 out 매개변수가 있는 action def를 작성합니다.
  2. action 사용마다 단계를 추가하고 first … then …; 또는 then으로 순서를 정합니다.
  3. 병렬 단계에는 fork와 join을, 대안에는 decide와 merge를 사용합니다.
  4. 아이템을 전달하는 단계 사이에 flow of Item from a.out to b.in;을 추가합니다.
  5. 동작을 수행하는 파트에 perform action name : Def;를 작성하고, 그 파트들 안에 perform name.step;을 작성합니다.
  6. 액션을 액션 흐름 뷰에서 열면 그려진 모습을 볼 수 있습니다(SysML v2 뷰 참조).

요구사항을 작성하고 추적하기

  1. requirement <'ID'> name { doc /* The system shall … */ subject s : Def; }를 작성합니다.
  2. 요구사항을 값에 대해 검사할 수 있으면 require constraint { … }를 추가합니다.
  3. 설계가 요구사항을 충족하는 곳에 satisfy name by somePart;를 작성합니다.
  4. 목표에서 그 요구사항을 verify하는 verification을 작성합니다.
  5. 니즈 및 요구사항 → 요구사항을 엽니다. 요구사항이 번호와 함께 나열되며, 검증 → RVTM은 그 검증 방법을 보여 줍니다. SysML v2 프로젝트의 요구사항과 검증을 참조하십시오.

값을 TBD 또는 TBR로 표시하기

값 대신 TBD를 쓰는 것은 유효한 SysML이 아닙니다. 대신 Holarch의 메타데이터를 사용합니다.

  1. 임포트합니다: private import HolarchMetadata::*;.
  2. 속성에 접두사를 붙입니다: #TBD attribute chargerPower : PowerValue;(아직 값 없음) 또는 #TBR attribute limit : TimeValue = 0.5 [h];(검토할 값).
  3. 담당자와 이유를 기록하려면 속성 본문에 긴 형태를 씁니다: @TBD { owner = "Powertrain lead"; rationale = "The charging standard is not chosen yet."; due = "2026-12-01"; }.

TBD/TBR 등록부가 이 값들을 나열합니다. TBD와 TBR은 ModelingMetadata::StatusInfo를 특수화하므로 다른 SysML v2 도구는 이를 상태 주석으로 읽습니다. 삽입 ▾ → TBD 값과 TBR 값이 이를 대신 작성해 줍니다.

라이브러리 이름 찾기

  1. 레일 도구에서 표준 라이브러리를 엽니다.
  2. 패키지 또는 정의 찾기…에 이름의 일부(예: MassValue)를 입력합니다.
  3. 행에서 이름 복사를 클릭합니다. 정규화된 이름(여기서는 ISQBase::MassValue)이 복사됩니다.
  4. 편집기에 붙여 넣거나, 그 패키지를 임포트하고 짧은 이름을 사용합니다.

예제: 세단의 요구사항 읽기

이 예제는 Hybrid Car 데모 텍스트에서 요구사항 하나를 따라갑니다.

  1. 데모를 열고 편집기의 패키지 목록에서 VehicleRequirements를 선택합니다.
  2. requirement def <'VR-1'> CurbMass를 찾습니다. 그 require constraint { car.curbMass <= limit }는 주제의 공차 질량을 limit과 비교합니다.
  3. requirement carSpec을 찾습니다. 여기에는 requirement <'VR-1.1'> sedanMass : CurbMass { attribute :>> limit = maxCurbMass; }가 있습니다. 이 사용은 limit을 패키지 수준의 목표값 maxCurbMass = 1650 [kg]으로 재정의합니다.
  4. satisfy carSpec by fleet.sedan;을 찾습니다. sedan을 ⌘ / Ctrl-클릭하면 편집기가 Vehicles를 part sedan : Car 위치에서 열며, 그곳의 attribute redefines curbMass = 1580 [kg];이 값을 줍니다.
  5. VehicleRequirements로 돌아가 verification def CurbMassTest를 찾습니다. 그 목표 verify carSpec.sedanMass;가 이를 VR-1.1의 검증 케이스로 만들고, verification sedanWeighing : CurbMassTest { subject car = fleet.sedan; }가 이를 세단에 적용합니다.
  6. Vehicles에서 1580 [kg]을 1700 [kg]으로 바꾸고 입력을 멈춥니다. 이제 세단이 1650 kg 한계를 초과하며, 편집기는 VehicleRequirements에 sedan이 요구사항을 충족하지 않는다는 경고를 거짓인 제약 조건 및 그 값과 함께 표시합니다. ⌘Z / Ctrl+Z로 실행 취소합니다.

팁과 흔한 실수

  • “…”이(가) 여기에 정의되어 있지 않습니다. 이름의 철자가 틀렸거나 그 패키지가 임포트되지 않았습니다. private import Package::*;를 추가하거나 정규화된 이름을 씁니다.
  • ; 누락. 각 선언은 ; 또는 { … } 본문으로 끝납니다. The declaration does not end. Add ; or a { … } body. (선언이 끝나지 않았습니다. ; 또는 { … } 본문을 추가하십시오)
  • :>와 :>>의 차이. 특수화하거나 부분 집합으로 만들려면 :>를, 상속된 피처를 대체하려면 :>>를 씁니다. 상속되지 않은 피처를 재정의하면 “x”은(는) “y”에 상속되지 않습니다.가 표시됩니다.
  • 단위에는 임포트가 필요합니다. 5 [kg]은 SI가 보이는 곳에서만 확인됩니다.
  • 이름이 같은 멤버 두 개. “x”은(는) 이 네임스페이스에서 이미 사용 중입니다. 하나의 이름을 바꿉니다. 변형은 대신 재정의합니다.
  • 목표 밖의 verify. 검증 케이스의 objective { verify R; } 안에 넣습니다.
  • 이름으로 쓴 키워드. part, state, action 같은 단어는 예약어입니다. 따옴표로 묶거나('state') 다른 이름을 고릅니다.

Holarch가 지원하는 것

Holarch는 SysML v2 텍스트 표기법의 다음 부분을 지원합니다. 편집기는 이들을 모두 검사하고, 모델은 이를 보존합니다.

영역지원됨
패키지와 네임스페이스package, 중첩 패키지, library package(읽기 전용), doc, comment … about, 메모 //와 //* */, alias … for …, public/private/protected, 짧은 이름 <'1.2'>, 따옴표로 묶은 이름
임포트멤버십 및 네임스페이스 임포트, ::*, 재귀 ::**, 필터링된 임포트 [@Kind]
정의와 사용part, attribute, item, port, connection, interface, flow, action, state, requirement, constraint, calc, use case, analysis, verification, view, viewpoint, concern, enum, occurrence, allocation, metadata; ref, abstract, in/out/inout, end
특수화:>/specializes, :/defined by, :>/subsets, :>>/redefines, 켤레 ~, disjoint, 피처 체인 a.b.c
다중성[n], [n..m], [*], [0..*], ordered, nonunique, 경계로 쓰는 식
값과 단위=, :=, default, 수량 5 [kg], 단위 식 [m/s^2], 표준 라이브러리의 ISQ 수량 종류와 SI 및 미국 관용 단위, 차원 검사
구조포트와 켤레 포트, connect, 끝이 있는 인터페이스, 다중성이 있는 이름 있는 커넥터 끝, bind, flow of T from … to …, message
액션매개변수, perform, 후속 관계(first … then …, then), fork, join, decide, merge, 가드, accept, send, assign, if, while, for, loop, start, done, terminate
상태entry/do/exit, 트리거, 가드, 효과가 있는 전이, parallel 상태, 중첩 상태, exhibit
요구사항subject, actor, stakeholder, require constraint, assume constraint, frame concern, satisfy … by …, verify, ID로 쓰는 짧은 이름, 요구사항 텍스트로 쓰는 doc
제약 조건과 계산제약 조건 및 계산의 정의와 사용, return, assert constraint, 호출, 산술, 비교, 논리, if ? else, 시퀀스 연산을 쓰는 KerML 식, 단위를 포함한 평가
유스케이스, 분석, 검증subject, actor, objective, include use case, return 결과가 있는 분석 케이스, verify와 판정이 있는 검증 케이스
뷰view, view def, expose(::*, ::**, 필터 포함), filter, viewpoint, frame, render, 표준 뷰 정의
할당과 추적allocate a to b, 할당 정의, dependency from … to …
개체individual 정의와 사용, snapshot과 timeslice(then 뒤 포함), 그 값과 후속 관계
변형variation 정의와 사용, variant 멤버와 변형 참조(variant x;), 값에 의한 선택, @HolarchConfiguration(HolarchVariability)으로 표시한 구성
메타데이터@Name { … }, #Name 접두사, metadata Name about …, Holarch의 HolarchMetadata(TBD, TBR) 및 HolarchFrameworks 패키지, 사용자 정의 metadata def, 사용자 정의 키워드와 의미 메타데이터(#fault def …)

해석하지 않고 작성된 그대로 보존됨

Holarch는 다음 구문을 작성된 그대로 읽고 보존하지만, 자체적인 의미를 부여하지는 않습니다.

  • SysML 및 KerML 이외 언어의 텍스트 표현(텍스트로 보존됨, 텍스트 표현 참조).

아직 사용할 수 없음

  • KerML 파일(.kerml) 가져오기.
  • Systems Modeling API를 통한 main 커밋, 태그, 병합: 다른 도구는 변경 요청 브랜치에 커밋하며, 승인자가 Holarch에서 이를 적용합니다(SysML v2 프로젝트의 API와 MCP 참조).
  • 사용자 정의 키워드와 의미 메타데이터를 넘어서는 언어 확장.

검사

Holarch는 입력하는 동안 텍스트를 검사합니다. 각 문제는 편집기의 여백에 표시되고 밑줄이 그어지며, 메시지는 문제를 먼저 말하고 해결 방법을 알려 줍니다. 오류가 있으면 해당 멤버가 적용되지 않으며, 경고는 그렇지 않습니다.

영역검사 대상메시지 예
구문문자, 주석, 문자열, 중괄호, ;, 예상되는 이름과 토큰이 중괄호에는 짝이 없습니다. 짝이 맞는 { 또는 }를 추가하거나 이 중괄호를 삭제하십시오.
이름확인되지 않은 이름, 모호한 이름, 잘못된 이름, 중복 이름(경고), 비공개 이름“Batery”이(가) 여기에 정의되어 있지 않습니다. 철자를 확인하거나 그 패키지를 임포트하십시오.
타입 지정과 특수화순환, 올바른 종류의 정의에 의한 타입 지정과 특수화, 피처의 부분 집합 지정과 재정의, 상속된 피처만 재정의“capacity”은(는) “Car”에 상속되지 않습니다. 그 타입을 특수화하거나 대신 :>로 부분 집합으로 지정하십시오.
다중성유효한 정수 경계, 재정의 대상보다 넓지 않은 재정의다중성 [3..1]은(는) 유효하지 않습니다. 하한을 0부터 상한까지의 값으로 쓰십시오.
단위와 값차원 일치, 누락된 단위, 단위 이름, 숫자 타입단위가 일치하지 않습니다: kg과 s. 한쪽을 호환되는 단위로 변환하십시오.
식구문, 피연산자 타입, 계산 인수, Boolean 조건조건은 참 또는 거짓이어야 하는데 숫자입니다. x > 0 같은 비교식을 쓰십시오.
구조연결 끝은 피처, 인터페이스는 포트를 연결, 포트, 흐름, 메시지의 방향, 흐름 아이템 타입, 바인딩 타입이 포트 방향들은 서로 맞지 않습니다. 포트 하나를 켤레로 만들거나(~) 방향을 바꾸십시오.
액션같은 본문 안의 액션 사이의 후속 관계, 제어 노드의 입출력 개수, 결정 가드와 else, start와 done, 할당문, perform 대상, for 루프가 반복하는 값과 루프 변수 타입의 일치then 앞에는 액션이 있어야 합니다. 액션 또는 first … then …을 추가하십시오.
상태같은 본문 안의 상태 사이의 전이, 각각 하나씩인 entry/do/exit, 초기 전이, 병렬 영역, exhibit 대상, 전이의 do 효과(받을 수 있는 대상으로의 send, assign, accept, action 또는 이름 있는 액션), 트리거의 페이로드와 포트 아이템의 일치, Real 같은 라이브러리 값 자체에 대한 트리거(경고), 시간을 지정하는 at 트리거“electric”에는 하위 상태가 있지만 초기 전이가 없어 어느 하위 상태에도 진입하지 않습니다. entry; then <first state>;를 추가하십시오.
요구사항, 케이스, 뷰올바른 위치의 멤버, 주제 하나, satisfy/verify/require 대상, 주제 타입, expose 및 import 대상, frame 대상verify는 검증 케이스의 목표 안에 있어야 합니다. objective { … } 안으로 옮기십시오.
텍스트 표현SysML 및 KerML 본문이 구문 분석되고 자신이 표현하는 요소를 선언하는지 여부, 알 수 없는 언어는 알림“SpeedLimit”의 표현이 제약 조건 정의가 아니라 파트 정의를 선언합니다. 본문이 “SpeedLimit” 자체를 선언하게 하십시오.
개체, 스냅샷, 타임 슬라이스individual은 발생에만, 그리고 정확히 하나의 개체 정의와 함께, snapshot/timeslice는 발생 안의 발생 사용에만, 스냅샷 안의 타임 슬라이스(경고)“parked”은(는) 개체이지만 그 정의 중 어느 것도 개체가 아닙니다. 개체 정의로 타입을 지정하거나 individual을 제거하십시오.
변형가변 요소는 변형만 소유, 변형은 가변 요소 안에 있고 그 종류에 속함, 선택은 해당 지점의 변형, 가변 요소의 abstract는 중복(알림), 구성의 미결 지점(알림)“compact”은(는) “pack”의 변형이 아닙니다. 다음 중 하나를 선택하십시오: standardPack, largePack.
사용자 정의 키워드#Name은 메타데이터 정의를 지정, 언어 키워드 없는 선언은 의미 메타데이터를 사용(경고), 메타데이터는 annotatedElement가 허용하는 종류에만 표시, 의미 기본 타입은 정의나 사용이고 표시하는 요소에 맞으며(경고) 순환을 만들지 않음“safetyCritical”은(는) PartDefinition에 적용되며 “invert”(ActionUsage)에는 적용되지 않습니다. 옮기거나 제거하십시오.
메타데이터 값사용자 정의 메타데이터 정의의 모든 필수 피처에 값이 있음(경고), 각 값과 기본값이 피처의 타입(Boolean, String, 정수, 열거형)에 맞음, 주어진 값에 대해 정의의 제약 조건이 성립, 메타데이터 본문은 정의의 피처만 재정의, 추상 메타데이터 정의는 적용되지 않음, about으로 작성한 의미 메타데이터(경고)“SafetyRating”의 값이 제약 조건 levelRange를 위반합니다: level >= 1 and level <= 4. 값을 바꾸십시오.
평가현재 값에 대해 성립하지 않는 제약 조건, 요구사항, 목표“sedan”이(가) “sedanMass”을(를) 충족하지 않습니다: …이(가) 거짓입니다(…). 설계 값이나 요구사항을 바꾸십시오.

표준 라이브러리

표준 라이브러리 페이지는 모든 SysML v2 프로젝트에서 사용할 수 있는 패키지와 정의를 나열합니다: 값과 단위, 수량, 파트, 포트, 액션, 상태, 요구사항, 분석 등. 읽기 전용입니다.

  • 여는 방법: 레일 도구의 설정 → 표준 라이브러리에서 엽니다. LML 프로젝트에는 없습니다.
  • 폴더. 왼쪽에 라이브러리 파일이 폴더별로 나열됩니다: Kernel Libraries, Systems Library, Domain Libraries(Analysis, Cause and Effect, Geometry, Metadata, Quantities and Units, Requirement Derivation), Holarch(TBD와 TBR이 있는 HolarchMetadata 패키지, HolarchConfiguration이 있는 HolarchVariability, Objective가 있는 HolarchRequirements).
  • 파일. 파일을 선택하면 그 패키지가 각각의 문서화 및 정의 표(이름, 종류, Documentation)와 함께 표시됩니다.
  • 찾기. 패키지 또는 정의 찾기…에 입력하면 모든 파일의 이름과 문서화를 검색합니다. 결과에 파일이 표시되며, 클릭하면 그 파일이 열립니다. 지우려면 Esc를 누릅니다.
  • 이름 복사는 편집기에서 쓸 수 있도록 요소의 정규화된 이름(예: ISQ::MassValue)을 복사합니다.
  • 텍스트 표시는 라이브러리 파일을 작성된 그대로 보여 주고, 정의 표시는 표로 돌아갑니다.

라이브러리는 SysML v2 릴리스 라이브러리이며, 한 가지가 수정되어 있습니다. tonne(별칭 'metric ton')은 1000 kg으로 변환됩니다. 릴리스 파일에는 0.001 kg으로 되어 있습니다. 모델은 라이브러리를 이름으로 참조하며, 라이브러리는 프로젝트에 복사되지 않고 .sysml 내보내기에도 포함되지 않습니다.

제한 사항

  • 8 MB보다 큰 텍스트 문서는 검사하지 않습니다: This text is larger than 8 MB and is not checked. Split it into several packages. (이 텍스트는 8 MB보다 커서 검사하지 않습니다. 여러 패키지로 나누십시오)
  • 64 KB보다 긴 줄은 검사하지 않습니다.
  • 256단계보다 깊은 중첩은 검사하지 않습니다.
  • 표준 라이브러리는 편집할 수 없습니다.

SysML® 및 OMG®는 미국 및 기타 국가에서 Object Management Group, Inc.의 등록 상표입니다.