slreq.Justification Class

Namespace: slreq

Requirement justifications

Description

Use slreq.Justification objects to work with requirements that you exclude from the implementation and verification status metrics roll-up for your requirements sets. Justify a requirement by creating an outgoing link from the slreq.Justification object to the requirement and setting the link type to Implement or Verify.

Creation

jst = slreq.find(rs,"Type","Justification","PropertyName",PropertyValue) finds and returns an slreq.Justification object jst in the requirement set rs with additional properties specified by PropertyName and PropertyValue.

jst = add(jt,"PropertyName",PropertyValue) adds a child justification jst to the parent justification jt with additional properties specified by PropertyName and PropertyValue.

Input Arguments

expand all

`rs` — Requirement set
`slreq.ReqSet` object

Requirement set, specified as an slreq.ReqSet object.

`jt` — Justification
`slreq.Justification` object

Justification, specified as an slreq.Justification object.

Output Arguments

expand all

`jst` — Justification
`slreq.Justification` object

Justification, returned as an slreq.Justification object.

Properties

expand all

`Id` — Justification custom ID
character vector

Custom ID of the justification, returned as a character vector. You cannot use spaces and '#' in custom IDs.

Attributes:

`GetAccess`	`public`
`SetAccess`	`public`

`Summary` — Justification summary
character vector

Justification summary text, specified as a one-line, plain text character vector.

Attributes:

`GetAccess`	`public`
`SetAccess`	`public`

`Description` — Justification description
character vector

Justification description text, specified as a multiline character vector.

Attributes:

`GetAccess`	`public`
`SetAccess`	`public`

`Keywords` — Justification keywords
character array

Justification keywords, specified as a character array.

Attributes:

`GetAccess`	`public`
`SetAccess`	`public`

`Rationale` — Justification rationale
character vector

Justification rationale text, specified as a multiline character vector.

Attributes:

`GetAccess`	`public`
`SetAccess`	`public`

`CreatedOn` — Date justification was created
`datetime` value

The date on which the justification was created, specified as a datetime value. The software populates this property.

Attributes:

`GetAccess`	`public`
`SetAccess`	`private`

`CreatedBy` — Justification creator
character vector

The name of the individual or organization who created the requirement.

Attributes:

`GetAccess`	`public`
`SetAccess`	`private`

`ModifiedBy` — Justification modifier
character vector

The name of the individual or organization who last modified the justification.

Attributes:

`GetAccess`	`public`
`SetAccess`	`private`

`IndexEnabled` — Index enabled indicator
`1` (default) | `0`

Indicates whether the index is enabled (1) or disabled (0), returned as a 1 or 0 of data type logical. If you disable the index, Requirements Toolbox™ does not count this justification when it creates the numbered hierarchy list. However, the justification remains in the same place in the hierarchy.

Attributes:

`GetAccess`	`public`
`SetAccess`	`public`

`IndexNumber` — User-specified index value
empty `double` array (default) | `int32` array

User-specified index value, returned as an empty double array or an int32 array. If empty, Requirements Toolbox calculates the Index value. Otherwise, Requirements Toolbox sets the Index property to the specified integer value.

Attributes:

`GetAccess`	`public`
`SetAccess`	`public`

`SID` — Justification Session Independent Identifier
character vector

The Session Independent Identifier corresponding to the justification.

Attributes:

`GetAccess`	`public`
`SetAccess`	`private`

`FileRevision` — Justification revision number
scalar

Justification revision number, returned as a scalar. When you make changes to the justification and save the requirement set, the requirement set revision number increments by one and the FileRevision property updates to match the new requirement set revision number. The FileRevision property updates only when you save a change to the justification.

For more information on requirement set revision, see slreq.ReqSet.

Attributes:

`GetAccess`	`public`
`SetAccess`	`private`

`ModifiedOn` — Date justification was modified
`datetime` value

The date on which the justification was last modified, specified as a datetime value. The software populates this property.

Attributes:

`GetAccess`	`public`
`SetAccess`	`private`

`Dirty` — Unsaved changes indicator
`0` | `1`

Indicates if the requirement has unsaved changes (1) or does not have unsaved changes (0).

Attributes:

`GetAccess`	`public`
`SetAccess`	`private`

`Comments` — Justification comments
structure array

The comments that are attached with the justification, specified as a structure.

Attributes:

`GetAccess`	`public`
`SetAccess`	`private`

`Index` — Justification index
character array

The index of the justification, specified as a character array.

Attributes:

`GetAccess`	`public`
`SetAccess`	`private`

Methods

add	Add child justification
addComment	Add comments to justifications
children	Find children justifications
copy	Copy and paste justification
demote	Demote justifications
find	Find children of parent justification
getAttribute	Get justification attributes
isFilteredIn	Check filtered justifications
isHierarchical	Check if justification is hierarchical
move	Move justification in hierarchy
moveDown	Move justification down in hierarchy
moveUp	Move justification up in hierarchy
outLinks	Get outgoing links for justifications
parent	Find parent item of justification
promote	Promote justifications
remove	Remove justification items
reqSet	Return parent requirement set
setAttribute	Set justification attributes
setHierarchical	Change hierarchical justification status

Examples

collapse all

Add Child Justifications

This example shows how to add a child justification under a justification.

Load a requirement set called myReqSet.

rs = slreq.load("myReqSet");

Find justification objects in the requirement set.

myJustifications = find(rs,"Type","Justification")

myJustifications = 

  1×2 Justification array with properties:

    Id
    Summary
    Description
    Keywords
    Rationale
    CreatedOn
    CreatedBy
    ModifiedBy
    SID
    FileRevision
    ModifiedOn
    Dirty
    Comments

Add a child justification to the first justification in the array.

myChildJustification = add(myJustifications(1),"Id","2.1",...
"Summary","New Child Justification")

myChildJustification = 

  Justification with properties:

              Id: '2.1'
         Summary: 'New Child Justification'
     Description: ''
        Keywords: [0×0 char]
       Rationale: ''
       CreatedOn: 25-Aug-2017 14:37:29
       CreatedBy: 'Jane Doe'
      ModifiedBy: 'John Doe'
             SID: 73
    FileRevision: 1
      ModifiedOn: 26-Aug-2017 17:30:20
           Dirty: 0
        Comments: [0×0 struct]

Version History

Introduced in R2018b

slreq.Justification Class

Description

Creation

Input Arguments

rs — Requirement set slreq.ReqSet object

jt — Justification slreq.Justification object

Output Arguments

jst — Justification slreq.Justification object

Properties

Id — Justification custom ID character vector

Attributes:

Summary — Justification summary character vector

Attributes:

Description — Justification description character vector

Attributes:

Keywords — Justification keywords character array

Attributes:

Rationale — Justification rationale character vector

Attributes:

CreatedOn — Date justification was created datetime value

Attributes:

CreatedBy — Justification creator character vector

Attributes:

ModifiedBy — Justification modifier character vector

Attributes:

IndexEnabled — Index enabled indicator 1 (default) | 0

Attributes:

IndexNumber — User-specified index value empty double array (default) | int32 array

Attributes:

SID — Justification Session Independent Identifier character vector

Attributes:

FileRevision — Justification revision number scalar

Attributes:

ModifiedOn — Date justification was modified datetime value

Attributes:

Dirty — Unsaved changes indicator 0 | 1

Attributes:

Comments — Justification comments structure array

Attributes:

Index — Justification index character array

Attributes:

Methods

Examples

Add Child Justifications

Version History

See Also

`rs` — Requirement set
`slreq.ReqSet` object

`jt` — Justification
`slreq.Justification` object

`jst` — Justification
`slreq.Justification` object

`Id` — Justification custom ID
character vector

`Summary` — Justification summary
character vector

`Description` — Justification description
character vector

`Keywords` — Justification keywords
character array

`Rationale` — Justification rationale
character vector

`CreatedOn` — Date justification was created
`datetime` value

`CreatedBy` — Justification creator
character vector

`ModifiedBy` — Justification modifier
character vector

`IndexEnabled` — Index enabled indicator
`1` (default) | `0`

`IndexNumber` — User-specified index value
empty `double` array (default) | `int32` array

`SID` — Justification Session Independent Identifier
character vector

`FileRevision` — Justification revision number
scalar

`ModifiedOn` — Date justification was modified
`datetime` value

`Dirty` — Unsaved changes indicator
`0` | `1`

`Comments` — Justification comments
structure array

`Index` — Justification index
character array