Skip to content

Commit

Permalink
refs #7200 Doxygen comments and minor modifications
Browse files Browse the repository at this point in the history
  • Loading branch information
abuts committed May 30, 2013
1 parent c73c744 commit cab2a97
Show file tree
Hide file tree
Showing 3 changed files with 86 additions and 33 deletions.
37 changes: 34 additions & 3 deletions Code/Mantid/Framework/MDEvents/inc/MantidMDEvents/MDEventFactory.h
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ namespace Mantid
/** definition which states how many dimensions to generate.
*IF THIS NUMBER CHANGES, ONE HAS TO RUN generate_mdevent_declarations.py located with MDEventFactory.cpp file TO REINSTANTIATE AUTOGENERATED CODE
*/
enum {MAX_MD_DIMENSIONS_NUM = 8};
enum {MAX_MD_DIMENSIONS_NUM = 9};
public:
/** enum defines fifferent box types generated by createBox factory
* We will use typecast from integer to these types so it is important to define consisten numbers to these types */
Expand Down Expand Up @@ -95,7 +95,7 @@ namespace Mantid

//### BEGIN AUTO-GENERATED CODE #################################################################
/* Code below Auto-generated by 'generate_mdevent_declarations.py'
* on 2013-05-30 11:26:55.705000
* on 2013-05-30 11:56:13.355000
*
* DO NOT EDIT!
*/
Expand Down Expand Up @@ -126,6 +126,8 @@ namespace Mantid
if (MDEW_MDEVENT_7) funcname<MDEvent<7>, 7>(MDEW_MDEVENT_7); \
MDEventWorkspace<MDEvent<8>, 8>::sptr MDEW_MDEVENT_8 = boost::dynamic_pointer_cast<MDEventWorkspace<MDEvent<8>, 8> >(workspace); \
if (MDEW_MDEVENT_8) funcname<MDEvent<8>, 8>(MDEW_MDEVENT_8); \
MDEventWorkspace<MDEvent<9>, 9>::sptr MDEW_MDEVENT_9 = boost::dynamic_pointer_cast<MDEventWorkspace<MDEvent<9>, 9> >(workspace); \
if (MDEW_MDEVENT_9) funcname<MDEvent<9>, 9>(MDEW_MDEVENT_9); \
MDEventWorkspace<MDLeanEvent<1>, 1>::sptr MDEW_MDLEANEVENT_1 = boost::dynamic_pointer_cast<MDEventWorkspace<MDLeanEvent<1>, 1> >(workspace); \
if (MDEW_MDLEANEVENT_1) funcname<MDLeanEvent<1>, 1>(MDEW_MDLEANEVENT_1); \
MDEventWorkspace<MDLeanEvent<2>, 2>::sptr MDEW_MDLEANEVENT_2 = boost::dynamic_pointer_cast<MDEventWorkspace<MDLeanEvent<2>, 2> >(workspace); \
Expand All @@ -142,6 +144,8 @@ namespace Mantid
if (MDEW_MDLEANEVENT_7) funcname<MDLeanEvent<7>, 7>(MDEW_MDLEANEVENT_7); \
MDEventWorkspace<MDLeanEvent<8>, 8>::sptr MDEW_MDLEANEVENT_8 = boost::dynamic_pointer_cast<MDEventWorkspace<MDLeanEvent<8>, 8> >(workspace); \
if (MDEW_MDLEANEVENT_8) funcname<MDLeanEvent<8>, 8>(MDEW_MDLEANEVENT_8); \
MDEventWorkspace<MDLeanEvent<9>, 9>::sptr MDEW_MDLEANEVENT_9 = boost::dynamic_pointer_cast<MDEventWorkspace<MDLeanEvent<9>, 9> >(workspace); \
if (MDEW_MDLEANEVENT_9) funcname<MDLeanEvent<9>, 9>(MDEW_MDLEANEVENT_9); \
}


Expand All @@ -168,6 +172,8 @@ namespace Mantid
if (MDEW_MDEVENT_7) funcname<MDEvent<7>, 7>(MDEW_MDEVENT_7); \
MDEventWorkspace<MDEvent<8>, 8>::sptr MDEW_MDEVENT_8 = boost::dynamic_pointer_cast<MDEventWorkspace<MDEvent<8>, 8> >(workspace); \
if (MDEW_MDEVENT_8) funcname<MDEvent<8>, 8>(MDEW_MDEVENT_8); \
MDEventWorkspace<MDEvent<9>, 9>::sptr MDEW_MDEVENT_9 = boost::dynamic_pointer_cast<MDEventWorkspace<MDEvent<9>, 9> >(workspace); \
if (MDEW_MDEVENT_9) funcname<MDEvent<9>, 9>(MDEW_MDEVENT_9); \
MDEventWorkspace<MDLeanEvent<3>, 3>::sptr MDEW_MDLEANEVENT_3 = boost::dynamic_pointer_cast<MDEventWorkspace<MDLeanEvent<3>, 3> >(workspace); \
if (MDEW_MDLEANEVENT_3) funcname<MDLeanEvent<3>, 3>(MDEW_MDLEANEVENT_3); \
MDEventWorkspace<MDLeanEvent<4>, 4>::sptr MDEW_MDLEANEVENT_4 = boost::dynamic_pointer_cast<MDEventWorkspace<MDLeanEvent<4>, 4> >(workspace); \
Expand All @@ -180,6 +186,8 @@ namespace Mantid
if (MDEW_MDLEANEVENT_7) funcname<MDLeanEvent<7>, 7>(MDEW_MDLEANEVENT_7); \
MDEventWorkspace<MDLeanEvent<8>, 8>::sptr MDEW_MDLEANEVENT_8 = boost::dynamic_pointer_cast<MDEventWorkspace<MDLeanEvent<8>, 8> >(workspace); \
if (MDEW_MDLEANEVENT_8) funcname<MDLeanEvent<8>, 8>(MDEW_MDLEANEVENT_8); \
MDEventWorkspace<MDLeanEvent<9>, 9>::sptr MDEW_MDLEANEVENT_9 = boost::dynamic_pointer_cast<MDEventWorkspace<MDLeanEvent<9>, 9> >(workspace); \
if (MDEW_MDLEANEVENT_9) funcname<MDLeanEvent<9>, 9>(MDEW_MDLEANEVENT_9); \
}


Expand Down Expand Up @@ -210,6 +218,8 @@ namespace Mantid
if (CONST_MDEW_MDEVENT_7) funcname<MDEvent<7>, 7>(CONST_MDEW_MDEVENT_7); \
const MDEventWorkspace<MDEvent<8>, 8>::sptr CONST_MDEW_MDEVENT_8 = boost::dynamic_pointer_cast<const MDEventWorkspace<MDEvent<8>, 8> >(workspace); \
if (CONST_MDEW_MDEVENT_8) funcname<MDEvent<8>, 8>(CONST_MDEW_MDEVENT_8); \
const MDEventWorkspace<MDEvent<9>, 9>::sptr CONST_MDEW_MDEVENT_9 = boost::dynamic_pointer_cast<const MDEventWorkspace<MDEvent<9>, 9> >(workspace); \
if (CONST_MDEW_MDEVENT_9) funcname<MDEvent<9>, 9>(CONST_MDEW_MDEVENT_9); \
const MDEventWorkspace<MDLeanEvent<1>, 1>::sptr CONST_MDEW_MDLEANEVENT_1 = boost::dynamic_pointer_cast<const MDEventWorkspace<MDLeanEvent<1>, 1> >(workspace); \
if (CONST_MDEW_MDLEANEVENT_1) funcname<MDLeanEvent<1>, 1>(CONST_MDEW_MDLEANEVENT_1); \
const MDEventWorkspace<MDLeanEvent<2>, 2>::sptr CONST_MDEW_MDLEANEVENT_2 = boost::dynamic_pointer_cast<const MDEventWorkspace<MDLeanEvent<2>, 2> >(workspace); \
Expand All @@ -226,6 +236,8 @@ namespace Mantid
if (CONST_MDEW_MDLEANEVENT_7) funcname<MDLeanEvent<7>, 7>(CONST_MDEW_MDLEANEVENT_7); \
const MDEventWorkspace<MDLeanEvent<8>, 8>::sptr CONST_MDEW_MDLEANEVENT_8 = boost::dynamic_pointer_cast<const MDEventWorkspace<MDLeanEvent<8>, 8> >(workspace); \
if (CONST_MDEW_MDLEANEVENT_8) funcname<MDLeanEvent<8>, 8>(CONST_MDEW_MDLEANEVENT_8); \
const MDEventWorkspace<MDLeanEvent<9>, 9>::sptr CONST_MDEW_MDLEANEVENT_9 = boost::dynamic_pointer_cast<const MDEventWorkspace<MDLeanEvent<9>, 9> >(workspace); \
if (CONST_MDEW_MDLEANEVENT_9) funcname<MDLeanEvent<9>, 9>(CONST_MDEW_MDLEANEVENT_9); \
}


Expand All @@ -251,6 +263,8 @@ namespace Mantid
typedef MDBox<MDEvent<7>, 7> MDBox7;
/// Typedef for a MDBox with 8 dimensions
typedef MDBox<MDEvent<8>, 8> MDBox8;
/// Typedef for a MDBox with 9 dimensions
typedef MDBox<MDEvent<9>, 9> MDBox9;
/// Typedef for a MDBox with 1 dimension
typedef MDBox<MDLeanEvent<1>, 1> MDBox1Lean;
/// Typedef for a MDBox with 2 dimensions
Expand All @@ -267,6 +281,8 @@ namespace Mantid
typedef MDBox<MDLeanEvent<7>, 7> MDBox7Lean;
/// Typedef for a MDBox with 8 dimensions
typedef MDBox<MDLeanEvent<8>, 8> MDBox8Lean;
/// Typedef for a MDBox with 9 dimensions
typedef MDBox<MDLeanEvent<9>, 9> MDBox9Lean;



Expand All @@ -288,6 +304,8 @@ namespace Mantid
typedef MDBoxBase<MDEvent<7>, 7> MDBoxBase7;
/// Typedef for a MDBoxBase with 8 dimensions
typedef MDBoxBase<MDEvent<8>, 8> MDBoxBase8;
/// Typedef for a MDBoxBase with 9 dimensions
typedef MDBoxBase<MDEvent<9>, 9> MDBoxBase9;
/// Typedef for a MDBoxBase with 1 dimension
typedef MDBoxBase<MDLeanEvent<1>, 1> MDBoxBase1Lean;
/// Typedef for a MDBoxBase with 2 dimensions
Expand All @@ -304,6 +322,8 @@ namespace Mantid
typedef MDBoxBase<MDLeanEvent<7>, 7> MDBoxBase7Lean;
/// Typedef for a MDBoxBase with 8 dimensions
typedef MDBoxBase<MDLeanEvent<8>, 8> MDBoxBase8Lean;
/// Typedef for a MDBoxBase with 9 dimensions
typedef MDBoxBase<MDLeanEvent<9>, 9> MDBoxBase9Lean;



Expand All @@ -325,6 +345,8 @@ namespace Mantid
typedef MDGridBox<MDEvent<7>, 7> MDGridBox7;
/// Typedef for a MDGridBox with 8 dimensions
typedef MDGridBox<MDEvent<8>, 8> MDGridBox8;
/// Typedef for a MDGridBox with 9 dimensions
typedef MDGridBox<MDEvent<9>, 9> MDGridBox9;
/// Typedef for a MDGridBox with 1 dimension
typedef MDGridBox<MDLeanEvent<1>, 1> MDGridBox1Lean;
/// Typedef for a MDGridBox with 2 dimensions
Expand All @@ -341,6 +363,8 @@ namespace Mantid
typedef MDGridBox<MDLeanEvent<7>, 7> MDGridBox7Lean;
/// Typedef for a MDGridBox with 8 dimensions
typedef MDGridBox<MDLeanEvent<8>, 8> MDGridBox8Lean;
/// Typedef for a MDGridBox with 9 dimensions
typedef MDGridBox<MDLeanEvent<9>, 9> MDGridBox9Lean;



Expand All @@ -362,6 +386,8 @@ namespace Mantid
typedef MDEventWorkspace<MDEvent<7>, 7> MDEventWorkspace7;
/// Typedef for a MDEventWorkspace with 8 dimensions
typedef MDEventWorkspace<MDEvent<8>, 8> MDEventWorkspace8;
/// Typedef for a MDEventWorkspace with 9 dimensions
typedef MDEventWorkspace<MDEvent<9>, 9> MDEventWorkspace9;
/// Typedef for a MDEventWorkspace with 1 dimension
typedef MDEventWorkspace<MDLeanEvent<1>, 1> MDEventWorkspace1Lean;
/// Typedef for a MDEventWorkspace with 2 dimensions
Expand All @@ -378,6 +404,8 @@ namespace Mantid
typedef MDEventWorkspace<MDLeanEvent<7>, 7> MDEventWorkspace7Lean;
/// Typedef for a MDEventWorkspace with 8 dimensions
typedef MDEventWorkspace<MDLeanEvent<8>, 8> MDEventWorkspace8Lean;
/// Typedef for a MDEventWorkspace with 9 dimensions
typedef MDEventWorkspace<MDLeanEvent<9>, 9> MDEventWorkspace9Lean;



Expand All @@ -399,6 +427,8 @@ namespace Mantid
typedef MDBin<MDEvent<7>, 7> MDBin7;
/// Typedef for a MDBin with 8 dimensions
typedef MDBin<MDEvent<8>, 8> MDBin8;
/// Typedef for a MDBin with 9 dimensions
typedef MDBin<MDEvent<9>, 9> MDBin9;
/// Typedef for a MDBin with 1 dimension
typedef MDBin<MDLeanEvent<1>, 1> MDBin1Lean;
/// Typedef for a MDBin with 2 dimensions
Expand All @@ -415,6 +445,8 @@ namespace Mantid
typedef MDBin<MDLeanEvent<7>, 7> MDBin7Lean;
/// Typedef for a MDBin with 8 dimensions
typedef MDBin<MDLeanEvent<8>, 8> MDBin8Lean;
/// Typedef for a MDBin with 9 dimensions
typedef MDBin<MDLeanEvent<9>, 9> MDBin9Lean;



Expand All @@ -426,4 +458,3 @@ namespace Mantid
} // namespace MDEvents

#endif /* MANTID_MDEVENTS_MDEVENTFACTORY_H_ */

0 comments on commit cab2a97

Please sign in to comment.