Chaste Commit::29c3c4ab2bee00ddd311a035a1e522c03cbe928a
Static Public Member Functions | List of all members
ChasteBuildInfo Class Reference

#include <Version.hpp>

+ Collaboration diagram for ChasteBuildInfo:

Static Public Member Functions

static std::string GetLicenceText ()
 
static const char * GetRootDir ()
 
static std::string GetVersionString ()
 
static unsigned GetMajorReleaseNumber ()
 
static unsigned GetMinorReleaseNumber ()
 
static SourceRevision GetChasteRevision ()
 
static const char * GetBuildTime ()
 
static const char * GetCurrentTime ()
 
static const char * GetBuilderUnameInfo ()
 
static const char * GetBuildInformation ()
 
static const char * GetCompilerType ()
 
static const char * GetCompilerVersion ()
 
static const char * GetCompilerFlags ()
 
static const char * GetXsdVersion ()
 
static std::map< std::string, SourceRevision > GetProjectRevisions ()
 
static std::string GetProvenanceString ()
 
static std::string GetChasteCodegenVersion ()
 

Detailed Description

A class with static methods providing various information about this build of Chaste.

Definition at line 48 of file Version.hpp.

Member Function Documentation

◆ GetBuilderUnameInfo()

static const char * ChasteBuildInfo::GetBuilderUnameInfo ( )
static
Returns
The output of "uname -a" on the machine that built Chaste.

Referenced by ExecutableSupport::GetBuildInfo(), ExecutableSupport::ShowCopyright(), and ExecutableSupport::WriteProvenanceInfoFile().

◆ GetBuildInformation()

static const char * ChasteBuildInfo::GetBuildInformation ( )
static
Returns
Information about this build of Chaste: the build type used, whether libraries were used, and if so what kind.

Referenced by ExecutableSupport::GetBuildInfo(), ExecutableSupport::ShowCopyright(), and ExecutableSupport::WriteProvenanceInfoFile().

◆ GetBuildTime()

static const char * ChasteBuildInfo::GetBuildTime ( )
static
Returns
The date and time at which Chaste was built.

Referenced by ExecutableSupport::GetBuildInfo(), ExecutableSupport::ShowCopyright(), and ExecutableSupport::WriteProvenanceInfoFile().

◆ GetChasteCodegenVersion()

static std::string ChasteBuildInfo::GetChasteCodegenVersion ( )
static
Returns
A single-line string representation the version of chaste_codegen being used.

Referenced by ExecutableSupport::GetBuildInfo().

◆ GetChasteRevision()

static SourceRevision ChasteBuildInfo::GetChasteRevision ( )
static
Returns
The commit the Chaste source tree was built from, and whether it had uncommitted changes. This comes from git for a working copy, or from the commit git records in a release tarball or other archive; otherwise the commit is unknown. Returned by value (it is small, and read only once per process) so PyChaste can bind it without a lifetime policy.

Referenced by ExecutableSupport::GetBuildInfo(), ExecutableSupport::ShowCopyright(), and ExecutableSupport::WriteProvenanceInfoFile().

◆ GetCompilerFlags()

static const char * ChasteBuildInfo::GetCompilerFlags ( )
static
Returns
The compiler flags.

Referenced by ExecutableSupport::GetBuildInfo().

◆ GetCompilerType()

static const char * ChasteBuildInfo::GetCompilerType ( )
static
Returns
The compiler type used to build (must be either 'intel' or 'gcc').

Referenced by ExecutableSupport::GetBuildInfo().

◆ GetCompilerVersion()

static const char * ChasteBuildInfo::GetCompilerVersion ( )
static
Returns
The compiler version number.

Referenced by ExecutableSupport::GetBuildInfo().

◆ GetCurrentTime()

static const char * ChasteBuildInfo::GetCurrentTime ( )
static
Returns
Get the current date and time, in the same format as GetBuildTime. The returned 'string' is statically allocated, so you don't need to free the memory. However, if you call this method again, the contents will be overwritten.

◆ GetLicenceText()

static std::string ChasteBuildInfo::GetLicenceText ( )
static
Returns
The licence notice for Chaste.

Referenced by ExecutableSupport::ShowCopyright().

◆ GetMajorReleaseNumber()

static unsigned ChasteBuildInfo::GetMajorReleaseNumber ( )
static
Returns
The major number of the "current" Chaste release. If this is a development build, this will be the number of the last release.
Note
This must be set manually by modifying CMakeLists.txt.

◆ GetMinorReleaseNumber()

static unsigned ChasteBuildInfo::GetMinorReleaseNumber ( )
static
Returns
The minor number of the "current" Chaste release. If this is a development build, this will be the number of the last release.
Note
This must be set manually by modifying CMakeLists.txt.

◆ GetProjectRevisions()

static std::map< std::string, SourceRevision > ChasteBuildInfo::GetProjectRevisions ( )
static
Returns
The revision of each checked-out project, keyed by project name. Returned by value for the same reason as GetChasteRevision().

Referenced by ExecutableSupport::GetBuildInfo().

◆ GetProvenanceString()

static std::string ChasteBuildInfo::GetProvenanceString ( )
static
Returns
A single-line string representation of the provenance information to be attached to any files we generate. This includes the version of the Chaste code used, how and when it was built, and the current date and time.

Referenced by VtkMeshWriter< ELEMENT_DIM, SPACE_DIM >::AddProvenance(), ColumnDataWriter::CreateInfoFile(), Hdf5DataWriter::EndDefineMode(), Hdf5ToCmguiConverter< ELEMENT_DIM, SPACE_DIM >::Write(), Hdf5ToMeshalyzerConverter< ELEMENT_DIM, SPACE_DIM >::Write(), FibreWriter< DIM >::WriteAllAxi(), FibreWriter< DIM >::WriteAllOrtho(), Hdf5ToCmguiConverter< ELEMENT_DIM, SPACE_DIM >::WriteCmguiScript(), AbstractPerElementWriter< ELEMENT_DIM, SPACE_DIM, DATA_SIZE >::WriteData(), TrianglesMeshWriter< ELEMENT_DIM, SPACE_DIM >::WriteElementsAsFaces(), CmguiMeshWriter< ELEMENT_DIM, SPACE_DIM >::WriteElementsFileHeader(), TrianglesMeshWriter< ELEMENT_DIM, SPACE_DIM >::WriteFacesAsEdges(), PottsMeshWriter< SPACE_DIM >::WriteFiles(), ImmersedBoundaryMeshWriter< ELEMENT_DIM, SPACE_DIM >::WriteFiles(), VertexMeshWriter< ELEMENT_DIM, SPACE_DIM >::WriteFiles(), MeshalyzerMeshWriter< ELEMENT_DIM, SPACE_DIM >::WriteFiles(), TrianglesMeshWriter< ELEMENT_DIM, SPACE_DIM >::WriteFiles(), XdmfMeshWriter< ELEMENT_DIM, SPACE_DIM >::WriteFiles(), MeshalyzerMeshWriter< ELEMENT_DIM, SPACE_DIM >::WriteFilesFooter(), XdmfMeshWriter< ELEMENT_DIM, SPACE_DIM >::WriteFilesUsingMesh(), PostProcessingWriter< ELEMENT_DIM, SPACE_DIM >::WriteGenericFileToMeshalyzer(), AbstractHdf5Converter< ELEMENT_DIM, SPACE_DIM >::WriteInfoFile(), MeshalyzerMeshWriter< ELEMENT_DIM, SPACE_DIM >::WriteMetaFile(), AbstractTetrahedralMeshWriter< ELEMENT_DIM, SPACE_DIM >::WriteNclFile(), CmguiMeshWriter< ELEMENT_DIM, SPACE_DIM >::WriteNodeFileHeader(), PseudoEcgCalculator< ELEMENT_DIM, SPACE_DIM, PROBLEM_DIM >::WritePseudoEcg(), and XdmfMeshWriter< ELEMENT_DIM, SPACE_DIM >::WriteXdmfMasterFile().

◆ GetRootDir()

static const char * ChasteBuildInfo::GetRootDir ( )
static
Returns
The path to the root directory of the Chaste source tree.

Referenced by HeartConfig::SetDefaultSchemaLocations().

◆ GetVersionString()

static std::string ChasteBuildInfo::GetVersionString ( )
static
Returns
A string representation of the current Chaste version: the major and minor release numbers, then the short commit as build metadata, e.g. "2026.1+89a89a5c1a2b". If the commit is unknown, just the release numbers, e.g. "2026.1".

Referenced by ExecutableSupport::GetBuildInfo().

◆ GetXsdVersion()

static const char * ChasteBuildInfo::GetXsdVersion ( )
static
Returns
The XSD binary version number.

Referenced by ExecutableSupport::GetBuildInfo().

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