Commit

class ansys.sam.sysml2.dto.commit.commit_class.Commit(project_id: str)

Creates and structures a standard PySAM SysML2 commit.

Overview

Methods

add_change	Add a change to the commit.
to_json	Serialize the commit data into JSON data.

Attributes

project_id
changes
previous_commit_id

Import detail

from ansys.sam.sysml2.dto.commit.commit_class import Commit

Attribute detail

Commit.project_id: str = None

Commit.changes: List[ansys.sam.sysml2.dto.commit.data_version.DataVersion]

Commit.previous_commit_id: str = 'head'

Method detail

Commit.add_change(change: ansys.sam.sysml2.dto.commit.data_version.DataVersion)

Add a change to the commit.

Parameters:

changeDataVersion

Data version of the change.

Commit.to_json()

Serialize the commit data into JSON data.

Returns:

str

JSON data.