Changeset 913 in Sophya for trunk/SophyaLib/BaseTools


Ignore:
Timestamp:
Apr 13, 2000, 5:58:41 PM (25 years ago)
Author:
ansari
Message:

Documentation + Modifs mineures (namespace, etc..) - Reza 13/4/2000

Location:
trunk/SophyaLib/BaseTools
Files:
7 edited

Legend:

Unmodified
Added
Removed
  • trunk/SophyaLib/BaseTools/dvlist.cc

    r895 r913  
    4343
    4444/*!
     45   \class SOPHYA::MuTyV
     46   \ingroup SysTools
     47   Simple utility class which can be used to hold values of type
     48   string, integer (\b int_8) or float (\b r_8) and providing
     49   easy conversion methods between these types.
     50*/
     51
     52/*!
    4553   \class SOPHYA::DVList
     54   \ingroup SysTools
    4655   This class can be used to construct list of values associated with names.
    4756   Variables names should not contain space characters and is limited to 64
  • trunk/SophyaLib/BaseTools/dvlist.h

    r895 r913  
    2020
    2121// Classe utilitaire pour manipuler des variables typees
     22//! A simple class for holding string, integer and float type values.
    2223class MuTyV {
    2324public:
  • trunk/SophyaLib/BaseTools/machdefs.h

    r849 r913  
    342342/* ********************************************************/
    343343
     344/* ---- Activation des flags de debug/bound checking  ----- */
     345#ifdef SOPHYA_DEBUG
     346#define SO_BOUNDCHECKING
     347#endif
     348
    344349/* Compatibilite, avant de migrer tout le code en "PLANCK" */
    345350
  • trunk/SophyaLib/BaseTools/pexceptions.h

    r895 r913  
    1717  string BuildLongExceptionMessage(const char * s, const char *file, int line);
    1818
    19 //! Base exception class in Sophya.
    20 /*! Ancestor for PError and PException
     19/*! \ingroup SysTools
     20    \brief Base exception class in Sophya
     21
     22    Ancestor for PError and PException
    2123    It has a message, and an id to give more
    2224    information on the exception.
     
    4143//      PException
    4244 
    43 //! A PError is a serious logic error. Usually not caught...
     45/*! \ingroup SysTools
     46    \brief A PError is a serious logic error. Usually not caught... */
    4447  class PError : public PThrowable {
    4548  public:
     
    4750  };
    4851 
    49 //! A PException is not as serious... Can be caught.
     52/*! \ingroup SysTools
     53    \brief A PException is not as serious... Can be caught. */
    5054  class PException : public PThrowable {
    5155  public:
     
    6064//     AssertionFailedError
    6165
    62 //! Memory allocation failure
     66/*! \ingroup SysTools
     67    \brief Memory allocation failure */
    6368  class AllocationError : public PError {
    6469  public:
     
    6671  };
    6772 
    68 //! Null pointer error
     73/*! \ingroup SysTools
     74    \brief Null pointer error */
    6975  class NullPtrError : public PError {
    7076  public:
     
    7379 
    7480 
    75 //! Calling a forbidden method, trying a forbidden operation
     81/*! \ingroup SysTools
     82    \brief Calling a forbidden method, trying a forbidden operation */
    7683  class ForbiddenError : public PError {
    7784  public:
     
    8087
    8188 
    82 //! ASSERT macro failure. The message is the assertion...
     89/*! \ingroup SysTools
     90    \brief ASSERT macro failure. The message is the assertion... */
    8391  class AssertionFailedError : public PError {
    8492  public:
     
    101109  //   CaughtSignalExc
    102110 
    103   //! Generic IO Exception.
     111/*! \ingroup SysTools
     112    \brief Generic IO Exception */
    104113  class IOExc : public PException {
    105114  public:
     
    107116  };
    108117
    109   //! Bad file format.
     118/*! \ingroup SysTools
     119    \brief Bad file format */
    110120  class FileFormatExc : public IOExc {
    111121  public:
     
    113123  };
    114124
    115   //! Size mismatch between objects.
     125/*! \ingroup SysTools
     126    \brief Size mismatch between objects */
    116127  class SzMismatchError : public PException {
    117128  public:
     
    119130  };
    120131 
    121   //! Out of bounds for array, matrix, etc.
     132/*! \ingroup SysTools
     133    \brief Out of bounds for array, matrix, etc */
    122134  class RangeCheckError : public PException {
    123135  public:
     
    125137  };
    126138 
    127   //! Invalid parameter to method/constructor...
     139/*! \ingroup SysTools
     140    \brief Invalid parameter to method/constructor... */
    128141  class ParmError : public PException {
    129142  public:
     
    131144  };
    132145
    133   //! Calling a non available / not implemented method
     146/*! \ingroup SysTools
     147    \brief Calling a non available / not implemented method */
    134148  class NotAvailableOperation : public PException {
    135149  public:
     
    137151  };
    138152
    139   //! Bad data type -> keep ?
     153/*! \ingroup SysTools
     154    \brief Bad data type -> keep ? */
    140155  class TypeMismatchExc : public PException {
    141156  public:
     
    143158  };
    144159
    145   //! Math operation exception
     160/*! \ingroup SysTools
     161    \brief Math operation exception */
    146162  class MathExc : public PException {
    147163  public:
     
    149165  };
    150166 
    151   //! Singular matrix
     167/*! \ingroup SysTools
     168    \brief Singular matrix  */
    152169  class SingMatrixExc : public MathExc {
    153170  public:
     
    155172  };
    156173
    157   //! Duplicate identifier during registration
     174/*! \ingroup SysTools
     175    \brief Duplicate identifier during registration */
    158176  class DuplicateIdExc : public PException {
    159177  public:
     
    161179  };
    162180 
    163   //! Not found identifier
     181/*! \ingroup SysTools
     182    \brief Not found identifier  */
    164183  class NotFoundExc : public PException {
    165184  public:
     
    167186  };
    168187 
    169   //! Generated exception when processing a signal
     188/*! \ingroup SysTools
     189    \brief Generated exception when processing a signal */
    170190  class CaughtSignalExc : public PException {
    171191  public:
  • trunk/SophyaLib/BaseTools/sophyainit.cc

    r802 r913  
    1818// ---  Classe d'initialisation de SOPHYA, (PPersistMgr en particulier)
    1919int SophyaInitiator::FgInit = 0;
     20
     21/*!
     22   \namespace SOPHYA
     23   \brief This is the namespace for the whole Sophya package
     24*/
     25
     26/*!
     27   \defgroup SysTools SysTools module
     28   This module contains classes and functions which define the
     29   general framework for \b Sophya package such as the simple
     30   persistence, serialisation mechanism through \b PPersist,
     31   \b POutPersist, \b PInPersist classes. It contains also
     32   few utility classes such as the \b NDataBlock<T>, (template
     33   numerical arrays with reference counting and sharing)
     34   \b DataCards and \b PDynLinker (Dynamic link handler) classes. 
     35 
     36*/
     37
     38/*!
     39  \class SOPHYA::SophyaInitiator
     40  \ingroup SysTools
     41  Each Sophya module may contain an initialiser class which should
     42  be a sub-class of SophyaInitiator. 
     43*/
    2044
    2145SophyaInitiator::SophyaInitiator()
  • trunk/SophyaLib/BaseTools/sophyainit.h

    r754 r913  
    1212double SophyaVersion(void); /* Version + (Revision/1000) */
    1313
    14 // Classe d''initialisation pour les modules de PEIDA++
     14// Classe d''initialisation pour les modules SOPHYA
    1515
     16//! Initializer class for sophya modules
    1617class SophyaInitiator {
    1718private:
  • trunk/SophyaLib/BaseTools/srandgen.c

    r851 r913  
    3535*/
    3636
     37/*! \defgroup RandGen
     38    Random number generators */
     39
     40/*! \ingroup  SysTools
     41    \fn frand01
     42    Returns a random number (float) with flat distribution between 0 ... 1
     43*/
     44/*! \ingroup  SysTools
     45    \fn drand01
     46    Returns a random number (double) with flat distribution between 0 ... 1
     47*/
     48/*! \ingroup  SysTools
     49    \fn frandpm1()
     50    Returns a random number (float) with flat distribution between -1 ... 1
     51*/
     52/*! \ingroup  SysTools
     53    \fn drandpm1()
     54    Returns a random number (double) with flat distribution between -1 ... 1 
     55*/
     56
    3757/*=========================================================================*/
    3858/*
     
    4363--
    4464*/
     65
     66/*! \ingroup  SysTools
     67    Fast initialisation of the random number generator \c (drand48)
     68    using a \c long type value (cf \c srand48 )
     69*/
    4570void Ini_Ranf_Quick(long seed_val, int lp)
    4671{
     
    5782        48 bits (cf seed48).
    5883--
     84*/
     85/*! \ingroup  SysTools
     86    complete initialisation of the random number generator \c (drand48)
     87    using a \c using 48 bits (cf \c seed48 )
    5988*/
    6089void Ini_Ranf(unsigned short seed_16v[3], int lp)
     
    73102        de 48 bits (cf seed48).
    74103--
     104*/
     105/*! \ingroup  SysTools
     106    Returns the status (48 bits) of the random number generator \c (drand48)
     107    (cf \c seed48 )
    75108*/
    76109void Get_Ranf(unsigned short seed_16v[3], int lp)
     
    102135--
    103136*/
     137/*! \ingroup  SysTools
     138    Automatic initialisation using the present time
     139*/
    104140void Auto_Ini_Ranf(int lp)
    105141{
     
    151187--
    152188*/
     189/*! \ingroup  SysTools
     190    Normal (Gaussian) random number generator (Mean=0., Sigma=1.)
     191*/
    153192float NorRand(void)
    154193{
     
    190229        Generation aleatoire gaussienne de centre "am" et de sigma "s".
    191230--
     231*/
     232/*! \ingroup  SysTools
     233    Normal (Gaussian) random number generator with the specified mean
     234    (\c am ) and sigma (\c s )
    192235*/
    193236double GauRnd(double am, double s)
Note: See TracChangeset for help on using the changeset viewer.