itk::BuildInformation Class Reference

#include <itkBuildInformation.h>

Detailed Description

Static information about this build.

This class provides a singleton interfacer to a static std::map< std::string, std::string> of key value pairs that describe this version of ITK.

Values in in the map provide information about the ITK (i.e. its version, the build options, configuration options, the home URL for the project, and other static information) that can be gathered at configuration time.

Definition at line 47 of file itkBuildInformation.h.

Inheritance diagram for itk::BuildInformation:

Collaboration diagram for itk::BuildInformation:

Classes
class	InformationValueType

Public Types
using	ConstPointer = SmartPointer< const Self >
using	MapKeyType = std::string
using	MapStorageType = InformationValueType
using	MapType = std::map< MapKeyType, MapStorageType >
using	MapValueDescriptionType = MapValueType
using	MapValueType = std::string
using	Pointer = SmartPointer< Self >
using	Self = BuildInformation
Public Types inherited from itk::Object
using	ConstPointer = SmartPointer< const Self >
using	Pointer = SmartPointer< Self >
using	Self = Object
using	Superclass = LightObject
Public Types inherited from itk::LightObject
using	ConstPointer = SmartPointer< const Self >
using	Pointer = SmartPointer< Self >
using	Self = LightObject

Public Member Functions
const char *	GetNameOfClass () const override
Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)
unsigned long	AddObserver (const EventObject &event, Command *) const
unsigned long	AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const
LightObject::Pointer	CreateAnother () const override
virtual void	DebugOff () const
virtual void	DebugOn () const
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
MetaDataDictionary &	GetMetaDataDictionary ()
const MetaDataDictionary &	GetMetaDataDictionary () const
virtual ModifiedTimeType	GetMTime () const
const char *	GetNameOfClass () const override
virtual const TimeStamp &	GetTimeStamp () const
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &)
void	InvokeEvent (const EventObject &) const
virtual void	Modified () const
void	Register () const override
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
void	SetReferenceCount (int) override
void	UnRegister () const noexcept override
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
void	SetMetaDataDictionary (MetaDataDictionary &&rrhs)
virtual void	SetObjectName (std::string _arg)
virtual const std::string &	GetObjectName () const
Public Member Functions inherited from itk::LightObject
Pointer	Clone () const
virtual void	Delete ()
virtual int	GetReferenceCount () const
void	Print (std::ostream &os, Indent indent=0) const

Static Public Member Functions
static Pointer	New ()
static Pointer	GetInstance ()
static const MapType &	GetMap ()
static const MapValueType	GetValue (const MapKeyType &)
static const MapValueDescriptionType	GetDescription (const MapKeyType &)
static const std::vector< MapKeyType >	GetAllKeys ()
Static Public Member Functions inherited from itk::Object
static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
static Pointer	New ()
static void	SetGlobalWarningDisplay (bool val)
Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()
static Pointer	New ()

Private Member Functions
	BuildInformation ()
	itkGetGlobalDeclarationMacro (BuildInformationGlobals, PimplGlobals)

Static Private Attributes
static BuildInformationGlobals *	m_PimplGlobals

Additional Inherited Members
Protected Member Functions inherited from itk::Object
	Object ()
bool	PrintObservers (std::ostream &os, Indent indent) const
void	PrintSelf (std::ostream &os, Indent indent) const override
virtual void	SetTimeStamp (const TimeStamp &timeStamp)
	~Object () override
Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer	InternalClone () const
	LightObject ()
virtual void	PrintHeader (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
virtual	~LightObject ()
Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount {}

Member Typedef Documentation

ConstPointer

using itk::BuildInformation::ConstPointer = SmartPointer<const Self>

Definition at line 57 of file itkBuildInformation.h.

MapKeyType

using itk::BuildInformation::MapKeyType = std::string

Definition at line 58 of file itkBuildInformation.h.

MapStorageType

using itk::BuildInformation::MapStorageType = InformationValueType

Definition at line 77 of file itkBuildInformation.h.

MapType

using itk::BuildInformation::MapType = std::map<MapKeyType, MapStorageType>

Definition at line 78 of file itkBuildInformation.h.

MapValueDescriptionType

using itk::BuildInformation::MapValueDescriptionType = MapValueType

Definition at line 60 of file itkBuildInformation.h.

MapValueType

using itk::BuildInformation::MapValueType = std::string

Definition at line 59 of file itkBuildInformation.h.

Pointer

using itk::BuildInformation::Pointer = SmartPointer<Self>

Definition at line 56 of file itkBuildInformation.h.

Self

using itk::BuildInformation::Self = BuildInformation

Standard class type aliases.

Definition at line 55 of file itkBuildInformation.h.

Constructor & Destructor Documentation

BuildInformation()

itk::BuildInformation::BuildInformation ( )

private

Member Function Documentation

GetAllKeys()

static const std::vector<MapKeyType> itk::BuildInformation::GetAllKeys ( )

static

Returns the global singleton instance of the BuildInformation

GetDescription()

static const MapValueDescriptionType itk::BuildInformation::GetDescription ( const MapKeyType &  )

static

Returns the global singleton instance of the BuildInformation

GetInstance()

static Pointer itk::BuildInformation::GetInstance ( )

static

Returns the global singleton instance of the BuildInformation

GetMap()

static const MapType& itk::BuildInformation::GetMap ( )

static

Returns the global singleton instance of the BuildInformation

GetNameOfClass()

const char* itk::BuildInformation::GetNameOfClass ( ) const

overridevirtual

See also

LightObject::GetNameOfClass()

Reimplemented from itk::LightObject.

GetValue()

static const MapValueType itk::BuildInformation::GetValue ( const MapKeyType &  )

static

Returns the global singleton instance of the BuildInformation

itkGetGlobalDeclarationMacro()

itk::BuildInformation::itkGetGlobalDeclarationMacro ( BuildInformationGlobals  , PimplGlobals    )

private

New()

static Pointer itk::BuildInformation::New ( )

static

Returns the global instance

Member Data Documentation

m_PimplGlobals

BuildInformationGlobals* itk::BuildInformation::m_PimplGlobals

staticprivate

Definition at line 104 of file itkBuildInformation.h.

---

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

• itkBuildInformation.h