`TraceDocument`#

class ansys.scade.almgw_msoffice.trace.TraceDocument(project: ansys.scade.pyalmgw.documents.ReqProject, path: pathlib.Path, requirements=None)#

Tracability links file.

Updated on export
Read on import

Note

The cache document is also updated.

Initialize the trace document.

Overview#

Methods

`add`	Create a traceability link.
`merge_links`	Merge the traceability updates.
`read`	Read the trace file.
`remove`	Remove a tracrability link.
`write`	Write the trace file.

Attributes

`file`
`links`
`map_requirements`
`project`

Import detail#

from ansys.scade.almgw_msoffice.trace import TraceDocument

Attribute detail#

TraceDocument.file = ''#

TraceDocument.links: Dict[str, ansys.scade.pyalmgw.documents.TraceabilityLink]#

TraceDocument.map_requirements: Dict[str, ansys.scade.pyalmgw.documents.Requirement]#

TraceDocument.project#

Method detail#

TraceDocument.add(oid: str, req: str, path: str)#: Create a traceability link.

TraceDocument.merge_links(file: pathlib.Path)#: Merge the traceability updates.

TraceDocument.read()#: Read the trace file.

TraceDocument.remove(oid: str, req: str)#: Remove a tracrability link.

TraceDocument.write()#: Write the trace file.

TraceDocument#