Meziantou.FrameworkRequirementDiagram Class
A requirement diagram, in the style of SysML: requirements, the elements that satisfy or verify them, and the relationships between them (Mermaid requirementDiagram).
public sealed class RequirementDiagram : Diagram- Inheritance
DiagramRequirementDiagram
Constructors
| Name | Description |
|---|---|
| RequirementDiagram() |
RequirementDiagram()
RequirementDiagram.cspublic RequirementDiagram()No documentation is available.
Properties
| Name | Description |
|---|---|
| ClassDefinitions | Gets the styles of the CSS classes of the nodes, by name (Mermaid classDef). The class default applies to every node. |
| Direction | Gets or sets the direction of the relationships. The default is DiagramDirection.TopToBottom. |
| Elements | Gets the elements: the parts of other documents that requirements relate to. |
| Relationships | Gets the relationships, drawn in order. |
| Requirements | Gets the requirements. |
ClassDefinitions
RequirementDiagram.csGets the styles of the CSS classes of the nodes, by name (Mermaid classDef). The class default applies to every node.
public IDictionary<string, DiagramStyle> ClassDefinitions { get; }Property value
Direction
RequirementDiagram.csGets or sets the direction of the relationships. The default is DiagramDirection.TopToBottom.
public DiagramDirection Direction { get; set; }Property value
Elements
RequirementDiagram.csGets the elements: the parts of other documents that requirements relate to.
public IList<RequirementDiagramElement> Elements { get; }Property value
Relationships
RequirementDiagram.csGets the relationships, drawn in order.
public IList<RequirementRelationship> Relationships { get; }Property value
Requirements
RequirementDiagram.csGets the requirements.
public IList<RequirementDiagramRequirement> Requirements { get; }Property value
Methods
| Name | Description |
|---|---|
| AddElement(string) | Adds an element. |
| AddRelationship(RequirementDiagramNode, RequirementDiagramNode, RequirementRelationshipKind) | Adds a relationship. |
| AddRequirement(string, RequirementKind) | Adds a requirement. |
| Find(string) | Finds a requirement or an element by name. |
AddElement(string)
RequirementDiagram.csAdds an element.
public RequirementDiagramElement AddElement(string name)AddRelationship(RequirementDiagramNode, RequirementDiagramNode, RequirementRelationshipKind)
RequirementDiagram.csAdds a relationship.
public RequirementRelationship AddRelationship(RequirementDiagramNode source, RequirementDiagramNode target, RequirementRelationshipKind kind)Parameters
sourceRequirementDiagramNode- The source, such as the element that satisfies a requirement.
targetRequirementDiagramNode- The target.
kindRequirementRelationshipKind- The kind.
Returns
RequirementRelationship The relationship.
AddRequirement(string, RequirementKind)
RequirementDiagram.csAdds a requirement.
public RequirementDiagramRequirement AddRequirement(string name, RequirementKind kind = RequirementKind.Requirement)Parameters
namestring- The name, unique in the diagram.
kindRequirementKind- The kind.
Returns
RequirementDiagramRequirement The requirement.
Find(string)
RequirementDiagram.csFinds a requirement or an element by name.
public RequirementDiagramNode? Find(string name)