trunk/scripts/EsysException.skl

# *****************************************************************************
# *                                                                           *
# *       COPYRIGHT  ACcESS 2004  -  All Rights Reserved                      *
# *                                                                           *
# * This software is the property of ACcESS. No part of this code             *
# * may be copied in any form or by any means without the expressed written   *
# * consent of ACcESS.  Copying, use or modification of this software         *
# * by any unauthorised person is illegal unless that person has a software   *
# * license agreement with ACcESS.                                            *
# *                                                                           *
# *****************************************************************************
#
#
# Skeleton for EsysException
#
BeginMessage
Processing EsysException generation skeleton
EndMessage

BeginUsage 2
EsysException skeleton expects two arguments <Type> and <Namespace>

   <Type> is the type of the exception
   <Namespace> is the namespace containing the generated exception class

   Generated header file name is based on type name

EndUsage

BeginReplacements
<Type> arg:0
<Namespace> arg:1
<YYYYMMDD> date:yyyymmdd
EndReplacements

BeginMessage
   Type            : <Type>
   Class Namespace : <Namespace>
EndMessage

BeginFileCheck
<Type>.h
EndFileCheck

BeginFile <Type>.h
/* 
 *****************************************************************************
 *                                                                           *
 *       COPYRIGHT  ACcESS  -  All Rights Reserved                           *
 *                                                                           *
 * This software is the property of ACcESS. No part of this code             *
 * may be copied in any form or by any means without the expressed written   *
 * consent of ACcESS.  Copying, use or modification of this software         *
 * by any unauthorised person is illegal unless that person has a software   *
 * license agreement with ACcESS.                                            *
 *                                                                           *
 *****************************************************************************
*/
                                                                           
#if !defined  <Namespace>_<Type>_<YYYYMMDD>_H
#define <Namespace>_<Type>_<YYYYMMDD>_H

#include "esysUtils/EsysException.h"
#include <string>

namespace <Namespace> {

/**
   \brief
   <Type> exception class.

   Description:
   <Type> exception class.
   The class provides a public function returning the exception name
*/
class <Type>:public esysUtils::EsysException {

 public:
  /**
     \brief
     Default constructor for the exception.
  */
  <Type>() : EsysException() {}
  /**
     \brief
     Constructor for the exception.
  */
  <Type>(const char *cstr) : EsysException(cstr) {}
  /**
     \brief
     Constructor for the exception.
  */
  <Type>(const std::string &str) : EsysException(str) {}
  /**
     \brief
     Returns the name of the exception.
  */
  virtual std::string exceptionName() const {return "<Type>";}
};

} // end of namespace
#endif
EndFile

BeginMessage
Completed generating EsysException files
EndMessage


1	jgs	82	# *****************************************************************************
2			# * *
3			# * COPYRIGHT ACcESS 2004 - All Rights Reserved *
4			# * *
5			# * This software is the property of ACcESS. No part of this code *
6			# * may be copied in any form or by any means without the expressed written *
7			# * consent of ACcESS. Copying, use or modification of this software *
8			# * by any unauthorised person is illegal unless that person has a software *
9			# * license agreement with ACcESS. *
10			# * *
11			# *****************************************************************************
12			#
13			#
14			# Skeleton for EsysException
15			#
16			BeginMessage
17			Processing EsysException generation skeleton
18			EndMessage
19
20			BeginUsage 2
21			EsysException skeleton expects two arguments <Type> and <Namespace>
22
23			<Type> is the type of the exception
24			<Namespace> is the namespace containing the generated exception class
25
26			Generated header file name is based on type name
27
28			EndUsage
29
30			BeginReplacements
31			<Type> arg:0
32			<Namespace> arg:1
33			<YYYYMMDD> date:yyyymmdd
34			EndReplacements
35
36			BeginMessage
37			Type : <Type>
38			Class Namespace : <Namespace>
39			EndMessage
40
41			BeginFileCheck
42			<Type>.h
43			EndFileCheck
44
45			BeginFile <Type>.h
46			/*
47			*****************************************************************************
48			* *
49			* COPYRIGHT ACcESS - All Rights Reserved *
50			* *
51			* This software is the property of ACcESS. No part of this code *
52			* may be copied in any form or by any means without the expressed written *
53			* consent of ACcESS. Copying, use or modification of this software *
54			* by any unauthorised person is illegal unless that person has a software *
55			* license agreement with ACcESS. *
56			* *
57			*****************************************************************************
58			*/
59
60			#if !defined <Namespace>_<Type>_<YYYYMMDD>_H
61			#define <Namespace>_<Type>_<YYYYMMDD>_H
62
63			#include "esysUtils/EsysException.h"
64			#include <string>
65
66			namespace <Namespace> {
67
68			/**
69			\brief
70			<Type> exception class.
71
72			Description:
73			<Type> exception class.
74			The class provides a public function returning the exception name
75			*/
76			class <Type>:public esysUtils::EsysException {
77
78			public:
79			/**
80			\brief
81			Default constructor for the exception.
82			*/
83			<Type>() : EsysException() {}
84			/**
85			\brief
86			Constructor for the exception.
87			*/
88			<Type>(const char *cstr) : EsysException(cstr) {}
89			/**
90			\brief
91			Constructor for the exception.
92			*/
93			<Type>(const std::string &str) : EsysException(str) {}
94			/**
95			\brief
96			Returns the name of the exception.
97			*/
98			virtual std::string exceptionName() const {return "<Type>";}
99			};
100
101			} // end of namespace
102			#endif
103			EndFile
104
105			BeginMessage
106			Completed generating EsysException files
107			EndMessage
108
109
110
111
Name	Value
svn:eol-style	native
svn:executable	*
svn:keywords	Author Date Id Revision