SysML v2
Tutoriais de SysML v2
Nove tutoriais guiados para projetos SysML v2, do primeiro pacote a portas, ações, estados, requisitos, verificação, restrições e variantes, com um painel de etapas que confere seu trabalho.
Nesta página
O Holarch tem uma trilha de tutoriais guiados para projetos SysML v2. Cada um cria um pequeno projeto inicial SysML v2 e abre um painel de etapas ao lado da página. O painel confere o modelo enquanto você trabalha: uma etapa fica verde quando o modelo tem o que ela pede. Esta página lista todas as etapas como texto, para que você também possa acompanhar por aqui.
O primeiro tutorial usa a WS-1 Weather Station, como os tutoriais de LML. Os outros constroem partes de um carro híbrido, o modelo da demonstração Hybrid Car: tipos de valor e componentes, as portas e interfaces do trem de força, um ciclo de condução, os estados do trem de força, os requisitos do carro, sua verificação, as checagens dos valores do sedã e a linha de produtos. Cada tutorial tem seu próprio projeto inicial, então você pode fazê-los em qualquer ordem. Todos os projetos iniciais e todos os tutoriais concluídos passam na checagem com 0 problemas.
| Tutorial | Tempo | Você aprende a |
|---|---|---|
| Primeiros passos | 15 min | escrever texto SysML v2, vê-lo como árvore e como visão, desenhar na visão e adicionar um requisito |
| Definições e atributos | 20 min | escrever enumerações, tipos de valor e definições abstratas, especializar com valores e unidades, e usar o preenchimento automático, Inserir e renomear |
| Portas e interfaces | 20 min | definir portas e interfaces, conjugar portas, conectar parts e desenhar uma interface em uma Visão de interconexão |
| Ações e fluxos | 20 min | escrever definições de ação e um ciclo de condução com uma bifurcação, fluxos e uma junção, adicionar raias e construir etapas no FFBD |
| Estados e transições | 20 min | escrever sinais e uma máquina de estados com gatilhos, guardas e ações de estado, e desenhar uma transição temporizada |
| Requisitos | 20 min | escrever limites, definições e usos de requisitos, satisfazê-los e ver um requisito que não é atendido |
| Verificação e rastreabilidade | 15 min | escrever um caso de verificação, rastrear uma etapa na Matriz de rastreabilidade e derivar um requisito |
| Restrições e cálculos | 20 min | escrever restrições e cálculos, vincular valores em uma Visão paramétrica, executar um caso de análise e marcar valores TBD e TBR |
| Variantes e configurações | 15 min | escrever variações e variantes, uma linha de produtos com uma regra, configurações e uma palavra-chave própria |
Como usá-lo
Iniciar um tutorial de SysML v2
- Abra Ajuda → Tutoriais na barra lateral ou pressione ⌘K / Ctrl+K e digite
tutorial. Fora de um projeto, a página Tutoriais lista primeiro os tutoriais de LML e depois Tutoriais para projetos SysML v2. Dentro de um projeto SysML v2, ela lista apenas os tutoriais de SysML v2. - Clique em Iniciar em um cartão. O Holarch cria o projeto, por exemplo Tutorial: SysML v2 Ports and Interfaces (Hybrid Car), e o abre com o painel de etapas à direita.
O painel de etapas funciona como nos tutoriais de LML: Mostrar destaca o controle de que uma etapa precisa, Ir até lá abre a página, Saiba mais abre o tópico da Ajuda, e Reiniciar…, Marcar como concluído e × funcionam da mesma forma. Consulte Tutoriais.
Digitar o texto de uma etapa
A maioria das etapas dá texto SysML para digitar em Modelo → Editor. A etapa diz onde as linhas entram, por exemplo "antes da última chave de fechamento do pacote". O texto é aplicado ao modelo quando você para de digitar; o status abaixo do editor informa isso, e a etapa fica verde.
- Digite as linhas como mostradas. A indentação não importa para o modelo; o Editor mantém a sua.
- Um sublinhado vermelho marca um erro: aponte para ele para ler a mensagem. Um texto com erro de sintaxe permanece como rascunho e não é aplicado até que você o corrija.
- ⌘Z / Ctrl+Z desfaz a última alteração aplicada.
Dicas
- Na primeira vez, faça os tutoriais em ordem: cada um explica o texto que usa, e os seguintes pressupõem as ideias anteriores (definições e usos,
:>e:>>). - Uma etapa que continua aberta geralmente tem um erro de digitação em um nome. Compare seu texto com as linhas da etapa; no SysML v2, os nomes diferenciam maiúsculas de minúsculas.
- Os tutoriais ensinam a mesma linguagem de Noções básicas de SysML v2; a página Notação textual traz os detalhes.
Primeiros passos
Escreva um primeiro modelo da Weather Station: abra o texto, adicione uma definição de part com um valor e uma unidade, use-a em outra definição, veja o modelo no Navegador e em uma Visão geral, desenhe uma part na visão e veja-a aparecer no texto, adicione um requisito com satisfy e exporte o modelo como arquivo .sysml. As etapas são descritas em Primeiros passos com projetos SysML v2.
Definições e atributos
O projeto inicial tem o pacote Vehicles com uma definição de part, Car.
- Abra o pacote. Clique em Modelo → Editor. Toda declaração é uma palavra-chave e um nome, seguidos de um corpo entre chaves ou de um ponto e vírgula.
- Escreva uma enumeração. Acima de
part def Car {, adicioneenum def DriveMode { enum economy; enum normal; enum sport; }(um valor por linha). - Defina um tipo de valor. Abaixo dela, adicione
attribute def TirePressure :> ScalarValue;.:>significa especializa. - Escreva uma definição abstrata. Adicione
abstract part def Componentcom um comentáriodoce os atributosmass : MassValue,partNumber : Stringepower : PowerValue.//inicia uma nota que fica apenas no texto. - Deixe o checador encontrar um erro. Adicione
part def Battery :> Componentcomattribute redefines mass = 45 [kg];e, de propósito,attribute redefines power = 60 [kg];. O checador sublinha a unidade: quilogramas não são uma potência. - Corrija a unidade. Mude-a para
60 [W]. - Complete um nome. Na bateria, digite
attribute capacity : Ener, aceiteEnergyValuena lista de preenchimento com Enter e termine com;. - Consulte-o na Biblioteca padrão. Clique em Ajustes → Biblioteca padrão na parte inferior da barra lateral e digite
EnergyValuena caixa de busca. - Insira uma definição. No Editor, pressione ⌃⇧Space / Ctrl+Shift+Space (ou clique em Inserir ▾) em uma linha vazia, escolha Definição de part e complete
part def Engine :> Componentcomattribute redefines mass = 110 [kg];eattribute cylinders : Integer;. - Use as definições. Em
Car, adicioneattribute mode : DriveMode;,part battery : Battery;epart engine : Engine;. - Renomeie em todos os lugares. Coloque o cursor em
cylinders, pressione F2 e renomeie paracylinderCount.
Portas e interfaces
O projeto inicial tem os componentes do trem de força com suas portas de torque e de potência, as definições de port TorquePort e PowerPort e as definições de interface Shaft e HighVoltageBus.
- Defina uma porta. Acima de
port def TorquePort, adicioneport def FuelPortcomout attribute flowRate : Real;eattribute kind : FuelKind;.outsignifica que o valor sai da part que possui a porta. - Dê portas às parts. Adicione
port fuelOut : FuelPort;aFuelTankeport fuelIn : ~FuelPort;aEngine.~conjuga a porta: entrada e saída ficam invertidas. - Defina uma interface. Adicione
interface def FuelLine { end supply : FuelPort; end consumer : ~FuelPort; }. - Monte o trem de força. No fim do pacote, adicione
part def Powertraincom as partstank,engine,motor,batteryetransmission, uma portaoutput : TorquePortebind output = transmission.output;. - Conecte duas parts. No trem de força, adicione
interface fuel : FuelLine connect tank.fuelOut to engine.fuelIn;. - Adicione os eixos. Adicione
interface engineShaft : Shaft connect engine.output to transmission.engineIn;einterface motorShaft : Shaft connect motor.output to transmission.motorIn;. - Crie uma Visão de interconexão. Clique em Arquitetura → Visões de interconexão e depois em + Novo diagrama. Escolha
Powertrainem Mostra e clique em Criar. - Desenhe uma interface. Arraste da alça da porta
powerOutda bateria até a portapowerIndo motor e solte em Interface : HighVoltageBus. - Dê nome à interface. Selecione a nova linha e digite
hvBuscomo seu Nome no inspetor. - Veja-a no texto. Clique em Modelo → Editor: a interface está no trem de força, com seu nome, tipo e extremidades.
Ações e fluxos
O projeto inicial tem o pacote VehicleBehavior com os itens Fuel e Torque, as funções ProduceTorque (F.2) e DriveWheels (F.3) e três definições de part.
- Defina uma função. Adicione
action def <'F.1'> SupplyFuelcomin attribute fuelDemand : Real;eout item fuel : Fuel;. O nome curto entre os sinais de menor e maior é o número da função. - Escreva o ciclo de condução. Adicione
action def <'F'> DriveCyclecomfirst start then split;,fork split;,then supply;,then produce;e as etapasaction supply : SupplyFueleaction produce : ProduceTorque, cada uma com umaduration. - Adicione um fluxo. No ciclo de condução, adicione
flow of Fuel from supply.fuel to produce.fuel;. - Junte os ramos. Adicione
first supply then ready;,first produce then ready;,join ready;,then action drive : DriveWheels { … },then done;eflow produce.torque to drive.torque;. - Crie uma Visão de fluxo de ações. Clique em Comportamento → Fluxos de ações e depois em + Novo diagrama, e escolha
DriveCycleem Mostra. - Diga quem executa cada etapa. Adicione
part def DrivenCarcomperform action trip : DriveCycle;e as partstank,engineetransmission, cada uma comperform trip.supply;,perform trip.produce;ouperform trip.drive;. A visão ganha uma raia por part. - Abra a Análise funcional. Clique em Comportamento → Análise funcional, clique em Escolher… e escolha
DriveCycle. - Declare outra ação. Adicione
action def EmergencyShutdown;. - Construa etapas no FFBD. Clique em Comportamento → FFBD e depois em + Novo diagrama, e escolha
EmergencyShutdown. No painel Adicionar, digiteOpen Contactorse pressione Enter, depoisCut Fuel. - Veja as etapas no texto. Clique em Modelo → Editor: o FFBD escreveu as etapas e suas sucessões.
Estados e transições
O projeto inicial tem o pacote PowertrainBehavior com uma part def Car vazia.
- Defina os sinais. Adicione
attribute def StartRequest;,StopRequest,PlugIneUnplugda mesma forma. - Escreva uma definição de estado. Adicione
state def PowertrainStatescomin attribute charge : Real;,entry; then off;e os estadosoff,electricehybrid. - Adicione transições. Depois de
state off;, adicioneaccept StartRequest if charge > 20 then electric;eaccept StartRequest then hybrid;. - Dê ações a um estado. Substitua
state electric;por um corpo contendoentry action spinUpMotor;,do action driveElectric;eexit action holdMotor;. - Saia do estado elétrico. Depois dele, adicione
if charge < 15 then hybrid;eaccept StopRequest then off;; adicione tambémaccept StopRequest then off;depois destate hybrid;. - Adicione um estado com transições nomeadas. Adicione
state charging { do action chargeBattery; },transition plugIn first off accept PlugIn then charging;etransition unplugged first charging accept Unplug then off;. - Crie uma Visão de transição de estados. Clique em Comportamento → Máquinas de estados e depois em + Novo diagrama, e escolha
PowertrainStatesem Mostra. - Desenhe uma transição temporizada. Arraste da alça de
chargingatéoffe solte em Transição. No painel da transição, digite o Nomechargede o Gatilhoafter 30 [min]. - Veja-a no texto. Clique em Modelo → Editor: a transição está escrita como uma transição nomeada.
- Faça o carro exibir os estados. Em
Car, adicioneexhibit state powertrainStates : PowertrainStates;.
Requisitos
O projeto inicial tem o pacote VehicleRequirements com uma pequena cópia do projeto: Battery, Car e o sedan da frota, com massa em ordem de marcha de 1580 kg.
- Dê nome aos limites. Adicione
attribute maxCurbMass : MassValue = 1650 [kg];eattribute minBatteryCapacity : EnergyValue = 1.2 [kW*h];. - Escreva uma definição de requisito. Adicione
requirement def <'VR-1'> CurbMasscom uma declaraçãodoc,subject car : Car;,attribute limit : MassValue;erequire constraint { car.curbMass <= limit }. - Insira um requisito. Pressione ⌃⇧Space / Ctrl+Shift+Space em uma linha vazia, escolha Definição de requisito e escreva
VR-3 BatteryCapacitycom o sujeitobattery : Batteryerequire constraint { battery.capacity >= minBatteryCapacity }. - Aninhe requisitos em uma especificação. Adicione
requirement carSpeccomsubject car : Car;erequirement <'VR-1.1'> sedanMass : CurbMass { attribute :>> limit = maxCurbMass; }. - Diga o que os satisfaz. Adicione
satisfy carSpec by fleet.sedan;esatisfy requirement batterySpec : BatteryCapacity by fleet.sedan.battery;. - Quebre um requisito. Mude a massa em ordem de marcha do sedã para
1700 [kg]. O Editor marca o satisfy: o sedã não atende mais ao VR-1.1. - Volte a atendê-lo. Pressione ⌘Z / Ctrl+Z ou mude de volta para
1580 [kg]. - Veja a tabela de requisitos. Clique em Necessidades e requisitos → Requisitos.
- Crie uma Visão de requisitos. Na página Diagramas, clique em + Novo diagrama, escolha Visão de requisitos e
carSpecem Mostra. - Cheque as declarações. Clique em Necessidades e requisitos → Qualidade e clique em Checar qualidade.
Verificação e rastreabilidade
O projeto inicial tem o requisito de massa em ordem de marcha e a especificação do carro, um ciclo de condução com as etapas cruise e brake, VR-6 batteryMassLimit e VR-7 stopFromCruise.
- Escreva um caso de verificação. Adicione
verification def <'VC-1'> CurbMassTestcomsubject car : Car;,objective massObjective { verify carSpec.sedanMass; }ereturn verdict : Boolean = car.curbMass <= maxCurbMass;. - Aplique-o ao sedã. Adicione
verification <'VC-1.1'> sedanWeighing : CurbMassTest { subject car = fleet.sedan; }. - Abra os casos de verificação. Clique em Verificação → Casos de verificação. Etapas, resultados e status são dados do Holarch ao lado do modelo. Na linha de Sedan Weighing, clique em + Etapas, depois em + Adicionar etapa, digite
Weigh the carem Ação e clique em Aplicar. Em seguida, clique em Aprovados nos botões de status. - Leia a RVTM. Clique em Verificação → RVTM.
- Rastreie uma etapa até um requisito. Clique em Verificação → Matriz de rastreabilidade, mostre os requisitos como linhas e as ações como colunas, clique na célula de
stopFromCruiseebrakee escolha satisfied by. - Derive um requisito. Adicione
private import RequirementDerivation::*;econnection batteryMassDerivation : Derivation connect carSpec.sedanMass to batteryMassLimit;. - Execute as checagens do modelo. Clique em Verificação → Checagens do modelo.
Restrições e cálculos
O projeto inicial tem o pacote VehicleAnalysis com o motor, a bateria, o carro e os valores do sedã, e as metas maxCurbMass e minPowerToWeight.
- Escreva uma definição de restrição. Adicione
constraint def MassLimitcomin mass : MassValue;,in limit : MassValue;e a expressãomass <= limit. - Escreva um cálculo. Adicione
calc def PowerToWeightcom os parâmetrospoweremassereturn ratio = power / mass;. - Vincule os valores do sedã. Adicione
constraint sedanMassCheck : MassLimit { in mass = fleet.sedan.curbMass; in limit = maxCurbMass; }. - Crie uma Visão paramétrica. Na página Diagramas, clique em + Novo diagrama, escolha Visão paramétrica e
VehicleAnalysisem Mostra. A checagem passa: 1580 kg está dentro de 1650 kg. - Faça a checagem falhar. Mude a massa em ordem de marcha do sedã para
1700 [kg]; a visão mostra a checagem falhando. - Faça-a passar de novo. Desfaça ou mude de volta para
1580 [kg]. Resolver tudo checa todas as restrições de novo. - Execute um caso de análise. Adicione
analysis def PowerToWeightAnalysiscom um objetivo que exigeratio >= minPowerToWeight, eanalysis sedanPowerToWeight : PowerToWeightAnalysis { subject car = fleet.sedan; }. - Marque valores em aberto. Adicione
private import HolarchMetadata::*;e o requisito VR-5ChargeTimecom#TBRno seu limite de tempo e@TBDcom um responsável, um prazo e uma justificativa na potência do carregador.TBDeTBRvêm da bibliotecaHolarchMetadatado Holarch, não da biblioteca padrão do SysML v2; eles especializam os metadados padrãoStatusInfo. - Abra o registro de TBD/TBR. Clique em Necessidades e requisitos → TBD/TBR. O tempo de carga aparece com o responsável e o prazo dos seus metadados
@TBD. O registro é somente leitura: altere o responsável ou a data nos metadados, no Editor. - Totalize a massa. Clique em Arquitetura → Orçamentos e TPMs e selecione a part raiz
sedan.
Variantes e configurações
O projeto inicial tem Component, Battery, Controller, Car e Powertrain.
- Importe o pacote de variabilidade. Adicione
private import HolarchVariability::*;. - Escreva uma variação. Em uma linha vazia, pressione ⌃⇧Space / Ctrl+Shift+Space (ou clique em Inserir ▾), escolha Variação e complete
variation part def BatteryPack :> Batterycom as variantesstandardPack(1.4 kWh) elargePack(12 kWh, 120 kg). - Escreva a linha de produtos. Adicione
part def CarLine :> Carcompart pack : BatteryPack;, umavariation part chargercom as variantesnoChargerewallbox, eassert constraint wallboxNeedsLargePack { charger == charger::wallbox implies pack == BatteryPack::largePack }. - Inicie uma configuração. Escolha Inserir ▾ → Configuração e preencha
part plugInHybrid : CarLine { @HolarchConfiguration; }. O Editor aponta os pontos de variação ainda em aberto. - Escolha as variantes. Em
plugInHybrid, escolha Inserir ▾ → Escolha de variante para cada ponto e preenchapart :>> pack = BatteryPack::largePack;epart :>> charger = charger::wallbox;. - Adicione uma segunda configuração. Adicione
selfChargingHybridda mesma forma, com o pack padrão e sem carregador. - Defina uma palavra-chave própria. Adicione
metadata def <safetyCritical> SafetyCritical. - Use a palavra-chave. Em
Powertrain, escreva#safetyCritical part controller : Controller;. - Veja a linha de produtos. Crie uma Visão geral de
Vehicles: o pack de bateria aparece marcado como variação.
Projetos de tutorial
Os projetos de tutorial de SysML v2 seguem as mesmas regras dos outros projetos de tutorial: não contam para os projetos ativos do seu plano, comportam até 300 itens, e você pode ter um por tutorial. Consulte Tutoriais.
Relacionado
- Tutoriais
- Primeiros passos com projetos SysML v2
- O Editor de texto e o Navegador
- Notação textual
- Visões
- Requisitos em projetos SysML v2
SysML® e OMG® são marcas registradas da Object Management Group, Inc. nos Estados Unidos e em outros países.