ldmx::DetectorHeader Class Reference

Defines detector header information. More...

#include <DetectorHeader.h>

Public Member Functions
	DetectorHeader (std::string name, int version, std::string description, std::string author)
	Class constructor.
const std::string &	getName ()
	Get the name of the detector.
int	getVersion ()
	Get the version of the detector.
const std::string &	getDescription ()
	Get a short description of the detector.
const std::string &	getAuthor () const
	Get the author of the detector (first and last name).

Private Attributes
std::string	name_
	The name of the detector.
int	version_
	The version of the detector.
std::string	description_
	A short description of the detector.
std::string	author_
	The name of the detector's author.

Detailed Description

Defines detector header information.

Note

This class provides information about a detector read in from a GDML file. The information includes the name of the detector, its numerical (int) version, a short description of the detector, and the name of its author.

Definition at line 21 of file DetectorHeader.h.

Constructor & Destructor Documentation

DetectorHeader()

ldmx::DetectorHeader::DetectorHeader ( std::string  name, int  version, std::string  description, std::string  author  )

inline

Class constructor.

Parameters

name	The name of the detector.
version	The version of the detector.
description	A short description of the detector.
author	The name of the detector's author (first and last name).

Definition at line 30 of file DetectorHeader.h.

      : name_(name),
        version_(version),
        description_(description),
        author_(author) {}

Member Function Documentation

getAuthor()

const std::string & ldmx::DetectorHeader::getAuthor ( ) const

inline

Get the author of the detector (first and last name).

Returns

The author of the detector.

Definition at line 59 of file DetectorHeader.h.

{ return author_; }

References author_.

getDescription()

const std::string & ldmx::DetectorHeader::getDescription ( )

inline

Get a short description of the detector.

Returns

A short description of the detector.

Definition at line 53 of file DetectorHeader.h.

{ return description_; }

References description_.

getName()

const std::string & ldmx::DetectorHeader::getName ( )

inline

Get the name of the detector.

Returns

The name of the detector.

Definition at line 41 of file DetectorHeader.h.

{ return name_; }

References name_.

getVersion()

int ldmx::DetectorHeader::getVersion ( )

inline

Get the version of the detector.

Returns

The version of the detector.

Definition at line 47 of file DetectorHeader.h.

{ return version_; }

References version_.

Member Data Documentation

author_

std::string ldmx::DetectorHeader::author_

private

The name of the detector's author.

Definition at line 80 of file DetectorHeader.h.

Referenced by getAuthor().

description_

std::string ldmx::DetectorHeader::description_

private

A short description of the detector.

Definition at line 75 of file DetectorHeader.h.

Referenced by getDescription().

name_

std::string ldmx::DetectorHeader::name_

private

The name of the detector.

Definition at line 65 of file DetectorHeader.h.

Referenced by getName().

version_

int ldmx::DetectorHeader::version_

private

The version of the detector.

Definition at line 70 of file DetectorHeader.h.

Referenced by getVersion().

---

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

• DetDescr/include/DetDescr/DetectorHeader.h