Commit in lcdd on MAIN | |||
include/lcdd/schema/AuthorType.hh | +24 | -1 | 1.5 -> 1.6 |
/BoxDipoleType.hh | +79 | -1 | 1.4 -> 1.5 |
/CalorimeterType.hh | +24 | -4 | 1.5 -> 1.6 |
/CellReadout2DSegmentationType.hh | +31 | -1 | 1.6 -> 1.7 |
/ColorType.hh | +41 | -1 | 1.5 -> 1.6 |
/CommentType.hh | +16 | -1 | 1.5 -> 1.6 |
/DetectorType.hh | +32 | -1 | 1.5 -> 1.6 |
/DipoleCoeffType.hh | +16 | -1 | 1.5 -> 1.6 |
/DipoleType.hh | +40 | -2 | 1.5 -> 1.6 |
/FieldMap3DType.hh | +39 | -3 | 1.5 -> 1.6 |
/FieldMapType.hh | +16 | -1 | 1.5 -> 1.6 |
/FieldType.hh | +43 | -1 | 1.4 -> 1.5 |
/GeneratorType.hh | +40 | -1 | 1.5 -> 1.6 |
/GlobalFieldType.hh | +17 | -1 | 1.5 -> 1.6 |
/GlobalGridXYSegmentationType.hh | +35 | -5 | 1.5 -> 1.6 |
/HeaderType.hh | +17 | -1 | 1.5 -> 1.6 |
/HitProcessorType.hh | +24 | -1 | 1.2 -> 1.3 |
/HitsCollectionType.hh | +19 | -1 | 1.2 -> 1.3 |
/IdFieldType.hh | +40 | -1 | 1.5 -> 1.6 |
/author.hh | +12 | -1 | 1.5 -> 1.6 |
/box_dipole.hh | +11 | -1 | 1.4 -> 1.5 |
/calorimeter.hh | +12 | -1 | 1.4 -> 1.5 |
/cell_readout_2d.hh | +11 | -1 | 1.5 -> 1.6 |
/color.hh | +12 | -1 | 1.4 -> 1.5 |
/comment.hh | +12 | -1 | 1.4 -> 1.5 |
/detector.hh | +12 | -1 | 1.4 -> 1.5 |
/dipole.hh | +12 | -1 | 1.4 -> 1.5 |
/dipole_coeff.hh | +12 | -1 | 1.4 -> 1.5 |
/field.hh | +11 | -1 | 1.4 -> 1.5 |
/field_map_3d.hh | +11 | -1 | 1.4 -> 1.5 |
/generator.hh | +12 | -1 | 1.4 -> 1.5 |
/global_field.hh | +12 | -1 | 1.4 -> 1.5 |
/global_grid_xy.hh | +11 | -1 | 1.4 -> 1.5 |
/grid_xyz.hh | +12 | -1 | 1.4 -> 1.5 |
/header.hh | +12 | -1 | 1.4 -> 1.5 |
/hit_processor.hh | +11 | -1 | 1.2 -> 1.3 |
/hits_collection.hh | +15 | -1 | 1.2 -> 1.3 |
/idfieldElem.hh | +14 | -2 | 1.4 -> 1.5 |
/idspecElem.hh | +12 | -1 | 1.4 -> 1.5 |
src/lcdd/processes/global_grid_xyProcess.cc | +3 | -3 | 1.2 -> 1.3 |
src/lcdd/segmentation/SegmentationFactory.cc | +3 | -3 | 1.1 -> 1.2 |
+838 | -56 |
add missing doxygen comments
diff -u -r1.5 -r1.6 --- AuthorType.hh 10 Jul 2013 18:06:18 -0000 1.5 +++ AuthorType.hh 12 Sep 2013 19:45:10 -0000 1.6 @@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/include/lcdd/schema/AuthorType.hh,v 1.5 2013/07/10 18:06:18 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/include/lcdd/schema/AuthorType.hh,v 1.6 2013/09/12 19:45:10 jeremy Exp $
#ifndef LCDD_SCHEMA_AUTHORTYPE_HH #define LCDD_SCHEMA_AUTHORTYPE_HH 1
@@ -12,29 +12,52 @@
class AuthorType { public:
+ + /** + * Class constructor. + */
AuthorType() { }
+ /** + * Class destructor. + */
virtual ~AuthorType() { }
+ /** + * Set the name of the author. + * @param n The name string. + */
void set_name(const std::string& n) { _name = n; }
+ /** + * Set the email of the author. + * @param o The email string. + */
void set_email(const std::string& o) { _email = o; }
+ /** + * Get the name of the author. + * @return The name of the author. + */
const std::string& get_name() const { return _name; }
+ /** + * Get the email of the author. + * @return The email of the author. + */
const std::string& get_email() const { return _email;
diff -u -r1.4 -r1.5 --- BoxDipoleType.hh 10 Jul 2013 18:06:18 -0000 1.4 +++ BoxDipoleType.hh 12 Sep 2013 19:45:10 -0000 1.5 @@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/include/lcdd/schema/BoxDipoleType.hh,v 1.4 2013/07/10 18:06:18 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/include/lcdd/schema/BoxDipoleType.hh,v 1.5 2013/09/12 19:45:10 jeremy Exp $
#ifndef LCDD_SCHEMA_BOXDIPOLETYPE_HH #define LCDD_SCHEMA_BOXDIPOLETYPE_HH 1
@@ -14,101 +14,179 @@
public:
+ /** + * Class constructor. + */
BoxDipoleType() { }
+ /** + * Class destructor. + */
virtual ~BoxDipoleType() { } public:
+ /** + * Set the x position. + * @param s The x position. + */
void set_x(const std::string& s) { _x = s; }
+ /** + * Set the y position. + * @param s The y position. + */
void set_y(const std::string& s) { _y = s; }
+ /** + * Set the z position. + * @param s The z position. + */
void set_z(const std::string& s) { _z = s; }
+ /** + * Set the x half dimension of the box. + * @param s The box's x half dimension. + */
void set_dx(const std::string& s) { _dx = s; }
+ /** + * Set the y half dimension of the box. + * @param s The box's y half dimension. + */
void set_dy(const std::string& s) { _dy = s; }
+ /** + * Set the z half dimension of the box. + * @param s The box's z half dimension. + */
void set_dz(const std::string& s) { _dz = s; }
+ /** + * Set the fixed Bx component for the region. + * @param s The Bx component. + */
void set_bx(const std::string& s) { _bx = s; }
+ /** + * Set the fixed By component for the region. + * @param s The By component. + */
void set_by(const std::string& s) { _by = s; }
+ /** + * Set the fixed Bz component for the region. + * @param s The Bz component. + */
void set_bz(const std::string& s) { _bz = s; }
+ /** + * Get the x position. + * @return The x position. + */
const std::string& get_x() const { return _x; }
+ /** + * Get the y position. + * @return The y position. + */
const std::string& get_y() const { return _y; }
+ /** + * Get the z position. + * @return The z position. + */
const std::string& get_z() const { return _z; }
+ /** + * Get the box half dimension in x. + * @return The box half dimension in x. + */
const std::string& get_dx() const { return _dx; }
+ /** + * Get the box half dimension in y. + * @return The box half dimension in y. + */
const std::string& get_dy() const { return _dy; }
+ /** + * Get the box half dimension in z. + * @return The box half dimension in z. + */
const std::string& get_dz() const { return _dz; }
+ /** + * Get the fixed Bx component. + * @return The Bx component. + */
const std::string& get_bx() const { return _bx; }
+ /** + * Get the fixed By component. + * @return The By component. + */
const std::string& get_by() const { return _by; }
+ /** + * Get the fixed Bz component. + * @return The Bz component. + */
const std::string& get_bz() const { return _bz;
diff -u -r1.5 -r1.6 --- CalorimeterType.hh 10 Jul 2013 18:06:18 -0000 1.5 +++ CalorimeterType.hh 12 Sep 2013 19:45:10 -0000 1.6 @@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/include/lcdd/schema/CalorimeterType.hh,v 1.5 2013/07/10 18:06:18 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/include/lcdd/schema/CalorimeterType.hh,v 1.6 2013/09/12 19:45:10 jeremy Exp $
#ifndef LCDD_SCHEMA_CALORIMETERTYPE_HH #define LCDD_SCHEMA_CALORIMETERTYPE_HH 1
@@ -20,33 +20,55 @@
public:
+ /** + * Class constructor. + */
CalorimeterType() { }
+ /** + * Class destructor. + */
virtual ~CalorimeterType() { } public:
+ /** + * Get the child content of the element. + * @return The child content. + */
const ContentSequence* get_content() const { return &_sequence; }
- // add a segmentation
+ /** + * Add child content to the element. + * @param tag The child tag to add. + * @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); }
+ /** + * Set the comparison algorithm type. + * @param compare The comparison algorithm type. + */
void set_compare(const std::string& compare) { _compare = compare; }
+ /** + * Get the comparison algorithm type. + * @return The comparison algorithm type. + */
const std::string& get_compare() const { return _compare;
@@ -55,9 +77,7 @@
private: ContentSequence _sequence;
-
std::string _compare;
-
}; #endif
diff -u -r1.6 -r1.7 --- CellReadout2DSegmentationType.hh 10 Jul 2013 18:06:18 -0000 1.6 +++ CellReadout2DSegmentationType.hh 12 Sep 2013 19:45:10 -0000 1.7 @@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/include/lcdd/schema/CellReadout2DSegmentationType.hh,v 1.6 2013/07/10 18:06:18 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/include/lcdd/schema/CellReadout2DSegmentationType.hh,v 1.7 2013/09/12 19:45:10 jeremy Exp $
#ifndef LCDD_CELLREADOUT2DSEGMENTATIONTYPE_HH #define LCDD_CELLREADOUT2DSEGMENTATIONTYPE_HH 1
@@ -17,41 +17,71 @@
public:
+ /** + * Class constructor. + */
CellReadout2DSegmentationType() { }
+ /** + * Class destructor. + */
virtual ~CellReadout2DSegmentationType() { } public:
+ /** + * Set the x cell size. + * @param[i] cellSizeX The x cell size. + */
void setCellSizeX(const std::string& cellSizeX) { _cellSizeX = cellSizeX; }
+ /** + * Set the y cell size. + * @param[i] cellSizeX The y cell size. + */
void setCellSizeY(const std::string& cellSizeY) { _cellSizeY = cellSizeY; }
+ /** + * Set the length unit for the cell sizes. + * @param lengthUnit[i] The length unit of the cells. + */
void setLengthUnit(const std::string& lengthUnit) { _lengthUnit = lengthUnit; }
+ /** + * Get the cell size x. + * @return The x cell size. + */
const std::string& getCellSizeX() { return _cellSizeX; }
+ /** + * Get the cell size y. + * @return The y cell size. + */
const std::string& getCellSizeY() { return _cellSizeY; }
+ /** + * Get the cell size z. + * @return The z cell size. + */
const std::string& getLengthUnit() { return _lengthUnit;
diff -u -r1.5 -r1.6 --- ColorType.hh 10 Jul 2013 18:06:18 -0000 1.5 +++ ColorType.hh 12 Sep 2013 19:45:10 -0000 1.6 @@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/include/lcdd/schema/ColorType.hh,v 1.5 2013/07/10 18:06:18 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/include/lcdd/schema/ColorType.hh,v 1.6 2013/09/12 19:45:10 jeremy Exp $
#ifndef LCDD_SCHEMA_COLORTYPE_HH #define LCDD_SCHEMA_COLORTYPE_HH 1
@@ -11,50 +11,90 @@
*/ class ColorType {
+
public:
+ + /** + * Class constructor. + */
ColorType() { }
+ /** + * Class destructor. + */
virtual ~ColorType() { }
+ /** + * Set the red color value. + * @param[i] r The red color value. + */
void set_R(const std::string& r) { _R = r; }
+ /** + * Set the green color value. + * @param[i] g The green color value. + */
void set_G(const std::string& g) { _G = g; }
+ /** + * Set the blue color value. + * @param[i] b The blue color value. + */
void set_B(const std::string& b) { _B = b; }
+ /** + * Set the alpha value. + * @param[i] a The alpha value. + */
void set_alpha(const std::string& a) { _alpha = a; }
+ /** + * Get the red value. + * @return The red value. + */
const std::string& get_R() { return _R; }
+ /** + * Get the green value. + * @return The green value. + */
const std::string& get_G() { return _G; }
+ /** + * Get the blue value. + * @return The blue value. + */
const std::string& get_B() { return _B; }
+ /** + * Get the alpha value. + * @return The alpha value. + */
const std::string& get_alpha() { return _alpha;
diff -u -r1.5 -r1.6 --- CommentType.hh 10 Jul 2013 18:06:18 -0000 1.5 +++ CommentType.hh 12 Sep 2013 19:45:10 -0000 1.6 @@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/include/lcdd/schema/CommentType.hh,v 1.5 2013/07/10 18:06:18 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/include/lcdd/schema/CommentType.hh,v 1.6 2013/09/12 19:45:10 jeremy Exp $
#ifndef LCDD_SCHEMA_COMMENTTYPE_HH #define LCDD_SCHEMA_COMMENTTYPE_HH 1
@@ -12,19 +12,34 @@
class CommentType { public:
+ + /** + * Class destructor. + */
CommentType() { }
+ /** + * Class destructor. + */
virtual ~CommentType() { }
+ /** + * Set the comment contents. + * @param c The comment. + */
void set_comment(const std::string& c) { _comment = c; }
+ /** + * Get the comment. + * @return The comment. + */
const std::string& get_comment() const { return _comment;
diff -u -r1.5 -r1.6 --- DetectorType.hh 10 Jul 2013 18:06:18 -0000 1.5 +++ DetectorType.hh 12 Sep 2013 19:45:10 -0000 1.6 @@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/include/lcdd/schema/DetectorType.hh,v 1.5 2013/07/10 18:06:18 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/include/lcdd/schema/DetectorType.hh,v 1.6 2013/09/12 19:45:10 jeremy Exp $
#ifndef LCDD_SCHEMA_DETECTORTYPE_HH #define LCDD_SCHEMA_DETECTORTYPE_HH 1
@@ -12,41 +12,72 @@
class DetectorType { public:
+ + /** + * Class constructor. + */
DetectorType() { }
+ /** + * Class destructor. + */
virtual ~DetectorType() { } public:
+ /** + * Set the name. + * @param[i] The name. + */
void set_name(const std::string& n) { _name = n; }
+ /** + * Set the version. + * @param v The version. + */
void set_version(const std::string& v) { _version = v; }
+ /** + * Set the URL. + * @param u The URL. + */
void set_url(const std::string& u) { _url = u; }
+ /** + * Get the name. + * @return The name. + */
const std::string& get_name() const { return _name; }
+ /** + * Get the version. + * @return The version. + */
const std::string& get_version() const { return _version; }
+ /** + * Get the URL. + * @return The URL. + */
const std::string& get_url() const { return _url;
diff -u -r1.5 -r1.6 --- DipoleCoeffType.hh 10 Jul 2013 18:06:18 -0000 1.5 +++ DipoleCoeffType.hh 12 Sep 2013 19:45:10 -0000 1.6 @@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/include/lcdd/schema/DipoleCoeffType.hh,v 1.5 2013/07/10 18:06:18 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/include/lcdd/schema/DipoleCoeffType.hh,v 1.6 2013/09/12 19:45:10 jeremy Exp $
#ifndef LCDD_SCHEMA_DIPOLECOEFFTYPE_HH #define LCDD_SCHEMA_DIPOLECOEFFTYPE_HH
@@ -11,21 +11,36 @@
class DipoleCoeffType { public:
+ + /** + * Class constructor. + */
DipoleCoeffType() { }
+ /** + * Class destructor. + */
virtual ~DipoleCoeffType() { } public:
+ /** + * Set the dipole coefficient value. + * @param s The dipole coefficient value. + */
void set_value(const std::string& s) { _value = s; }
+ /** + * Get the dipole coefficient value. + * @return The dipole coefficient value. + */
const std::string& get_value() { return _value;
diff -u -r1.5 -r1.6 --- DipoleType.hh 10 Jul 2013 18:06:18 -0000 1.5 +++ DipoleType.hh 12 Sep 2013 19:45:10 -0000 1.6 @@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/include/lcdd/schema/DipoleType.hh,v 1.5 2013/07/10 18:06:18 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/include/lcdd/schema/DipoleType.hh,v 1.6 2013/09/12 19:45:10 jeremy Exp $
#ifndef LCDD_SCHEMA_DIPOLETYPE_HH #define LCDD_SCHEMA_DIPOLETYPE_HH 1
@@ -19,52 +19,91 @@
{ public:
+ /** + * Class constructor. + */
DipoleType() { }
+ /** + * Class destructor. + */
virtual ~DipoleType() { } public:
+ /** + * Set the maximum Z value. + * @param s The max Z value. + */
void set_zmax(const std::string& s) { _zmax = s; }
+ /** + * Set the minimum Z value. + * @param s + */
void set_zmin(const std::string& s) { _zmin = s; }
+ /** + * Set the maximum R value. + * @param s + */
void set_rmax(const std::string& s) { _rmax = s; }
+ /** + * Get the minimum Z value. + * @return The minimum Z value. + */
const std::string& get_zmin() const { return _zmin; }
+ /** + * Get the maximum Z value. + * @return + */
const std::string& get_zmax() const { return _zmax; }
+ /** + * Get the maximum R value. + * @return The maximum R value. + */
const std::string& get_rmax() const { return _rmax; }
+ /** + * Add child content. + * @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 content sequence of this element. + * @return The content sequence of the element. + */
const ContentSequence* get_content() const { return &_sequence;
@@ -75,7 +114,6 @@
std::string _zmax; std::string _zmin; std::string _rmax;
-
ContentSequence _sequence; };
diff -u -r1.5 -r1.6 --- FieldMap3DType.hh 4 Sep 2013 00:38:03 -0000 1.5 +++ FieldMap3DType.hh 12 Sep 2013 19:45:10 -0000 1.6 @@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/include/lcdd/schema/FieldMap3DType.hh,v 1.5 2013/09/04 00:38:03 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/include/lcdd/schema/FieldMap3DType.hh,v 1.6 2013/09/12 19:45:10 jeremy Exp $
#ifndef LCDD_SCHEMA_FIELDMAP3DTYPE_HH #define LCDD_SCHEMA_FIELDMAP3DTYPE_HH 1
@@ -16,56 +16,92 @@
public:
+ /** + * Class constructor. + */
FieldMap3DType() { }
+ /** + * Class destructor. + */
virtual ~FieldMap3DType() { }
+ /** + * Set the filename containing the field map data. + * @param filename The path of the file containing the field map data. + */
void set_filename(const std::string& filename) { _filename = filename; }
+ /** + * Get the filename of the field map data. + * @return The filename with the field map data. + */
const std::string& get_filename() const { return _filename; }
+ /** + * Set the x offset of the map. + * @param xoffset The x offset. + */
void set_xoffset(const std::string& xoffset) { _xoffset = xoffset; }
+ /** + * Set the y offset of the map. + * @param yoffset The y offset. + */
void set_yoffset(const std::string& yoffset) { _xoffset = yoffset; }
+ /** + * Set the z offset of the map. + * @param zoffset The z offset. + */
void set_zoffset(const std::string& zoffset) { _xoffset = zoffset; }
+ /** + * Get the x offset of the map. + * @return The x offset. + */
const std::string& get_xoffset() const { return _xoffset; }
+ /** + * Get the y offset of the map. + * @return The y offset. + */
const std::string& get_yoffset() const { return _yoffset; }
+ /** + * Get the z offset of the map. + * @return The z offset. + */
const std::string& get_zoffset() const { return _zoffset; }
- -
private: std::string _filename;
diff -u -r1.5 -r1.6 --- FieldMapType.hh 10 Jul 2013 18:06:18 -0000 1.5 +++ FieldMapType.hh 12 Sep 2013 19:45:10 -0000 1.6 @@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/include/lcdd/schema/FieldMapType.hh,v 1.5 2013/07/10 18:06:18 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/include/lcdd/schema/FieldMapType.hh,v 1.6 2013/09/12 19:45:10 jeremy Exp $
#ifndef LCDD_SCHEMA_FIELDMAPTYPE_HH #define LCDD_SCHEMA_FIELDMAPTYPE_HH 1
@@ -16,21 +16,36 @@
{ public:
+ /** + * Class constructor. + */
FieldMapType() { }
+ /** + * Class destructor. + */
virtual ~FieldMapType() { } public:
+ /** + * Get the element content. + * @return The element's content. + */
const ContentSequence* get_content() const { return &_sequence; }
+ /** + * Add content. + * @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 };
diff -u -r1.4 -r1.5 --- FieldType.hh 10 Jul 2013 18:06:18 -0000 1.4 +++ FieldType.hh 12 Sep 2013 19:45:10 -0000 1.5 @@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/include/lcdd/schema/FieldType.hh,v 1.4 2013/07/10 18:06:18 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/include/lcdd/schema/FieldType.hh,v 1.5 2013/09/12 19:45:10 jeremy Exp $
#ifndef LCDD_SCHEMA_FIELDTYPE_HH #define LCDD_SCHEMA_FIELDTYPE_HH 1
@@ -22,15 +22,27 @@
*/ class fieldref: public SAXObject, public ReferenceType {
+
public:
+ + /** + * Class constructor. + */
fieldref() { }
+ /** + * Class destructor. + */
virtual ~fieldref() { }
+ /** + * Get the type of this SAXObject. + * @return The type of this SAXObject. + */
virtual SAXObject::Type type() { return SAXObject::element;
@@ -39,39 +51,69 @@
public:
+ /** + * Class constructor. + */
FieldType() { }
+ /** + * Class destructor. + */
virtual ~FieldType() { }
+ /** + * Set the name of the field. + * @param n The name of the field. + */
void set_name(const std::string& n) { _name = n; }
+ /** + * Get the name of the field. + * @return The name of the field. + */
const std::string& get_name() const { return _name; }
+ /** + * Set the field unit. + * @param s The field unit. + */
void set_funit(const std::string& s) { _funit = s; }
+ /** + * Set the length unit. + * @param s The length unit. + */
void set_lunit(const std::string& s) { _lunit = s; }
+ /** + * Get the field unit. + * @return The field unit. + */
const std::string& get_funit() const { return _funit; }
+ /** + * Get the length unit. + * @return The length unit. + */
const std::string& get_lunit() const { return _lunit;
diff -u -r1.5 -r1.6 --- GeneratorType.hh 10 Jul 2013 18:06:18 -0000 1.5 +++ GeneratorType.hh 12 Sep 2013 19:45:10 -0000 1.6 @@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/include/lcdd/schema/GeneratorType.hh,v 1.5 2013/07/10 18:06:18 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/include/lcdd/schema/GeneratorType.hh,v 1.6 2013/09/12 19:45:10 jeremy Exp $
#ifndef LCDD_SCHEMA_GENERATORTYPE_HH #define LCDD_SCHEMA_GENERATORTYPE_HH 1
@@ -12,49 +12,88 @@
class GeneratorType { public:
+ + /** + * Class constructor. + */
GeneratorType() { }
+ /** + * Class destructor. + */
virtual ~GeneratorType() { }
+ /** + * Set the name of the generator. + * @param n The name of the generator. + */
void set_name(const std::string& n) { _name = n; }
+ /** + * Set the version of the generator. + * @param v The version of the generator. + */
void set_version(const std::string& v) { _version = v; }
+ /** + * Set the file from which the LCDD was generated. + * @param u The file that generated the LCDD. + */
void set_file(const std::string& u) { _file = u; }
+ /** + * Set the checksum of the LCDD file. + * @param c The checksum of the LCDD file. + */
void set_checksum(const std::string& c) { _checksum = c; }
+ /** + * Get the name of the generator. + * @return The name of the generator. + */
const std::string& get_name() const { return _name; }
+ /** + * Get the version of the generator. + * @return The version of the generator. + */
const std::string& get_version() const { return _version; }
+ /** + * Get the file from which the LCDD was generated. + * @return The file that generated the LCDD. + */
const std::string& get_file() const { return _file; }
+ /** + * Get the checksum of the LCDD file. + * @return The checksum of the file. + */
const std::string& get_checksum() const { return _checksum;
diff -u -r1.5 -r1.6 --- GlobalFieldType.hh 10 Jul 2013 18:06:18 -0000 1.5 +++ GlobalFieldType.hh 12 Sep 2013 19:45:10 -0000 1.6 @@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/include/lcdd/schema/GlobalFieldType.hh,v 1.5 2013/07/10 18:06:18 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/include/lcdd/schema/GlobalFieldType.hh,v 1.6 2013/09/12 19:45:10 jeremy Exp $
#ifndef LCDD_SCHEMA_GLOBALFIELDTYPE_HH #define LCDD_SCHEMA_GLOBALFIELDTYPE_HH 1
@@ -12,19 +12,35 @@
class GlobalFieldType { public:
+ + /** + * Class constructor. + */
GlobalFieldType() { }
+ /** + * Class destructor. + */
virtual ~GlobalFieldType() { }
+ /** + * Get the content of the field. + * @return The content of the XML element. + */
const ContentSequence* get_content() const { return &_sequence; }
+ /** + * Add content. + * @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 };
diff -u -r1.5 -r1.6 --- GlobalGridXYSegmentationType.hh 10 Jul 2013 18:06:18 -0000 1.5 +++ GlobalGridXYSegmentationType.hh 12 Sep 2013 19:45:10 -0000 1.6 @@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/include/lcdd/schema/GlobalGridXYSegmentationType.hh,v 1.5 2013/07/10 18:06:18 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/include/lcdd/schema/GlobalGridXYSegmentationType.hh,v 1.6 2013/09/12 19:45:10 jeremy Exp $
#ifndef LCDD_SCHEMA_GLOBALGRIDXYSEGMENTATIONTYPE_HH #define LCDD_SCHEMA_GLOBALGRIDXYSEGMENTATIONTYPE_HH 1
@@ -19,41 +19,71 @@
{ public:
+ /** + * Class constructor. + */
GlobalGridXYSegmentationType() { }
+ /** + * Class destructor. + */
virtual ~GlobalGridXYSegmentationType() { } public:
- void set_gridSizeX(const std::string& gsx)
+ /** + * Set the x grid size. + * @param gsx The x grid size. + */ + void set_grid_size_x(const std::string& gsx)
{ _gridSizeX = gsx; }
- void set_gridSizeY(const std::string& gsy)
+ /** + * Set the y grid size. + * @param gsy The y grid size. + */ + void set_grid_size_y(const std::string& gsy)
{ _gridSizeY = gsy; }
+ /** + * Set the length unit. + * @param lunit The length unit. + */
void set_lunit(const std::string& lunit) { _lunit = lunit; }
- const std::string& get_gridSizeX()
+ /** + * Get the x grid size. + * @return The x grid size. + */ + const std::string& get_grid_size_x()
{ return _gridSizeX; }
- const std::string& get_gridSizeY()
+ /** + * Get the y grid size. + * @return The y grid size. + */ + const std::string& get_grid_size_y()
{ return _gridSizeY; }
+ /** + * Get the length unit. + * @return The length unit. + */
const std::string& get_lunit() { return _lunit;
diff -u -r1.5 -r1.6 --- HeaderType.hh 10 Jul 2013 18:06:18 -0000 1.5 +++ HeaderType.hh 12 Sep 2013 19:45:10 -0000 1.6 @@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/include/lcdd/schema/HeaderType.hh,v 1.5 2013/07/10 18:06:18 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/include/lcdd/schema/HeaderType.hh,v 1.6 2013/09/12 19:45:10 jeremy Exp $
#ifndef LCDD_SCHEMA_HEADERTYPE_HH #define LCDD_SCHEMA_HEADERTYPE_HH 1
@@ -15,20 +15,36 @@
class HeaderType { public:
+ + /** + * Class constructor. + */
HeaderType() { }
+ /** + * Class destructor. + */
virtual ~HeaderType() { }
+ /** + * Add content. + * @param tag The child 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 element's child content. + */
const ContentSequence* get_content() const { return &_sequence;
diff -u -r1.2 -r1.3 --- HitProcessorType.hh 22 Aug 2013 22:32:16 -0000 1.2 +++ HitProcessorType.hh 12 Sep 2013 19:45:10 -0000 1.3 @@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/include/lcdd/schema/HitProcessorType.hh,v 1.2 2013/08/22 22:32:16 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/include/lcdd/schema/HitProcessorType.hh,v 1.3 2013/09/12 19:45:10 jeremy Exp $
#ifndef LCDD_SCHEMA_HITPROCESSORTYPE_HH #define LCDD_SCHEMA_HITPROCESSORTYPE_HH 1
@@ -9,19 +9,42 @@
// GDML #include "Schema/ContentGroup.h"
+/** + * @brief + * The HitProcessor from the XML schema. + */
class HitProcessorType { public:
+ /** + * Class constructor. + */
HitProcessorType();
+ /** + * Class destructor. + */
virtual ~HitProcessorType();
+ /** + * Set the type of the HitProcessor. + * @param s The type of the HitProcessor. + */
void set_type(const std::string& s);
+ /** + * Get the type of the HitProcessor. + * @return The type of the HitProcessor. + */
const std::string& get_type() const;
+ /** + * Add child content. + * @param tag The tag of the child. + * @param so The SAXObject of the child. + */
void add_content(const std::string& tag, SAXObject* so); private:
diff -u -r1.2 -r1.3 --- HitsCollectionType.hh 22 Aug 2013 22:32:16 -0000 1.2 +++ HitsCollectionType.hh 12 Sep 2013 19:45:10 -0000 1.3 @@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/include/lcdd/schema/HitsCollectionType.hh,v 1.2 2013/08/22 22:32:16 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/include/lcdd/schema/HitsCollectionType.hh,v 1.3 2013/09/12 19:45:10 jeremy Exp $
#ifndef LCDD_SCHEMA_HITSCOLLECTIONTYPE_HH #define LCDD_SCHEMA_HITSCOLLECTIONTYPE_HH 1
@@ -9,17 +9,35 @@
// GDML #include "Schema/ContentGroup.h"
+/** + * @brief + * The HitsCollectionType from the XML schema. + */
class HitsCollectionType { public:
+ /** + * Class constructor. + */
HitsCollectionType();
+ /** + * Class destructor. + */
virtual ~HitsCollectionType();
+ /** + * Set the name of the HitsCollection. + * @param s The name of the HitsCollection. + */
void set_name(const std::string& s);
+ /** + * Get the name of the HitsCollection. + * @return The name of the HitsCollection. + */
const std::string& get_name() const; private:
diff -u -r1.5 -r1.6 --- IdFieldType.hh 10 Jul 2013 18:06:18 -0000 1.5 +++ IdFieldType.hh 12 Sep 2013 19:45:10 -0000 1.6 @@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/include/lcdd/schema/IdFieldType.hh,v 1.5 2013/07/10 18:06:18 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/include/lcdd/schema/IdFieldType.hh,v 1.6 2013/09/12 19:45:10 jeremy Exp $
#ifndef LCDD_SCHEMA_IDFIELDTYPE_HH #define LCDD_SCHEMA_IDFIELDTYPE_HH 1
@@ -12,51 +12,90 @@
class IdFieldType { public:
+ + /** + * Class constructor. + */
IdFieldType() { }
+ /** + * Class destructor. + */
virtual ~IdFieldType() { } public:
+ /** + * Set the label of the field. + * @param l The label of the field. + */
void set_label(const std::string& l) { _label = l; }
+ /** + * Set the starting position of the field. + * @param s The starting position of the field. + */
void set_start(const std::string& s) { _start = s; }
+ /** + * Set the bit length of the field. + * @param l The bit length of the field. + */
void set_length(const std::string& l) { _length = l; }
+ /** + * Set whether the field is signed or not. + * @param s Set value for field sign. + */
void set_signed(const std::string& s) { _signed = s; }
+ /** + * Get the label of the field. + * @return The label of the field. + */
const std::string& get_label() { return _label; }
+ /** + * Get the starting bit position of the field. + * @return The starting bit position. + */
const std::string& get_start() { return _start; }
+ /** + * Get the length of the field. + * @return The length of the field. + */
const std::string& get_length() { return _length; }
+ /** + * Get whether the field is signed or not. + * @return The signage of the field. + */
const std::string& get_signed() { return _signed;
diff -u -r1.5 -r1.6 --- author.hh 10 Jul 2013 18:06:18 -0000 1.5 +++ author.hh 12 Sep 2013 19:45:10 -0000 1.6 @@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/include/lcdd/schema/author.hh,v 1.5 2013/07/10 18:06:18 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/include/lcdd/schema/author.hh,v 1.6 2013/09/12 19:45:10 jeremy Exp $
#ifndef LCDD_SCHEMA_AUTHOR_HH #define LCDD_SCHEMA_AUTHOR_HH 1
@@ -13,14 +13,25 @@
class author: public SAXObject, public AuthorType { public:
+ + /** + * Class constructor. + */
author() { }
+ /** + * Class destructor. + */
virtual ~author() { }
+ /** + * 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 --- box_dipole.hh 10 Jul 2013 18:06:18 -0000 1.4 +++ box_dipole.hh 12 Sep 2013 19:45:10 -0000 1.5 @@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/include/lcdd/schema/box_dipole.hh,v 1.4 2013/07/10 18:06:18 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/include/lcdd/schema/box_dipole.hh,v 1.5 2013/09/12 19:45:10 jeremy Exp $
#ifndef LCDD_SCHEMA_BOX_DIPOLE_HH #define LCDD_SCHEMA_BOX_DIPOLE_HH 1
@@ -17,14 +17,24 @@
public:
+ /** + * Class constructor. + */
box_dipole() { }
+ /** + * Class destructor. + */
virtual ~box_dipole() { }
+ /** + * 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 --- calorimeter.hh 10 Jul 2013 18:06:18 -0000 1.4 +++ calorimeter.hh 12 Sep 2013 19:45:10 -0000 1.5 @@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/include/lcdd/schema/calorimeter.hh,v 1.4 2013/07/10 18:06:18 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/include/lcdd/schema/calorimeter.hh,v 1.5 2013/09/12 19:45:10 jeremy Exp $
#ifndef LCDD_SCHEMA_CALORIMETER_HH #define LCDD_SCHEMA_CALORIMETER_HH 1
@@ -14,14 +14,25 @@
class calorimeter: public SAXObject, public CalorimeterType { public:
+ + /** + * Class constructor. + */
calorimeter() { }
+ /** + * Class destructor. + */
virtual ~calorimeter() { }
+ /** + * Get the type of this SAXObject. + * @return The type of this SAXObject. + */
virtual SAXObject::Type type() { return SAXObject::element;
diff -u -r1.5 -r1.6 --- cell_readout_2d.hh 10 Jul 2013 18:06:18 -0000 1.5 +++ cell_readout_2d.hh 12 Sep 2013 19:45:10 -0000 1.6 @@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/include/lcdd/schema/cell_readout_2d.hh,v 1.5 2013/07/10 18:06:18 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/include/lcdd/schema/cell_readout_2d.hh,v 1.6 2013/09/12 19:45:10 jeremy Exp $
#ifndef LCDD_SCHEMA_CELL_READOUT_2D_HH #define LCDD_SCHEMA_CELL_READOUT_2D_HH 1
@@ -17,14 +17,24 @@
public:
+ /** + * Class constructor. + */
cell_readout_2d() { }
+ /** + * Class destructor. + */
virtual ~cell_readout_2d() { }
+ /** + * 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 --- color.hh 10 Jul 2013 18:06:18 -0000 1.4 +++ color.hh 12 Sep 2013 19:45:10 -0000 1.5 @@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/include/lcdd/schema/color.hh,v 1.4 2013/07/10 18:06:18 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/include/lcdd/schema/color.hh,v 1.5 2013/09/12 19:45:10 jeremy Exp $
#ifndef LCDD_SCHEMA_COLOR_HH #define LCDD_SCHEMA_COLOR_HH 1
@@ -15,14 +15,25 @@
class color: public SAXObject, public ColorType { public:
+ + /** + * Class constructor. + */
color() { }
+ /** + * Class destructor. + */
virtual ~color() { }
+ /** + * 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 --- comment.hh 10 Jul 2013 18:06:18 -0000 1.4 +++ comment.hh 12 Sep 2013 19:45:10 -0000 1.5 @@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/include/lcdd/schema/comment.hh,v 1.4 2013/07/10 18:06:18 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/include/lcdd/schema/comment.hh,v 1.5 2013/09/12 19:45:10 jeremy Exp $
#ifndef LCDD_SCHEMA_COMMENT_HH #define LCDD_SCHEMA_COMMENT_HH 1
@@ -15,14 +15,25 @@
class comment: public SAXObject, public CommentType { public:
+ + /** + * Class constructor. + */
comment() { }
+ /** + * Class destructor. + */
virtual ~comment() { }
+ /** + * 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 --- detector.hh 10 Jul 2013 18:06:18 -0000 1.4 +++ detector.hh 12 Sep 2013 19:45:10 -0000 1.5 @@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/include/lcdd/schema/detector.hh,v 1.4 2013/07/10 18:06:18 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/include/lcdd/schema/detector.hh,v 1.5 2013/09/12 19:45:10 jeremy Exp $
#ifndef LCDD_SCHEMA_DETECTOR_HH #define LCDD_SCHEMA_DETECTOR_HH 1
@@ -15,14 +15,25 @@
class detector: public SAXObject, public DetectorType { public:
+ + /** + * Class constructor. + */
detector() { }
+ /** + * Class destructor. + */
virtual ~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 --- dipole.hh 10 Jul 2013 18:06:18 -0000 1.4 +++ dipole.hh 12 Sep 2013 19:45:10 -0000 1.5 @@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/include/lcdd/schema/dipole.hh,v 1.4 2013/07/10 18:06:18 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/include/lcdd/schema/dipole.hh,v 1.5 2013/09/12 19:45:10 jeremy Exp $
#ifndef LCDD_SCHEMA_DIPOLE_HH #define LCDD_SCHEMA_DIPOLE_HH
@@ -14,14 +14,25 @@
class dipole: public SAXObject, public DipoleType { public:
+ + /** + * Class constructor. + */
dipole() { }
+ /** + * Class destructor. + */
virtual ~dipole() { }
+ /** + * 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 --- dipole_coeff.hh 10 Jul 2013 18:06:18 -0000 1.4 +++ dipole_coeff.hh 12 Sep 2013 19:45:10 -0000 1.5 @@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/include/lcdd/schema/dipole_coeff.hh,v 1.4 2013/07/10 18:06:18 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/include/lcdd/schema/dipole_coeff.hh,v 1.5 2013/09/12 19:45:10 jeremy Exp $
#ifndef LCDD_SCHEMA_DIPOLE_COEFF_HH #define LCDD_SCHEMA_DIPOLE_COEFF_HH 1
@@ -11,14 +11,25 @@
class dipole_coeff: public SAXObject, public DipoleCoeffType { public:
+ + /** + * Class constructor. + */
dipole_coeff() { }
+ /** + * Class destructor. + */
virtual ~dipole_coeff() { }
+ /** + * 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 --- field.hh 10 Jul 2013 18:06:18 -0000 1.4 +++ field.hh 12 Sep 2013 19:45:10 -0000 1.5 @@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/include/lcdd/schema/field.hh,v 1.4 2013/07/10 18:06:18 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/include/lcdd/schema/field.hh,v 1.5 2013/09/12 19:45:10 jeremy Exp $
#ifndef LCDD_SCHEMA_FIELD_HH #define LCDD_SCHEMA_FIELD_HH 1
@@ -16,14 +16,24 @@
{ public:
+ /** + * Class constructor. + */
field() { }
+ /** + * Class destructor. + */
virtual ~field() { }
+ /** + * 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 --- field_map_3d.hh 10 Jul 2013 18:06:18 -0000 1.4 +++ field_map_3d.hh 12 Sep 2013 19:45:10 -0000 1.5 @@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/include/lcdd/schema/field_map_3d.hh,v 1.4 2013/07/10 18:06:18 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/include/lcdd/schema/field_map_3d.hh,v 1.5 2013/09/12 19:45:10 jeremy Exp $
#ifndef LCDD_SCHEMA_FIELD_MAP_3D_HH #define LCDD_SCHEMA_FIELD_MAP_3D_HH 1
@@ -13,14 +13,24 @@
public:
+ /** + * Class constructor. + */
field_map_3d() { }
+ /** + * Class destructor. + */
virtual ~field_map_3d() { }
+ /** + * 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 --- generator.hh 10 Jul 2013 18:06:18 -0000 1.4 +++ generator.hh 12 Sep 2013 19:45:10 -0000 1.5 @@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/include/lcdd/schema/generator.hh,v 1.4 2013/07/10 18:06:18 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/include/lcdd/schema/generator.hh,v 1.5 2013/09/12 19:45:10 jeremy Exp $
#ifndef LCDD_SCHEMA_GENERATOR_HH #define LCDD_SCHEMA_GENERATOR_HH 1
@@ -15,14 +15,25 @@
class generator: public SAXObject, public GeneratorType { public:
+ + /** + * Class constructor. + */
generator() { }
+ /** + * Class destructor. + */
virtual ~generator() { }
+ /** + * 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 --- global_field.hh 10 Jul 2013 18:06:18 -0000 1.4 +++ global_field.hh 12 Sep 2013 19:45:10 -0000 1.5 @@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/include/lcdd/schema/global_field.hh,v 1.4 2013/07/10 18:06:18 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/include/lcdd/schema/global_field.hh,v 1.5 2013/09/12 19:45:10 jeremy Exp $
#ifndef LCDD_SCHEMA_GLOBAL_FIELD_HH #define LCDD_SCHEMA_GLOBAL_FIELD_HH 1
@@ -15,14 +15,25 @@
class global_field: public SAXObject, public GlobalFieldType { public:
+ + /** + * Class constructor. + */
global_field() { }
+ /** + * Class destructor. + */
virtual ~global_field() { }
+ /** + * 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 --- global_grid_xy.hh 10 Jul 2013 18:06:18 -0000 1.4 +++ global_grid_xy.hh 12 Sep 2013 19:45:10 -0000 1.5 @@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/include/lcdd/schema/global_grid_xy.hh,v 1.4 2013/07/10 18:06:18 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/include/lcdd/schema/global_grid_xy.hh,v 1.5 2013/09/12 19:45:10 jeremy Exp $
#ifndef LCDD_SCHEMA_GLOBAL_GRID_XY_HH #define LCDD_SCHEMA_GLOBAL_GRID_XY_HH 1
@@ -18,16 +18,26 @@
{ public:
+ /** + * Class constructor. + */
global_grid_xy() { }
+ /** + * Class destructor. + */
virtual ~global_grid_xy() { } public:
+ /** + * 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 --- grid_xyz.hh 10 Jul 2013 18:06:18 -0000 1.4 +++ grid_xyz.hh 12 Sep 2013 19:45:10 -0000 1.5 @@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/include/lcdd/schema/grid_xyz.hh,v 1.4 2013/07/10 18:06:18 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/include/lcdd/schema/grid_xyz.hh,v 1.5 2013/09/12 19:45:10 jeremy Exp $
#ifndef LCDD_SCHEMA_GRID_XYZ_HH #define LCDD_SCHEMA_GRID_XYZ_HH 1
@@ -16,14 +16,25 @@
{ public:
+ + /** + * Class constructor. + */
grid_xyz() { }
+ /** + * Class destructor. + */
virtual ~grid_xyz() { }
+ /** + * 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 --- header.hh 10 Jul 2013 18:06:18 -0000 1.4 +++ header.hh 12 Sep 2013 19:45:10 -0000 1.5 @@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/include/lcdd/schema/header.hh,v 1.4 2013/07/10 18:06:18 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/include/lcdd/schema/header.hh,v 1.5 2013/09/12 19:45:10 jeremy Exp $
#ifndef LCDD_SCHEMA_HEADER_HH #define LCDD_SCHEMA_HEADER_HH 1
@@ -15,14 +15,25 @@
class header: public SAXObject, public HeaderType { public:
+ + /** + * Class constructor. + */
header() { }
+ /** + * Class destructor. + */
virtual ~header() { }
+ /** + * Get the type of this SAXObject. + * @return The type of this SAXObject. + */
virtual SAXObject::Type type() { return SAXObject::element;
diff -u -r1.2 -r1.3 --- hit_processor.hh 22 Aug 2013 22:32:16 -0000 1.2 +++ hit_processor.hh 12 Sep 2013 19:45:10 -0000 1.3 @@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/include/lcdd/schema/hit_processor.hh,v 1.2 2013/08/22 22:32:16 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/include/lcdd/schema/hit_processor.hh,v 1.3 2013/09/12 19:45:10 jeremy Exp $
#ifndef LCDD_SCHEMA_HITPROCESSOR_HH #define LCDD_SCHEMA_HITPROCESSOR_HH 1
@@ -14,10 +14,20 @@
public:
+ /** + * Class constructor. + */
hit_processor();
+ /** + * Class destructor. + */
virtual ~hit_processor();
+ /** + * Get the type of this SAXObject. + * @return The type of this SAXObject. + */
virtual SAXObject::Type type(); };
diff -u -r1.2 -r1.3 --- hits_collection.hh 22 Aug 2013 22:32:16 -0000 1.2 +++ hits_collection.hh 12 Sep 2013 19:45:10 -0000 1.3 @@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/include/lcdd/schema/hits_collection.hh,v 1.2 2013/08/22 22:32:16 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/include/lcdd/schema/hits_collection.hh,v 1.3 2013/09/12 19:45:10 jeremy Exp $
#ifndef LCDD_SCHEMA_HITS_COLLECTION_HH #define LCDD_SCHEMA_HITS_COLLECTION_HH 1
@@ -9,15 +9,29 @@
// GDML #include "Saxana/SAXObject.h"
+/** + * @brief + * The hits_collection element from the XML schema. + */
class hits_collection : public SAXObject, public HitsCollectionType { public:
+ /** + * Class constructor. + */
hits_collection();
+ /** + * Class destructor. + */
virtual ~hits_collection();
+ /** + * Get the type of this SAXObject. + * @return The type of this SAXObject. + */
virtual SAXObject::Type type(); };
diff -u -r1.4 -r1.5 --- idfieldElem.hh 10 Jul 2013 18:06:18 -0000 1.4 +++ idfieldElem.hh 12 Sep 2013 19:45:10 -0000 1.5 @@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/include/lcdd/schema/idfieldElem.hh,v 1.4 2013/07/10 18:06:18 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/include/lcdd/schema/idfieldElem.hh,v 1.5 2013/09/12 19:45:10 jeremy Exp $
#ifndef LCDD_SCHEMA_IDFIELDELEM_HH #define LCDD_SCHEMA_IDFIELDELEM_HH 1
@@ -9,19 +9,31 @@
#include "IdFieldType.hh" /**
- * @brief The idfield element from the schema.
+ * @brief + * The idfield element from the schema.
*/ class idfieldElem: public SAXObject, public IdFieldType { public:
+ + /** + * Class constructor. + */
idfieldElem() { }
+ /** + * Class destructor. + */
virtual ~idfieldElem() { }
+ /** + * 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 --- idspecElem.hh 10 Jul 2013 18:06:18 -0000 1.4 +++ idspecElem.hh 12 Sep 2013 19:45:10 -0000 1.5 @@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/include/lcdd/schema/idspecElem.hh,v 1.4 2013/07/10 18:06:18 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/include/lcdd/schema/idspecElem.hh,v 1.5 2013/09/12 19:45:10 jeremy Exp $
#ifndef LCDD_SCHEMA_IDSPECELEM_HH #define LCDD_SCHEMA_IDSPECELEM_HH
@@ -15,14 +15,25 @@
{ public:
+ + /** + * Class constructor. + */
idspecElem() { }
+ /** + * Class destructor. + */
virtual ~idspecElem() { }
+ /** + * Get the type of this SAXObject. + * @return The type of this SAXObject. + */
virtual SAXObject::Type type() { return SAXObject::element;
diff -u -r1.2 -r1.3 --- global_grid_xyProcess.cc 1 Jul 2013 22:10:34 -0000 1.2 +++ global_grid_xyProcess.cc 12 Sep 2013 19:45:11 -0000 1.3 @@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/src/lcdd/processes/global_grid_xyProcess.cc,v 1.2 2013/07/01 22:10:34 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/src/lcdd/processes/global_grid_xyProcess.cc,v 1.3 2013/09/12 19:45:11 jeremy Exp $
// GDML #include "Saxana/ProcessingConfigurator.h"
@@ -45,8 +45,8 @@
np->set_lunit(attrs.getValue("lunit"));
- np->set_gridSizeX(attrs.getValue("grid_size_x")); - np->set_gridSizeY(attrs.getValue("grid_size_y"));
+ np->set_grid_size_x(attrs.getValue("grid_size_x")); + np->set_grid_size_y(attrs.getValue("grid_size_y"));
m_obj = np; *obj = np;
diff -u -r1.1 -r1.2 --- SegmentationFactory.cc 10 Sep 2013 21:57:33 -0000 1.1 +++ SegmentationFactory.cc 12 Sep 2013 19:45:11 -0000 1.2 @@ -1,4 +1,4 @@
-// $Header: /cvs/lcd/lcdd/src/lcdd/segmentation/SegmentationFactory.cc,v 1.1 2013/09/10 21:57:33 jeremy Exp $
+// $Header: /cvs/lcd/lcdd/src/lcdd/segmentation/SegmentationFactory.cc,v 1.2 2013/09/12 19:45:11 jeremy Exp $
// LCDD #include "lcdd/segmentation/SegmentationFactory.hh"
@@ -81,11 +81,11 @@
gsx = gsy = 0.; std::string lunit = gridxy->get_lunit();
- std::string sval = gridxy->get_gridSizeX();
+ std::string sval = gridxy->get_grid_size_x();
sval += "*" + lunit; gsx = calc->Eval(sval);
- sval = gridxy->get_gridSizeY();
+ sval = gridxy->get_grid_size_y();
sval += "*" + lunit; gsy = calc->Eval(sval);
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