CFx SDK Documentation 2024 SP0
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
OdTfCommitInfo Struct Reference

#include <TfRevisionControl.h>

Public Member Functions

 OdTfCommitInfo (const OdString &author=OdString::kEmpty, const OdString &message=OdString::kEmpty, const OdTimeStamp &date=OdTimeStamp(OdTimeStamp::kInitUniversalTime), OdStreamBuf *arbitraryUserData=0)
 

Public Attributes

OdTfDigest hash
 
OdTfDigestArray parents
 
OdTfDigest revision
 
OdTfCommitAnnotation annotation
 

Detailed Description

Structure describing a commit relationships in the revision control database.

Remarks
Array of parent commits contains one record for usual commit and several for merge commit. In case of merge commit, the first record in the array corresponds to the target branch, i.e. the branch into which the merge was done.

Definition at line 266 of file TfRevisionControl.h.

Constructor & Destructor Documentation

◆ OdTfCommitInfo()

OdTfCommitInfo::OdTfCommitInfo ( const OdString author = OdString::kEmpty,
const OdString message = OdString::kEmpty,
const OdTimeStamp date = OdTimeStamp(OdTimeStamp::kInitUniversalTime),
OdStreamBuf arbitraryUserData = 0 
)
inline

Constructor for instances of the OdTfCommitInfo structure.

Parameters
author[in] Commit author.
message[in] Commit message.
date[in] Commit timestamp.
arbitraryUserData[in] Arbitrary user data.

Definition at line 285 of file TfRevisionControl.h.

Member Data Documentation

◆ annotation

OdTfCommitAnnotation OdTfCommitInfo::annotation

Describing a commit in the revision control database.

Definition at line 275 of file TfRevisionControl.h.

◆ hash

OdTfDigest OdTfCommitInfo::hash

Hash of the commit itself.

Definition at line 269 of file TfRevisionControl.h.

◆ parents

OdTfDigestArray OdTfCommitInfo::parents

Hash of the parents.

Definition at line 271 of file TfRevisionControl.h.

◆ revision

OdTfDigest OdTfCommitInfo::revision

Hash of the revision object.

Definition at line 273 of file TfRevisionControl.h.


The documentation for this struct was generated from the following file: