Monarch  v3.8.2
Project 8 Data File Format Library
Macros
M3MemberVariable.hh File Reference
#include "_camel_case_member_variables.hh"
Include dependency graph for M3MemberVariable.hh:

Go to the source code of this file.

Macros

#define M3MEMBERVARIABLE   camel_case_mv_accessible_mutable
 
#define M3MEMBERVARIABLE_NOSET   camel_case_mv_accessible_mutable_noset
 
#define M3MEMBERVARIABLE_STATIC   camel_case_mv_accessible_static
 
#define M3MEMBERVARIABLE_STATIC_NOSET   camel_case_mv_accessible_static_noset
 
#define M3MEMBERVARIABLE_REF   camel_case_mv_referrable_mutable
 
#define M3MEMBERVARIABLE_REF_CONST   camel_case_mv_referrable_mutable
 
#define M3MEMBERVARIABLE_REF_STATIC   camel_case_mv_referrable_static
 
#define M3MEMBERVARIABLE_REF_STATIC_CONST   camel_case_mv_referrable_static_const
 
#define M3MEMBERVARIABLE_PTR   camel_case_mv_assignable_mutable
 
#define M3MEMBERVARIABLE_PTR_NOSET   camel_case_mv_assignable_mutable_noset
 
#define M3MEMBERVARIABLE_PTR_STATIC   camel_case_mv_assignable_static
 
#define M3MEMBERVARIABLE_PTR_STATIC_NOSET   camel_case_mv_assignable_static_noset
 
#define M3MEMBERVARIABLE_SHARED_PTR   camel_case_mv_shared_ptr_mutable
 
#define M3MEMBERVARIABLE_SHARED_PTR_NOSET   camel_case_mv_shared_ptr_mutable
 
#define M3MEMBERVARIABLE_SHARED_PTR_STATIC   camel_case_mv_shared_ptr_static
 
#define M3MEMBERVARIABLE_SHARED_PTR_STATIC_NOSET   camel_case_mv_shared_ptr_static
 
#define M3MEMBERVARIABLE_ATOMIC   camel_case_mv_atomic_mutable
 
#define M3MEMBERVARIABLE_ATOMIC_NOSET   camel_case_mv_atomic_mutable_noset
 
#define M3MEMBERVARIABLE_ATOMIC_STATIC   camel_case_mv_atomic_static
 
#define M3MEMBERVARIABLE_ATOMIC_STATIC_NOSET   camel_case_mv_atomic_static_noset
 

Macro Definition Documentation

◆ M3MEMBERVARIABLE

#define M3MEMBERVARIABLE   camel_case_mv_accessible_mutable

Macros for class member variables

Special setup for Monarch: all of the variables are mutable so that they can be modified when a file is being read. This follows the Monarch use of "const" for read-only mode.

In all cases remember to initialize the variables!

For "normal" variables Defines accessors [type GetMyVar() const], [void SetMyVar( type )], and member variable [type fMyVar] The Set function is not available if the _NOSET macros are used

  • M3MEMBERVARIABLE
  • M3MEMBERVARIABLE_NOSET
  • M3MEMBERVARIABLE_STATIC
  • M3MEMBERVARIABLE_STATIC_NOSET

For variables accessed by reference Defines accessors [const type& MyVar() const], [type& MyVar()], and member variable [type fMyVar] The non-const function is not available if the _CONST macros are used

  • M3MEMBERVARIABLE_REF
  • M3MEMBERVARIABLE_REF_CONST
  • M3MEMBERVARIABLE_REF_STATIC
  • M3MEMBERVARIABLE_REF_STATIC_CONST

For pointer variables Defines accessors [type* GetMyVar() const], [void SetMyVar( type* )], and member variable [type* fMyVar] The Set function is not available if the _NOSET macros are used

  • M3MEMBERVARIABLE_PTR
  • M3MEMBERVARIABLE_PTR_NOSET
  • M3MEMBERVARIABLE_PTR_STATIC
  • M3MEMBERVARIABLE_PTR_STATIC_NOSET

For shared_ptr's Defines accessors [const std::shared_ptr< type > MyVar() const], [std::shared_ptr< type > MyVar()], and member variable [std::shared_ptr< type > fMyVar] The non-const function is not available if the _CONST macros are used

  • M3MEMBERVARIABLE_SHARED_PTR
  • M3MEMBERVARIABLE_SHARED_PTR_CONST
  • M3MEMBERVARIABLE_SHARED_PTR_STATIC
  • M3MEMBERVARIABLE_SHARED_PTR_STATIC_CONST

For atomic variables Defines accessors [type GetMyVar() const], [void SetMyVar( type )], and member variable [std::atomic< type > fMyVar] The Set function is not available if the _NOSET macros are used

  • M3MEMBERVARIABLE_ATOMIC
  • M3MEMBERVARIABLE_ATOMIC_NOSET
  • M3MEMBERVARIABLE_ATOMIC_STATIC
  • M3MEMBERVARIABLE_ATOMIC_STATIC_NOSET

Definition at line 64 of file M3MemberVariable.hh.

◆ M3MEMBERVARIABLE_ATOMIC

#define M3MEMBERVARIABLE_ATOMIC   camel_case_mv_atomic_mutable

Definition at line 84 of file M3MemberVariable.hh.

◆ M3MEMBERVARIABLE_ATOMIC_NOSET

#define M3MEMBERVARIABLE_ATOMIC_NOSET   camel_case_mv_atomic_mutable_noset

Definition at line 85 of file M3MemberVariable.hh.

◆ M3MEMBERVARIABLE_ATOMIC_STATIC

#define M3MEMBERVARIABLE_ATOMIC_STATIC   camel_case_mv_atomic_static

Definition at line 86 of file M3MemberVariable.hh.

◆ M3MEMBERVARIABLE_ATOMIC_STATIC_NOSET

#define M3MEMBERVARIABLE_ATOMIC_STATIC_NOSET   camel_case_mv_atomic_static_noset

Definition at line 87 of file M3MemberVariable.hh.

◆ M3MEMBERVARIABLE_NOSET

#define M3MEMBERVARIABLE_NOSET   camel_case_mv_accessible_mutable_noset

Definition at line 65 of file M3MemberVariable.hh.

◆ M3MEMBERVARIABLE_PTR

#define M3MEMBERVARIABLE_PTR   camel_case_mv_assignable_mutable

Definition at line 74 of file M3MemberVariable.hh.

◆ M3MEMBERVARIABLE_PTR_NOSET

#define M3MEMBERVARIABLE_PTR_NOSET   camel_case_mv_assignable_mutable_noset

Definition at line 75 of file M3MemberVariable.hh.

◆ M3MEMBERVARIABLE_PTR_STATIC

#define M3MEMBERVARIABLE_PTR_STATIC   camel_case_mv_assignable_static

Definition at line 76 of file M3MemberVariable.hh.

◆ M3MEMBERVARIABLE_PTR_STATIC_NOSET

#define M3MEMBERVARIABLE_PTR_STATIC_NOSET   camel_case_mv_assignable_static_noset

Definition at line 77 of file M3MemberVariable.hh.

◆ M3MEMBERVARIABLE_REF

#define M3MEMBERVARIABLE_REF   camel_case_mv_referrable_mutable

Definition at line 69 of file M3MemberVariable.hh.

◆ M3MEMBERVARIABLE_REF_CONST

#define M3MEMBERVARIABLE_REF_CONST   camel_case_mv_referrable_mutable

Definition at line 70 of file M3MemberVariable.hh.

◆ M3MEMBERVARIABLE_REF_STATIC

#define M3MEMBERVARIABLE_REF_STATIC   camel_case_mv_referrable_static

Definition at line 71 of file M3MemberVariable.hh.

◆ M3MEMBERVARIABLE_REF_STATIC_CONST

#define M3MEMBERVARIABLE_REF_STATIC_CONST   camel_case_mv_referrable_static_const

Definition at line 72 of file M3MemberVariable.hh.

◆ M3MEMBERVARIABLE_SHARED_PTR

#define M3MEMBERVARIABLE_SHARED_PTR   camel_case_mv_shared_ptr_mutable

Definition at line 79 of file M3MemberVariable.hh.

◆ M3MEMBERVARIABLE_SHARED_PTR_NOSET

#define M3MEMBERVARIABLE_SHARED_PTR_NOSET   camel_case_mv_shared_ptr_mutable

Definition at line 80 of file M3MemberVariable.hh.

◆ M3MEMBERVARIABLE_SHARED_PTR_STATIC

#define M3MEMBERVARIABLE_SHARED_PTR_STATIC   camel_case_mv_shared_ptr_static

Definition at line 81 of file M3MemberVariable.hh.

◆ M3MEMBERVARIABLE_SHARED_PTR_STATIC_NOSET

#define M3MEMBERVARIABLE_SHARED_PTR_STATIC_NOSET   camel_case_mv_shared_ptr_static

Definition at line 82 of file M3MemberVariable.hh.

◆ M3MEMBERVARIABLE_STATIC

#define M3MEMBERVARIABLE_STATIC   camel_case_mv_accessible_static

Definition at line 66 of file M3MemberVariable.hh.

◆ M3MEMBERVARIABLE_STATIC_NOSET

#define M3MEMBERVARIABLE_STATIC_NOSET   camel_case_mv_accessible_static_noset

Definition at line 67 of file M3MemberVariable.hh.