A Discrete-Event Network Simulator
Home
Tutorials ▼
English
Documentation ▼
Installation
Manual
Models
Contributing
Wiki
Development ▼
API Docs
Issue Tracker
Merge Requests
API
Loading...
Searching...
No Matches
version.h
Go to the documentation of this file.
1
/*
2
* Copyright (c) 2018 Lawrence Livermore National Laboratory
3
*
4
* This program is free software; you can redistribute it and/or modify
5
* it under the terms of the GNU General Public License version 2 as
6
* published by the Free Software Foundation;
7
*
8
* This program is distributed in the hope that it will be useful,
9
* but WITHOUT ANY WARRANTY; without even the implied warranty of
10
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
* GNU General Public License for more details.
12
*
13
* You should have received a copy of the GNU General Public License
14
* along with this program; if not, write to the Free Software
15
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16
*
17
* Authors: Mathew Bielejeski <bielejeski1@llnl.gov>
18
*/
19
20
#ifndef BUILD_VERSION_H_
21
#define BUILD_VERSION_H_
22
23
#include "ns3/int64x64.h"
24
25
#include <string>
26
33
namespace
ns3
34
{
35
101
class
Version
102
{
103
public
:
115
static
std::string
VersionTag
();
116
126
static
std::string
ClosestAncestorTag
();
127
138
static
uint32_t
Major
();
139
150
static
uint32_t
Minor
();
151
163
static
uint32_t
Patch
();
164
176
static
std::string
ReleaseCandidate
();
177
184
static
uint32_t
TagDistance
();
185
191
static
bool
DirtyWorkingTree
();
192
207
static
std::string
CommitHash
();
208
216
static
std::string
BuildProfile
();
217
235
static
std::string
ShortVersion
();
236
253
static
std::string
BuildSummary
();
254
271
static
std::string
LongVersion
();
272
273
};
// class Version
274
275
}
// namespace ns3
276
277
#endif
ns3::Version
Helper class providing functions to access various parts of the version string, as well as functions ...
Definition:
version.h:102
ns3::Version::Patch
static uint32_t Patch()
Patch component of the build version.
Definition:
version.cc:60
ns3::Version::CommitHash
static std::string CommitHash()
Hash of the most recent commit.
Definition:
version.cc:84
ns3::Version::Major
static uint32_t Major()
Major component of the build version.
Definition:
version.cc:48
ns3::Version::TagDistance
static uint32_t TagDistance()
The number of commits between the current commit and the tag returned by ClosestAncestorTag().
Definition:
version.cc:72
ns3::Version::BuildProfile
static std::string BuildProfile()
Indicates the type of build that was performed (debug/release/optimized).
Definition:
version.cc:90
ns3::Version::ReleaseCandidate
static std::string ReleaseCandidate()
Release candidate component of the build version.
Definition:
version.cc:66
ns3::Version::Minor
static uint32_t Minor()
Minor component of the build version.
Definition:
version.cc:54
ns3::Version::BuildSummary
static std::string BuildSummary()
Constructs a string containing the most recent tag and status flags.
Definition:
version.cc:115
ns3::Version::DirtyWorkingTree
static bool DirtyWorkingTree()
Indicates whether there were uncommitted changes during the build.
Definition:
version.cc:78
ns3::Version::ShortVersion
static std::string ShortVersion()
Constructs a string containing the ns-3 major and minor version components, and indication of additio...
Definition:
version.cc:96
ns3::Version::LongVersion
static std::string LongVersion()
Constructs a string containing all of the build details.
Definition:
version.cc:133
ns3::Version::VersionTag
static std::string VersionTag()
Returns the ns-3 version tag of the closest ancestor commit.
Definition:
version.cc:36
ns3::Version::ClosestAncestorTag
static std::string ClosestAncestorTag()
Returns the closest tag that is attached to a commit that is an ancestor of the current branch head.
Definition:
version.cc:42
uint32_t
ns3
Every class exported by the ns3 library is enclosed in the ns3 namespace.
src
core
model
version.h
Generated on Sun Jul 2 2023 18:21:33 for ns-3 by
1.9.6