Commit in lcdd/include/lcdd on MAIN | |||
bfield/Solenoid.hh | +2 | -2 | 1.4 -> 1.5 |
schema/IdSpecType.hh | +44 | -2 | 1.5 -> 1.6 |
/LimitParamType.hh | +40 | -1 | 1.5 -> 1.6 |
/LimitSetType.hh | +36 | -1 | 1.5 -> 1.6 |
/LimitType.hh | +90 | -1 | 1.5 -> 1.6 |
/NonprojectiveCylinderSegmentationType.hh | +25 | -1 | 1.5 -> 1.6 |
/NonprojectiveSegmentationType.hh | +39 | -1 | 1.5 -> 1.6 |
/PhysVolIdType.hh | +26 | -2 | 1.5 -> 1.6 |
/ProjectiveCylinderSegmentationType.hh | +23 | -1 | 1.5 -> 1.6 |
/ProjectiveZPlaneSegmentationType.hh | +23 | -1 | 1.5 -> 1.6 |
/RZBType.hh | +40 | -1 | 1.5 -> 1.6 |
/RZFieldMapType.hh | +39 | -1 | 1.5 -> 1.6 |
/RegionType.hh | +89 | -5 | 1.5 -> 1.6 |
/SegmentationType.hh | +8 | -1 | 1.4 -> 1.5 |
/SensitiveDetectorType.hh | +89 | -7 | 1.5 -> 1.6 |
/SolenoidType.hh | +55 | -1 | 1.4 -> 1.5 |
/TrackerType.hh | +15 | -1 | 1.5 -> 1.6 |
/VisType.hh | +68 | -2 | 1.5 -> 1.6 |
/limit.hh | +12 | -1 | 1.4 -> 1.5 |
/limitset.hh | +11 | -1 | 1.4 -> 1.5 |
/nonprojective_cylinder.hh | +12 | -1 | 1.4 -> 1.5 |
/physvolidElem.hh | +12 | -1 | 1.4 -> 1.5 |
/projective_cylinder.hh | +12 | -1 | 1.4 -> 1.5 |
/projective_zplane.hh | +12 | -1 | 1.4 -> 1.5 |
/region.hh | +12 | -1 | 1.4 -> 1.5 |
/rz_field_map.hh | +12 | -1 | 1.4 -> 1.5 |
/rzb.hh | +12 | -1 | 1.4 -> 1.5 |
/sensitive_detector.hh | +12 | -1 | 1.4 -> 1.5 |
/solenoid.hh | +12 | -1 | 1.4 -> 1.5 |
/tracker.hh | +12 | -1 | 1.4 -> 1.5 |
/vis.hh | +12 | -1 | 1.4 -> 1.5 |
+906 | -45 |
add rest of missing doxygen comments
diff -u -r1.4 -r1.5 --- Solenoid.hh 10 Jul 2013 18:16:52 -0000 1.4 +++ Solenoid.hh 12 Sep 2013 23:26:42 -0000 1.5 @@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/include/lcdd/bfield/Solenoid.hh,v 1.4 2013/07/10 18:16:52 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/include/lcdd/bfield/Solenoid.hh,v 1.5 2013/09/12 23:26:42 jeremy Exp $
#ifndef LCDD_BFIELD_SOLENOID_HH #define LCDD_BFIELD_SOLENOID_HH 1
@@ -11,7 +11,7 @@
/** * @brief Implementation of a simple solenoidal field with fixed B-field values.
- * @todo This class needs better documentation on the function of the inner/outer R and Z values.
+ * @todo Apply maximum Z value to cut-off field.
*/ class Solenoid: public G4MagneticField {
diff -u -r1.5 -r1.6 --- IdSpecType.hh 10 Jul 2013 18:06:18 -0000 1.5 +++ IdSpecType.hh 12 Sep 2013 23:26:42 -0000 1.6 @@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/include/lcdd/schema/IdSpecType.hh,v 1.5 2013/07/10 18:06:18 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/include/lcdd/schema/IdSpecType.hh,v 1.6 2013/09/12 23:26:42 jeremy Exp $
#ifndef LCDD_SCHEMA_IDSPECTYPE_HH #define LCDD_SCHEMA_IDSPECTYPE_HH 1
@@ -25,14 +25,25 @@
class idspecref: public SAXObject, public ReferenceType { public:
+ + /** + * Class constructor. + */
idspecref() { }
+ /** + * Class destructor. + */
virtual ~idspecref() { }
+ /** + * Get the type of this object which is XML element. + * @return The type of this object. + */
virtual SAXObject::Type type() { return SAXObject::element;
@@ -40,39 +51,71 @@
}; public:
+ + /** + * Class constructor. + */
IdSpecType() { }
+ /** + * Class destructor. + */
virtual ~IdSpecType() { }
+ /** + * Set the name of the IdSpec. + * @param The name of the IdSpec. + */
void set_name(const std::string& n) { _name = n; }
+ /** + * Set the length. + * @param The length. + */
void set_length(const std::string& l) { _length = l; }
+ /** + * Get the name. + * @return The name. + */
const std::string& get_name() const { return _name; }
+ /** + * Get the length. + * @return The length. + */
const std::string& get_length() const { return _length; }
+ /** + * Get the child content. + * @return The child content. + */
const ContentSequence* get_content() const { return &_sequence; }
+ /** + * Add child content. + * @param tag The child XML tag. + * @param so The SAXObject of the child. + */
void add_content(const std::string& tag, SAXObject* so) { ContentGroup::ContentItem ci = { tag, so };
@@ -83,7 +126,6 @@
std::string _name; std::string _length;
-
ContentSequence _sequence; };
diff -u -r1.5 -r1.6 --- LimitParamType.hh 10 Jul 2013 18:06:18 -0000 1.5 +++ LimitParamType.hh 12 Sep 2013 23:26:42 -0000 1.6 @@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/include/lcdd/schema/LimitParamType.hh,v 1.5 2013/07/10 18:06:18 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/include/lcdd/schema/LimitParamType.hh,v 1.6 2013/09/12 23:26:42 jeremy Exp $
#ifndef LCDD_SCHEMA_LIMITPARAMTYPE_HH #define LCDD_SCHEMA_LIMITPARAMTYPE_HH 1
@@ -12,49 +12,88 @@
class LimitParamType { public:
+ + /** + * Class constructor. + */
LimitParamType() { }
+ /** + * Class destructor. + */
virtual ~LimitParamType() { }
+ /** + * Set the applicable particles using a comma delimited list. + * @param p A comma delimited list of particle names. + */
void set_particles(const std::string& p) { _particles = p; }
+ /** + * Get the list of applicable particles. + * @return The list of applicable particles. + */
const std::string& get_particles() const { return _particles; }
+ /** + * Set the name of the limit parameter. + * @param n The name of the limit parameter. + */
void set_name(const std::string& n) { _name = n; }
+ /** + * Get the name of the limit parameter. + * @return The name of the limit parameter. + */
const std::string& get_name() const { return _name; }
+ /** + * Set the value of the limit. + * @param v The value of the limit. + */
void set_value(const std::string& v) { _value = v; }
+ /** + * Get the value of the limit. + * @return The value of the limit. + */
const std::string& get_value() const { return _value; }
+ /** + * Set the unit of the parameter. + * @param u The unit of the parameter. + */
void set_unit(const std::string& u) { _unit = u; }
+ /** + * Get the unit of the parameter. + * @return The unit of the parameter. + */
const std::string& get_unit() const { return _unit;
diff -u -r1.5 -r1.6 --- LimitSetType.hh 10 Jul 2013 18:06:18 -0000 1.5 +++ LimitSetType.hh 12 Sep 2013 23:26:42 -0000 1.6 @@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/include/lcdd/schema/LimitSetType.hh,v 1.5 2013/07/10 18:06:18 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/include/lcdd/schema/LimitSetType.hh,v 1.6 2013/09/12 23:26:42 jeremy Exp $
#ifndef LCDD_SCHEMA_LIMITSETTYPE_HH #define LCDD_SCHEMA_LIMITSETTYPE_HH 1
@@ -23,14 +23,26 @@
class limitsetref: public SAXObject, public ReferenceType { public:
+ + /** + * Class constructor. + */
limitsetref() { }
+ /** + * Class destructor. + */
virtual ~limitsetref() { }
+ + /** + * Get the type of this SAXObject. + * @return The type of this SAXObject. + */
virtual SAXObject::Type type() { return SAXObject::element;
@@ -39,30 +51,53 @@
public:
+ /** + * Class constructor. + */
LimitSetType() { }
+ /** + * Class destructor. + */
virtual ~LimitSetType() { }
+ /** + * Set the name of the limit set. + * @param n The name of the limit set. + */
void set_name(const std::string& n) { _name = n; }
+ /** + * Get the name of the limit set. + * @return The name of the limit set. + */
const std::string& get_name() const { return _name; }
+ /** + * Add child content. + * @param tag The child XML tag. + * @param so The SAXObject of the child. + */
void add_content(const std::string& tag, SAXObject* so) { ContentGroup::ContentItem ci = { tag, so }; _sequence.add_content(ci); }
+ /** + * Get the child content. + * @return The child content. + */
const ContentSequence* get_content() const { return &_sequence;
diff -u -r1.5 -r1.6 --- LimitType.hh 10 Jul 2013 18:06:18 -0000 1.5 +++ LimitType.hh 12 Sep 2013 23:26:42 -0000 1.6 @@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/include/lcdd/schema/LimitType.hh,v 1.5 2013/07/10 18:06:18 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/include/lcdd/schema/LimitType.hh,v 1.6 2013/09/12 23:26:42 jeremy Exp $
#ifndef LCDD_SCHEMA_LIMITTYPE_HH #define LCDD_SCHEMA_LIMITTYPE_HH
@@ -21,14 +21,25 @@
class limitref: public SAXObject, public ReferenceType { public:
+ + /** + * Class constructor. + */
limitref() { }
+ /** + * Class destructor. + */
virtual ~limitref() { }
+ /** + * Get the type of this SAXObject. + * @return The type of this SAXObject. + */
virtual SAXObject::Type type() { return SAXObject::element;
@@ -36,99 +47,177 @@
}; public:
+ + /** + * Class constructor. + */
LimitType() { }
+ /** + * Class destructor. + */
virtual ~LimitType() { }
+ /** + * Get the name of the physics limit. + * @return The name of the physics limit. + */
const std::string& get_name() const { return _name; }
+ /** + * Get the maximum step length. + * @return The maximum step length. + */
const std::string& get_step_length_max() const { return _stepLengthMax; }
+ /** + * Get the maximum track length. + * @return The maximum track length. + */
const std::string& get_track_length_max() const { return _trackLengthMax; }
+ /** + * Get the maximum time. + * @return The maximum time. + */
const std::string& get_time_max() const { return _timeMax; }
+ /** + * Get the minimum kinetic energy. + * @return The minimum kinetic energy. + */
const std::string& get_ekin_min() const { return _ekinMin; }
+ /** + * Get the minimum range. + * @return The minimum range. + */
const std::string& get_range_min() const { return _rangeMin; }
+ /** + * Get the energy unit. + * @return The energy unit. + */
const std::string& get_eunit() const { return _eunit; }
+ /** + * Get the length unit. + * @return The length unit. + */
const std::string& get_lunit() const { return _lunit; }
+ /** + * Get the time unit. + * @return The time unit. + */
const std::string& get_tunit() const { return _tunit; }
+ /** + * Set the name. + * @param s The name. + */
void set_name(const std::string& s) { _name = s; }
+ /** + * Set the the maximum step length. + * @param s The maximum step length. + */
void set_step_length_max(const std::string& s) { _stepLengthMax = s; }
+ /** + * Set the maximum track length. + * @param s The maximum track length. + */
void set_track_length_max(const std::string& s) { _trackLengthMax = s; }
+ /** + * Set the maximum time. + * @param s The maximum time. + */
void set_time_max(const std::string& s) { _timeMax = s; }
+ /** + * Set the minimum kinetic energy. + * @param s The minimum kinetic energy. + */
void set_ekin_min(const std::string& s) { _ekinMin = s; }
+ /** + * Set the minimum range. + * @param s The minimum range. + */
void set_range_min(const std::string& s) { _rangeMin = s; }
+ /** + * Set the energy unit. + * @param s The energy unit. + */
void set_eunit(const std::string& s) { _eunit = s; }
+ /** + * Set the length unit. + * @param s The length unit. + */
void set_lunit(const std::string& s) { _lunit = s; }
+ /** + * Set the time unit + */
void set_tunit(const std::string& s) { _tunit = s;
diff -u -r1.5 -r1.6 --- NonprojectiveCylinderSegmentationType.hh 10 Jul 2013 18:06:18 -0000 1.5 +++ NonprojectiveCylinderSegmentationType.hh 12 Sep 2013 23:26:42 -0000 1.6 @@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/include/lcdd/schema/NonprojectiveCylinderSegmentationType.hh,v 1.5 2013/07/10 18:06:18 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/include/lcdd/schema/NonprojectiveCylinderSegmentationType.hh,v 1.6 2013/09/12 23:26:42 jeremy Exp $
#ifndef LCDD_SCHEMA_NONPROJECTIVECYLINDERSEGMENTATIONTYPE_HH #define LCDD_SCHEMA_NONPROJECTIVECYLINDERSEGMENTATIONTYPE_HH 1
@@ -26,31 +26,55 @@
public:
+ /** + * Set the grid size z. + * @param gsz The grid size z. + */
void set_gridSizeZ(const std::string& gsz) { _gridSizeZ = gsz; }
+ /** + * Set the grid size phi. + * @param gsp The grid size phi. + */
void set_gridSizePhi(const std::string& gsp) { _gridSizePhi = gsp; }
+ /** + * Set the length unit. + * @param lunit The length unit. + */
void set_lunit(const std::string& lunit) { _lunit = lunit; }
+ /** + * Get the grid size z. + * @return The grid size z. + */
const std::string& get_gridSizeZ() { return _gridSizeZ; }
+ /** + * Get the grid size phi. + * @return The grid size phi. + */
const std::string& get_gridSizePhi() { return _gridSizePhi; }
+ /** + * Get the length unit. + * @return The length unit. + */
const std::string& get_lunit() { return _lunit;
diff -u -r1.5 -r1.6 --- NonprojectiveSegmentationType.hh 10 Jul 2013 18:06:18 -0000 1.5 +++ NonprojectiveSegmentationType.hh 12 Sep 2013 23:26:42 -0000 1.6 @@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/include/lcdd/schema/NonprojectiveSegmentationType.hh,v 1.5 2013/07/10 18:06:18 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/include/lcdd/schema/NonprojectiveSegmentationType.hh,v 1.6 2013/09/12 23:26:42 jeremy Exp $
#ifndef LCDD_SCHEMA_NONPROJECTIVESEGMENTATIONTYPE_HH #define LCDD_SCHEMA_NONPROJECTIVESEGMENTATIONTYPE_HH 1
@@ -16,51 +16,89 @@
{ public:
+ /** + * Class constructor. + */
NonprojectiveSegmentationType() { }
+ /** + * Class destructor. + */
virtual ~NonprojectiveSegmentationType() { } public:
+ /** + * Set the grid size x. + * @param gsx The grid size x. + */
void set_gridSizeX(const std::string& gsx) { _gridSizeX = gsx; }
+ /** + * Set the grid size y. + * @param gsy The grid size y. + */
void set_gridSizeY(const std::string& gsy) { _gridSizeY = gsy; }
+ /** + * Set the grid size z. + * @param gsz The grid size z. + */
void set_gridSizeZ(const std::string& gsz) { _gridSizeZ = gsz; }
+ /** + * Set the length unit. + * @param lunit The length unit. + */
void set_lunit(const std::string& lunit) { _lunit = lunit; }
+ /** + * Get the grid size x. + * @return The grid size x. + */
const std::string& get_gridSizeX() { return _gridSizeX; }
+ /** + * Get the grid size y. + * @return The grid size y. + */
const std::string& get_gridSizeY() { return _gridSizeY; }
+ /** + * Get the grid size z. + * @return The grid size z. + */
const std::string& get_gridSizeZ() { return _gridSizeZ; }
+ /** + * Get the length unit. + * @return The length unit. + */
const std::string& get_lunit() { return _lunit;
diff -u -r1.5 -r1.6 --- PhysVolIdType.hh 10 Jul 2013 18:06:18 -0000 1.5 +++ PhysVolIdType.hh 12 Sep 2013 23:26:42 -0000 1.6 @@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/include/lcdd/schema/PhysVolIdType.hh,v 1.5 2013/07/10 18:06:18 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/include/lcdd/schema/PhysVolIdType.hh,v 1.6 2013/09/12 23:26:42 jeremy Exp $
#ifndef LCDD_SCHEMA_PHYSVOLIDTYPE_HH #define LCDD_SCHEMA_PHYSVOLIDTYPE_HH 1
@@ -11,30 +11,54 @@
*/ class PhysVolIdType {
+
public:
- PhysVolIdType()
+ + /** + * Class constructor. + */ + PhysVolIdType()
{ }
+ /** + * Class destructor. + */
virtual ~PhysVolIdType() { }
+ /** + * Set the value of the ID. + * @param v The value of the ID. + */
void set_value(const std::string& v) { _value = v; }
+ /** + * Set the field name. + * @param f The field name. + */
void set_field_name(const std::string& f) { _fieldName = f; }
+ /** + * Get the value of the ID. + * @return The value of the ID. + */
const std::string& get_value() { return _value; }
+ /** + * Get the field name. + * @return The field name. + */
const std::string& get_field_name() { return _fieldName;
diff -u -r1.5 -r1.6 --- ProjectiveCylinderSegmentationType.hh 10 Jul 2013 18:06:18 -0000 1.5 +++ ProjectiveCylinderSegmentationType.hh 12 Sep 2013 23:26:42 -0000 1.6 @@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/include/lcdd/schema/ProjectiveCylinderSegmentationType.hh,v 1.5 2013/07/10 18:06:18 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/include/lcdd/schema/ProjectiveCylinderSegmentationType.hh,v 1.6 2013/09/12 23:26:42 jeremy Exp $
#ifndef LCDD_SCHEMA_PROJECTIVECYLINDERSEGMENTATIONTYPE_HH #define LCDD_SCHEMA_PROJECTIVECYLINDERSEGMENTATIONTYPE_HH 1
@@ -16,31 +16,53 @@
{ public:
+ /** + * Class constructor. + */
ProjectiveCylinderSegmentationType() { }
+ /** + * Class destructor. + */
virtual ~ProjectiveCylinderSegmentationType() { } public:
+ /** + * Set the number of theta bins. This divides 180 degrees in theta. + * @param ntheta The number of theta bins. + */
void set_ntheta(const std::string& ntheta) { _ntheta = ntheta; }
+ /** + * Set the number of phi bins. This divides 360 degrees in phi. + * @param nphi The number of phi bins. + */
void set_nphi(const std::string& nphi) { _nphi = nphi; }
+ /** + * Get the number of theta bins. + * @return The number of theta bins. + */
const std::string& get_ntheta() const { return _ntheta; }
+ /** + * Get the number of phi bins. + * @return The number of phi bins. + */
const std::string& get_nphi() const { return _nphi;
diff -u -r1.5 -r1.6 --- ProjectiveZPlaneSegmentationType.hh 10 Jul 2013 18:06:18 -0000 1.5 +++ ProjectiveZPlaneSegmentationType.hh 12 Sep 2013 23:26:42 -0000 1.6 @@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/include/lcdd/schema/ProjectiveZPlaneSegmentationType.hh,v 1.5 2013/07/10 18:06:18 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/include/lcdd/schema/ProjectiveZPlaneSegmentationType.hh,v 1.6 2013/09/12 23:26:42 jeremy Exp $
#ifndef LCDD_SCHEMA_PROJECTIVEZPLANESEGMENTATIONTYPE_HH #define LCDD_SCHEMA_PROJECTIVEZPLANESEGMENTATIONTYPE_HH 1
@@ -16,31 +16,53 @@
{ public:
+ /** + * Class constructor. + */
ProjectiveZPlaneSegmentationType() { }
+ /** + * Class destructor. + */
virtual ~ProjectiveZPlaneSegmentationType() { } public:
+ /** + * Set the number of theta bins. + * @param ntheta The number of theta bins. + */
void set_ntheta(const std::string& ntheta) { _ntheta = ntheta; }
+ /** + * Set the number of phi bins. + * @param nphi The number of phi bins. + */
void set_nphi(const std::string& nphi) { _nphi = nphi; }
+ /** + * Get the number of theta bins. + * @return The number of theta bins. + */
const std::string& get_ntheta() const { return _ntheta; }
+ /** + * Get the number of phi bins. + * @return The number of phi bins. + */
const std::string& get_nphi() const { return _nphi;
diff -u -r1.5 -r1.6 --- RZBType.hh 10 Jul 2013 18:06:18 -0000 1.5 +++ RZBType.hh 12 Sep 2013 23:26:42 -0000 1.6 @@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/include/lcdd/schema/RZBType.hh,v 1.5 2013/07/10 18:06:18 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/include/lcdd/schema/RZBType.hh,v 1.6 2013/09/12 23:26:42 jeremy Exp $
#ifndef LCDD_SCHEMA_RZBTYPE_HH #define LCDD_SCHEMA_RZBTYPE_HH 1
@@ -12,49 +12,88 @@
{ public:
+ + /** + * Class constructor. + */
RZBType() { }
+ /** + * Class destructor. + */
virtual ~RZBType() { }
+ /** + * Set the radius. + * @param r The radius [radians]. + */
void set_r(const std::string& r) { _r = r; }
+ /** + * Set the z position. + * @param z The z position. + */
void set_z(const std::string& z) { _z = z; }
+ /** + * Set the Br value. + * @param Br The Br value. + */
void set_Br(const std::string& Br) { _Br = Br; }
+ /** + * Set the Bz value. + * @param Bz The Bz value. + */
void set_Bz(const std::string& Bz) { _Bz = Bz; }
+ /** + * Get the radius. + * @return The radius. + */
const std::string& get_r() const { return _r; }
+ /** + * Get the z position. + * @return The z position. + */
const std::string& get_z() const { return _z; }
+ /** + * Get the Br value. + * @return The Br value. + */
const std::string& get_Br() const { return _Br; }
+ /** + * Get the Bz value. + * @return The Bz value. + */
const std::string& get_Bz() const { return _Bz;
diff -u -r1.5 -r1.6 --- RZFieldMapType.hh 10 Jul 2013 18:06:18 -0000 1.5 +++ RZFieldMapType.hh 12 Sep 2013 23:26:42 -0000 1.6 @@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/include/lcdd/schema/RZFieldMapType.hh,v 1.5 2013/07/10 18:06:18 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/include/lcdd/schema/RZFieldMapType.hh,v 1.6 2013/09/12 23:26:42 jeremy Exp $
#ifndef LCDD_SCHEMA_RZFIELDMAPTYPE_HH #define LCDD_SCHEMA_RZFIELDMAPTYPE_HH 1
@@ -13,49 +13,87 @@
public:
+ /** + * Class constructor. + */
RZFieldMapType() { }
+ /** + * Class destructor. + */
virtual ~RZFieldMapType() { }
+ /** + * Set the number of bins in r (radius). + * @param num_bins_r The number of bins in r. + */
void set_num_bins_r(const std::string& num_bins_r) { _num_bins_r = num_bins_r; }
+ /** + * Get the number of bins in r. + * @return The number of bins in r. + */
const std::string& get_num_bins_r() const { return _num_bins_r; }
+ /** + * Set the r grid size. + * @param grid_size_r The r grid size. + */
void set_grid_size_r(const std::string& grid_size_r) { _grid_size_r = grid_size_r; }
+ /** + * Get the r grid size. + * @return The r grid size. + */
const std::string& get_grid_size_r() const { return _grid_size_r; }
+ /** + * Set the number of z bins. + * @param num_bins_z The number of z bins. + */
void set_num_bins_z(const std::string& num_bins_z) { _num_bins_z = num_bins_z; }
+ /** + * Get the number of z bins. + * @return The number of z bins. + */
const std::string& get_num_bins_z() const { return _num_bins_z; }
+ /** + * Set the z grid size. + * @param grid_size_z The z grid size. + */
void set_grid_size_z(const std::string& grid_size_z) { _grid_size_z = grid_size_z; }
+ /** + * Get the z grid size. + * @return The z grid size. + */
const std::string& get_grid_size_z() const { return _grid_size_z;
diff -u -r1.5 -r1.6 --- RegionType.hh 10 Jul 2013 18:06:18 -0000 1.5 +++ RegionType.hh 12 Sep 2013 23:26:42 -0000 1.6 @@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/include/lcdd/schema/RegionType.hh,v 1.5 2013/07/10 18:06:18 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/include/lcdd/schema/RegionType.hh,v 1.6 2013/09/12 23:26:42 jeremy Exp $
#ifndef LCDD_SCHEMA_REGIONTYPE_HH #define LCDD_SCHEMA_REGIONTYPE_HH 1
@@ -24,14 +24,25 @@
{ public:
+ + /** + * Class constructor. + */
regionref() { }
+ /** + * Class destructor. + */
virtual ~regionref() { }
+ /** + * Get the object XML type. + * @return The object XML type. + */
virtual SAXObject::Type type() { return SAXObject::element;
@@ -39,90 +50,167 @@
}; public:
+ + /** + * Class constructor. + */
RegionType() { }
+ /** + * Class destructor. + */
virtual ~RegionType() { }
+ /** + * Set the name of the region. + * @param s The name of the region. + */
void set_name(const std::string& s) { _name = s; }
+ /** + * Set whether to store secondary particle information + * as G4 trajectories in this region. + * @param s Set whether to store secondary particle information. + */
void set_storeSecondaries(const std::string& s) { _storeSecondaries = s; }
+ /** + * Set whether to kill tracks that enter this region, + * after their first step. + * @param killTracks Set whether to kill tracks that enter this region. + */
void set_killTracks(const std::string& killTracks) { _killTracks = killTracks; }
+ /** + * Set the secondary production cut for this region. + * This is the Geant4 "production cut" which is measured in length. + * (See Geant4 documentation for details.) + * @param s The secondary production cut. + */
void set_cut(const std::string& s) { _cut = s; }
+ /** + * Set the length unit for the production cut. + * @param s The length unit for the production cut. + */
void set_lunit(const std::string& s) { _lunit = s; }
+ /** + * Set the trajectory energy threshold for the region. + * @param s The trajectory energy threshold. + */
void set_threshold(const std::string& s) { _threshold = s; }
+ /** + * Set the energy unit for the energy threshold. + */
void set_eunit(const std::string& s) { _eunit = s; }
+ /** + * Get the name of the region. + * @return The name of the region. + */
const std::string& get_name() const { return _name; }
+ /** + * Get whether to store track secondaries information to trajectories + * or not in this region. + * @return This is "true" to store secondaries and "false" if not. + */
const std::string& get_storeSecondaries() const { return _storeSecondaries; }
+ /** + * Get whether to kill tracks that enter this region, after their first step + * in the region's volume. + * @return This is "true" to kill tracks and "false" if not. + */
const std::string& get_killTracks() const { return _killTracks; }
+ /** + * Get the production cut for this region. + * @return The production cut for the region. + */
const std::string& get_cut() const { return _cut; }
+ /** + * Get the length unit for the production cut. + * @return The length unit for the production cut. + */
const std::string& get_lunit() const { return _lunit; }
+ /** + * Get the trajectory energy threshold. + * @return The trajectory energy threshold. + */
const std::string& get_threshold() const { return _threshold; }
+ /** + * Get the energy unit for the trajectory threshold cut. + * @return The energy unit for the threshold. + */
const std::string& get_eunit() const { return _eunit; }
+ /** + * Add XML contents. + * @param tag The tag of the child. + * @param so The SAXObject of the child. + */
void add_content(const std::string& tag, SAXObject* so) { ContentGroup::ContentItem ci = { tag, so }; _sequence.add_content(ci); }
+ /** + * Get the XML contents. + * @return The object's XML contents. + */
const ContentSequence* get_content() const { return &_sequence;
@@ -131,15 +219,11 @@
private: ContentSequence _sequence;
-
std::string _name;
-
std::string _storeSecondaries; std::string _killTracks;
-
std::string _cut; std::string _lunit;
-
std::string _threshold; std::string _eunit; };
diff -u -r1.4 -r1.5 --- SegmentationType.hh 10 Jul 2013 18:06:18 -0000 1.4 +++ SegmentationType.hh 12 Sep 2013 23:26:42 -0000 1.5 @@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/include/lcdd/schema/SegmentationType.hh,v 1.4 2013/07/10 18:06:18 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/include/lcdd/schema/SegmentationType.hh,v 1.5 2013/09/12 23:26:42 jeremy Exp $
#ifndef LCDD_SCHEMA_SEGMENTATIONTYPE_HH #define LCDD_SCHEMA_SEGMENTATIONTYPE_HH 1
@@ -12,10 +12,17 @@
class SegmentationType { public:
+ + /** + * Class constructor. + */
SegmentationType() { }
+ /** + * Class destructor. + */
virtual ~SegmentationType() { }
diff -u -r1.5 -r1.6 --- SensitiveDetectorType.hh 10 Jul 2013 18:06:18 -0000 1.5 +++ SensitiveDetectorType.hh 12 Sep 2013 23:26:42 -0000 1.6 @@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/include/lcdd/schema/SensitiveDetectorType.hh,v 1.5 2013/07/10 18:06:18 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/include/lcdd/schema/SensitiveDetectorType.hh,v 1.6 2013/09/12 23:26:42 jeremy Exp $
#ifndef LCDD_SCHEMA_SENSITIVEDETECTORTYPE_HH #define LCDD_SCHEMA_SENSITIVEDETECTORTYPE_HH 1
@@ -25,14 +25,24 @@
{ public:
+ /** + * Class constructor. + */
sdref() { }
+ /** + * Class destructor. + */
virtual ~sdref() { }
+ /** + * Get the XML object type. + * @return The XML object type (element). + */
virtual SAXObject::Type type() { return SAXObject::element;
@@ -40,90 +50,163 @@
}; public:
+ + /** + * Class constructor. + */
SensitiveDetectorType() { }
+ /** + * Class destructor. + */
virtual ~SensitiveDetectorType() { }
+ /** + * Set the name of the sensitive detector. + * @param n The name of the sensitive detector. + */
void set_name(const std::string& n) { _name = n; }
+ /** + * Set the name of the detector's hits collection. + * @param hcn The name of the hits collection. + */
void set_hitsCollectionName(const std::string& hcn) { _hitsCollectionName = hcn; }
+ /** + * Get the name of the hits collection. + * @return The name of the hits collection. + */
const std::string& get_hitsCollectionName() const { return _hitsCollectionName; }
- void set_eunit(const std::string& eu)
+ /** + * Set the step energy cut for hit processing. + * @param ec The energy cut. + */ + void set_ecut(const std::string& ec)
{
- _eunit = eu;
+ _ecut = ec;
}
- void set_ecut(const std::string& ec)
+ /** + * Set the unit for the energy cut. + * @param eu The energy unit. + */ + void set_eunit(const std::string& eu)
{
- _ecut = ec;
+ _eunit = eu;
}
+ /** + * Set the verbosity value; 0 for least verbose; 2 for most. + * @param v Set the verbosity value. + */
void set_verbose(const std::string& v) { _verbose = v; }
+ /** + * Get the type of the sensitive detector. + * This should be "calorimeter" or "tracker". + * @param t The sensitive detector type. + */
void set_type(const std::string& t) { _type = t; }
+ /** + * Set the endcap flag which should be "true" if detector + * is an endcap and "false" if not. + * @param e The endcap flag. + */
void set_endcap_flag(const std::string& e) { _endcapFlag = e; }
+ /** + * Get the name of the sensitive detector. + * @return The name of the sensitive detector. + */
const std::string& get_name() const { return _name; }
+ /** + * Get the energy cut unit. + * @return The energy cut unit. + */
const std::string& get_eunit() const { return _eunit; }
+ /** + * Get the energy cut unit. + * @return The energy cut unit. + */
const std::string& get_ecut() const { return _ecut; }
+ /** + * Get the verbosity level. + * @return The verbosity level. + */
const std::string& get_verbose() const { return _verbose; }
+ /** + * Get the type of the sensitive detector. + * @return The type of the sensitive detector. + */
const std::string& get_type() const { return _type; }
+ /** + * Get the endcap flag. + * @return The endcap flag. + */
const std::string& get_endcap_flag() const { return _endcapFlag; }
+ /** + * Get the object's child content. + * @return The object's child content. + */
const ContentSequence* get_content() const { return &_sequence; }
- // add content
+ /** + * Add child content. + * @param tag The child's tag. + * @param so The child's SAXObject. + */
void add_content(const std::string& tag, SAXObject* so) { ContentGroup::ContentItem ci = { tag, so };
@@ -133,7 +216,6 @@
private: ContentSequence _sequence;
-
std::string _name; std::string _hitsCollectionName; std::string _endcapFlag;
diff -u -r1.4 -r1.5 --- SolenoidType.hh 10 Jul 2013 18:06:18 -0000 1.4 +++ SolenoidType.hh 12 Sep 2013 23:26:42 -0000 1.5 @@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/include/lcdd/schema/SolenoidType.hh,v 1.4 2013/07/10 18:06:18 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/include/lcdd/schema/SolenoidType.hh,v 1.5 2013/09/12 23:26:42 jeremy Exp $
#ifndef LCDD_SCHEMA_SOLENOIDTYPE_HH #define LCDD_SCHEMA_SOLENOIDTYPE_HH 1
@@ -14,71 +14,125 @@
public:
+ /** + * Class constructor. + */
SolenoidType() { }
+ /** + * Class destructor. + */
virtual ~SolenoidType() { } public:
+ /** + * Set the fixed inner Bz value. + * @param s The inner Bz value. + */
void set_innerField(const std::string& s) { _innerField = s; }
+ /** + * Set the fixed outer Bz value. + * @param s The outer Bz value. + */
void set_outerField(const std::string& s) { _outerField = s; }
+ /** + * Set the minimum Z value defining where the outer field value will apply. + * @param s The minimum Z value. + */
void set_zmin(const std::string& s) { _zmin = s; }
+ /** + * Set the maximum Z value defining where the field ends. + * @param s The maximum Z value. + */
void set_zmax(const std::string& s) { _zmax = s; }
+ /** + * Set the inner radius. + * @param s The inner radius. + */
void set_innerRadius(const std::string& s) { _innerRadius = s; }
+ /** + * Set the outer radius. + * @param s The outer radius. + */
void set_outerRadius(const std::string& s) { _outerRadius = s; }
+ /** + * Get the inner Bz value. + * @return The inner Bz value. + */
const std::string& get_innerField() const { return _innerField; }
+ /** + * Get the outer Bz value. + * @return The outer Bz value. + */
const std::string& get_outerField() const { return _outerField; }
+ /** + * Get the minimum Z value. + * @return The minimum Z. + */
const std::string& get_zmin() const { return _zmin; }
+ /** + * Get the maximum Z value. + * @return The maximum Z value. + */
const std::string& get_zmax() const { return _zmax; }
+ /** + * Get the inner radius. + * @return The inner radius. + */
const std::string& get_innerRadius() const { return _innerRadius; }
+ /** + * Get the outer radius. + * @return The outer radius. + */
const std::string& get_outerRadius() const { return _outerRadius;
diff -u -r1.5 -r1.6 --- TrackerType.hh 10 Jul 2013 18:06:18 -0000 1.5 +++ TrackerType.hh 12 Sep 2013 23:26:42 -0000 1.6 @@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/include/lcdd/schema/TrackerType.hh,v 1.5 2013/07/10 18:06:18 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/include/lcdd/schema/TrackerType.hh,v 1.6 2013/09/12 23:26:42 jeremy Exp $
#ifndef LCDD_SCHEMA_TRACKERTYPE_HH #define LCDD_SCHEMA_TRACKERTYPE_HH 1
@@ -17,19 +17,33 @@
public:
+ /** + * Class constructor. + */
TrackerType() { }
+ /** + * Class destructor. + */
virtual ~TrackerType() { }
+ /** + * Set whether to combine hits across steps. + * @param c Set combine hits. + */
void set_combine_hits(const std::string& c) { _combineHits = c; }
+ /** + * Get whether to combine hits across steps. + * @return This returns "true" if hits are combined and "false" if not. + */
const std::string& get_combine_hits() const { return _combineHits;
diff -u -r1.5 -r1.6 --- VisType.hh 10 Jul 2013 18:06:18 -0000 1.5 +++ VisType.hh 12 Sep 2013 23:26:42 -0000 1.6 @@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/include/lcdd/schema/VisType.hh,v 1.5 2013/07/10 18:06:18 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/include/lcdd/schema/VisType.hh,v 1.6 2013/09/12 23:26:42 jeremy Exp $
#ifndef LCDD_SCHEMA_VISTYPE_HH #define LCDD_SCHEMA_VISTYPE_HH 1
@@ -22,14 +22,25 @@
class visref: public SAXObject, public ReferenceType { public:
+ + /** + * Class constructor. + */
visref() { }
+ /** + * Class destructor. + */
virtual ~visref() { }
+ /** + * Get the object type. + * @return The object type (element). + */
virtual SAXObject::Type type() { return SAXObject::element;
@@ -37,71 +48,127 @@
}; public:
+ + /** + * Class constructor. + */
VisType() { }
+ /** + * Class destructor. + */
virtual ~VisType() { } public:
+ /** + * Set the name of the visualization attributes. + * @param n The name of the visualization attributes. + */
void set_name(const std::string& n) { _name = n; }
+ /** + * Set visibility; "true" for visible and "false" if invisible. + * @param v The visibility setting. + */
void set_visible(const std::string& v) { _visible = v; }
+ /** + * Set show daughter volumes; "true" for yes and "false" for no. + * @param d Set show daughters. + */
void set_show_daughters(const std::string& d) { _showDaughters = d; }
+ /** + * Set the line style; see schema for valid values. + * @param l The line style. + */
void set_line_style(const std::string& l) { _lineStyle = l; }
+ /** + * Set the drawing style; see schema for valid values. + * @param d The drawing style. + */
void set_drawing_style(const std::string& d) { _drawingStyle = d; }
+ /** + * Get the name of the visualization attributes. + * @return The name of the visualization attributes. + */
const std::string& get_name() const { return _name; }
+ /** + * Get visilibity setting. + * @return The visibility setting. + */
const std::string& get_visible() const { return _visible; }
+ /** + * Get show daughters setting. + * @return Show daughters setting. + */
const std::string& get_show_daughters() const { return _showDaughters; }
+ /** + * Get the line style. + * @return The line style. + */
const std::string& get_line_style() const { return _lineStyle; }
+ /** + * Get the drawing style. + * @return The drawing style. + */
const std::string& get_drawing_style() const { return _drawingStyle; }
+ /** + * Get the child content. + * @return The child content. + */
const ContentSequence* get_content() const { return &_sequence; }
+ /** + * Add child content. + * @param tag The child tag. + * @param so The child's SAXObject. + */
void add_content(const std::string& tag, SAXObject* so) { ContentGroup::ContentItem ci = { tag, so };
@@ -111,7 +178,6 @@
private: ContentSequence _sequence;
-
std::string _name; std::string _visible; std::string _showDaughters;
diff -u -r1.4 -r1.5 --- limit.hh 10 Jul 2013 18:06:18 -0000 1.4 +++ limit.hh 12 Sep 2013 23:26:42 -0000 1.5 @@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/include/lcdd/schema/limit.hh,v 1.4 2013/07/10 18:06:18 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/include/lcdd/schema/limit.hh,v 1.5 2013/09/12 23:26:42 jeremy Exp $
#ifndef LCDD_SCHEMA_LIMIT_HH #define LCDD_SCHEMA_LIMIT_HH 1
@@ -14,14 +14,25 @@
class limit: public SAXObject, public LimitParamType { public:
+ + /** + * Class constructor. + */
limit() { }
+ /** + * Class destructor. + */
virtual ~limit() { }
+ /** + * Get the type of the object which is XML element. + * @return The type of the object. + */
virtual SAXObject::Type type() { return SAXObject::element;
diff -u -r1.4 -r1.5 --- limitset.hh 10 Jul 2013 18:06:18 -0000 1.4 +++ limitset.hh 12 Sep 2013 23:26:42 -0000 1.5 @@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/include/lcdd/schema/limitset.hh,v 1.4 2013/07/10 18:06:18 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/include/lcdd/schema/limitset.hh,v 1.5 2013/09/12 23:26:42 jeremy Exp $
#ifndef LCDD_SCHEMA_LIMITSET_HH #define LCDD_SCHEMA_LIMITSET_HH 1
@@ -15,14 +15,24 @@
{ public:
+ /** + * Class constructor. + */
limitset() { }
+ /** + * Class destructor. + */
virtual ~limitset() { }
+ /** + * Get the type of this SAXObject. + * @return The type of this SAXObject. + */
virtual SAXObject::Type type() { return SAXObject::element;
diff -u -r1.4 -r1.5 --- nonprojective_cylinder.hh 10 Jul 2013 18:06:18 -0000 1.4 +++ nonprojective_cylinder.hh 12 Sep 2013 23:26:42 -0000 1.5 @@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/include/lcdd/schema/nonprojective_cylinder.hh,v 1.4 2013/07/10 18:06:18 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/include/lcdd/schema/nonprojective_cylinder.hh,v 1.5 2013/09/12 23:26:42 jeremy Exp $
#ifndef LCDD_SCHEMA_NONPROJECTIVE_CYLINDER_HH #define LCDD_SCHEMA_NONPROJECTIVE_CYLINDER_HH 1
@@ -16,14 +16,25 @@
{ public:
+ + /** + * Class constructor. + */
nonprojective_cylinder() { }
+ /** + * Class destructor. + */
virtual ~nonprojective_cylinder() { }
+ /** + * Get the type of this SAXObject. + * @return The type of this SAXObject. + */
virtual SAXObject::Type type() { return SAXObject::element;
diff -u -r1.4 -r1.5 --- physvolidElem.hh 10 Jul 2013 18:06:18 -0000 1.4 +++ physvolidElem.hh 12 Sep 2013 23:26:42 -0000 1.5 @@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/include/lcdd/schema/physvolidElem.hh,v 1.4 2013/07/10 18:06:18 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/include/lcdd/schema/physvolidElem.hh,v 1.5 2013/09/12 23:26:42 jeremy Exp $
#ifndef LCDD_SCHEMA_PHYSVOLID_HH #define LCDD_SCHEMA_PHYSVOLID_HH 1
@@ -15,14 +15,25 @@
{ public:
+ + /** + * Class constructor. + */
physvolidElem() { }
+ /** + * Class destructor. + */
virtual ~physvolidElem() { }
+ /** + * Get the type of this SAXObject. + * @return The type of this SAXObject. + */
virtual SAXObject::Type type() { return SAXObject::element;
diff -u -r1.4 -r1.5 --- projective_cylinder.hh 10 Jul 2013 18:06:18 -0000 1.4 +++ projective_cylinder.hh 12 Sep 2013 23:26:42 -0000 1.5 @@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/include/lcdd/schema/projective_cylinder.hh,v 1.4 2013/07/10 18:06:18 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/include/lcdd/schema/projective_cylinder.hh,v 1.5 2013/09/12 23:26:42 jeremy Exp $
#ifndef LCDD_SCHEMA_PROJECTIVE_CYLINDER_HH #define LCDD_SCHEMA_PROJECTIVE_CYLINDER_HH 1
@@ -16,14 +16,25 @@
{ public:
+ + /** + * Class constructor. + */
projective_cylinder() { }
+ /** + * Class destructor. + */
virtual ~projective_cylinder() { }
+ /** + * Get the type of this SAXObject. + * @return The type of this SAXObject. + */
virtual SAXObject::Type type() { return SAXObject::element;
diff -u -r1.4 -r1.5 --- projective_zplane.hh 10 Jul 2013 18:06:18 -0000 1.4 +++ projective_zplane.hh 12 Sep 2013 23:26:42 -0000 1.5 @@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/include/lcdd/schema/projective_zplane.hh,v 1.4 2013/07/10 18:06:18 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/include/lcdd/schema/projective_zplane.hh,v 1.5 2013/09/12 23:26:42 jeremy Exp $
#ifndef LCDD_SCHEMA_PROJECTIVE_ZPLANE_HH #define LCDD_SCHEMA_PROJECTIVE_ZPLANE_HH 1
@@ -16,14 +16,25 @@
{ public:
+ + /** + * Class constructor. + */
projective_zplane() { }
+ /** + * Class destructor. + */
virtual ~projective_zplane() { }
+ /** + * Get the type of this SAXObject. + * @return The type of this SAXObject. + */
virtual SAXObject::Type type() { return SAXObject::element;
diff -u -r1.4 -r1.5 --- region.hh 10 Jul 2013 18:06:18 -0000 1.4 +++ region.hh 12 Sep 2013 23:26:42 -0000 1.5 @@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/include/lcdd/schema/region.hh,v 1.4 2013/07/10 18:06:18 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/include/lcdd/schema/region.hh,v 1.5 2013/09/12 23:26:42 jeremy Exp $
#ifndef LCDD_SCHEMA_REGION_HH #define LCDD_SCHEMA_REGION_HH 1
@@ -15,14 +15,25 @@
class region: public SAXObject, public RegionType { public:
+ + /** + * Class constructor. + */
region() { }
+ /** + * Class destructor. + */
virtual ~region() { }
+ /** + * Get the type of this SAXObject. + * @return The type of this SAXObject. + */
virtual SAXObject::Type type() { return SAXObject::element;
diff -u -r1.4 -r1.5 --- rz_field_map.hh 10 Jul 2013 18:06:18 -0000 1.4 +++ rz_field_map.hh 12 Sep 2013 23:26:42 -0000 1.5 @@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/include/lcdd/schema/rz_field_map.hh,v 1.4 2013/07/10 18:06:18 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/include/lcdd/schema/rz_field_map.hh,v 1.5 2013/09/12 23:26:42 jeremy Exp $
#ifndef LCDD_SCHEMA_RZ_FIELD_MAP_HH #define LCDD_SCHEMA_RZ_FIELD_MAP_HH 1
@@ -12,14 +12,25 @@
class rz_field_map: public SAXObject, public RZFieldMapType { public:
+ + /** + * Class constructor. + */
rz_field_map() { }
+ /** + * Class destructor. + */
virtual ~rz_field_map() { }
+ /** + * Get the type of this SAXObject. + * @return The type of this SAXObject. + */
virtual SAXObject::Type type() { return SAXObject::element;
diff -u -r1.4 -r1.5 --- rzb.hh 10 Jul 2013 18:06:18 -0000 1.4 +++ rzb.hh 12 Sep 2013 23:26:42 -0000 1.5 @@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/include/lcdd/schema/rzb.hh,v 1.4 2013/07/10 18:06:18 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/include/lcdd/schema/rzb.hh,v 1.5 2013/09/12 23:26:42 jeremy Exp $
#ifndef LCDD_SCHEMA_RZB_HH #define LCDD_SCHEMA_RZB_HH 1
@@ -14,14 +14,25 @@
class rzb: public SAXObject, public RZBType { public:
+ + /** + * Class constructor. + */
rzb() { }
+ /** + * Class destructor. + */
virtual ~rzb() { }
+ /** + * Get the type of this SAXObject. + * @return The type of this SAXObject. + */
virtual SAXObject::Type type() { return SAXObject::element;
diff -u -r1.4 -r1.5 --- sensitive_detector.hh 10 Jul 2013 18:06:18 -0000 1.4 +++ sensitive_detector.hh 12 Sep 2013 23:26:42 -0000 1.5 @@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/include/lcdd/schema/sensitive_detector.hh,v 1.4 2013/07/10 18:06:18 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/include/lcdd/schema/sensitive_detector.hh,v 1.5 2013/09/12 23:26:42 jeremy Exp $
#ifndef LCDD_SCHEMA_SENSITIVE_DETECTOR_HH #define LCDD_SCHEMA_SENSITIVE_DETECTOR_HH 1
@@ -15,14 +15,25 @@
class sensitive_detector: public SAXObject, public SensitiveDetectorType { public:
+ + /** + * Class constructor. + */
sensitive_detector() { }
+ /** + * Class destructor. + */
virtual ~sensitive_detector() { }
+ /** + * Get the type of this SAXObject. + * @return The type of this SAXObject. + */
virtual SAXObject::Type type() { return SAXObject::element;
diff -u -r1.4 -r1.5 --- solenoid.hh 10 Jul 2013 18:06:18 -0000 1.4 +++ solenoid.hh 12 Sep 2013 23:26:42 -0000 1.5 @@ -1,4 +1,4 @@
-// $Id: solenoid.hh,v 1.4 2013/07/10 18:06:18 jeremy Exp $
+// $Id: solenoid.hh,v 1.5 2013/09/12 23:26:42 jeremy Exp $
#ifndef LCDD_SCHEMA_SOLENOID_HH #define LCDD_SCHEMA_SOLENOID_HH
@@ -15,14 +15,25 @@
class solenoid: public SAXObject, public SolenoidType { public:
+ + /** + * Class constructor. + */
solenoid() { }
+ /** + * Class destructor. + */
virtual ~solenoid() { }
+ /** + * Get the type of this SAXObject. + * @return The type of this SAXObject. + */
virtual SAXObject::Type type() { return SAXObject::element;
diff -u -r1.4 -r1.5 --- tracker.hh 10 Jul 2013 18:06:18 -0000 1.4 +++ tracker.hh 12 Sep 2013 23:26:42 -0000 1.5 @@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/include/lcdd/schema/tracker.hh,v 1.4 2013/07/10 18:06:18 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/include/lcdd/schema/tracker.hh,v 1.5 2013/09/12 23:26:42 jeremy Exp $
#ifndef LCDD_SCHEMA_TRACKER_HH #define LCDD_SCHEMA_TRACKER_HH 1
@@ -16,14 +16,25 @@
class tracker: public SAXObject, public TrackerType { public:
+ + /** + * Class constructor. + */
tracker() { }
+ /** + * Class destructor. + */
virtual ~tracker() { }
+ /** + * Get the type of this SAXObject. + * @return The type of this SAXObject. + */
virtual SAXObject::Type type() { //std::cout << "tracker::type()" << std::endl;
diff -u -r1.4 -r1.5 --- vis.hh 10 Jul 2013 18:06:18 -0000 1.4 +++ vis.hh 12 Sep 2013 23:26:42 -0000 1.5 @@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/include/lcdd/schema/vis.hh,v 1.4 2013/07/10 18:06:18 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/include/lcdd/schema/vis.hh,v 1.5 2013/09/12 23:26:42 jeremy Exp $
#ifndef LCDD_SCHEMA_VIS_HH #define LCDD_SCHEMA_VIS_HH 1
@@ -15,14 +15,25 @@
class vis: public SAXObject, public VisType { public:
+ + /** + * Class constructor. + */
vis() { }
+ /** + * Class destructor. + */
virtual ~vis() { }
+ /** + * Get the type of this SAXObject. + * @return The type of this SAXObject. + */
virtual SAXObject::Type type() { return SAXObject::element;
Use REPLY-ALL to reply to list
To unsubscribe from the LCD-CVS list, click the following link:
https://listserv.slac.stanford.edu/cgi-bin/wa?SUBED1=LCD-CVS&A=1