esys2/scripts/Class.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 Class files
#
BeginMessage
Processing Class file generation skeleton
EndMessage

BeginUsage 2
Class skeleton expects two arguments <Classname> and <Namespace>

   <Classname> is the name of the class being generated
   <Namespace> is the namespace containing the generated class

EndUsage

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

BeginMessage
   Classname       : <Classname>
   Class Namespace : <Namespace>
EndMessage

BeginFileCheck
<Classname>.h
<Classname>.cpp
EndFileCheck

BeginFile <Classname>.h
/* 
 ******************************************************************************
 *                                                                            *
 *       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.                                             *
 *                                                                            *
 ******************************************************************************
*/
                                                                           
#if !defined  <Namespace>_<Classname>_<YYYYMMDD>_H
#define <Namespace>_<Classname>_<YYYYMMDD>_H

namespace <Namespace> {

/**
   \brief
   Give a short description of what <Classname> does.

   Description:
   Give a detailed description of <Classname>

   Template Parameters:
   For templates describe any conditions that the parameters used in the
   template must satisfy
*/
class <Classname> {

 public:

  /**
     \brief
     Default constructor for <Classname>

     Description:
     Default constructor for <Classname>

     Preconditions:
     Describe any preconditions

     Throws:
     Describe any exceptions thrown
  */
  <Classname>();

 protected:

 private:
};

} // end of namespace
#endif
EndFile

BeginFile <Classname>.cpp
/*
 ******************************************************************************
 *                                                                            *
 *       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.                                             *
 *                                                                            *
 ******************************************************************************
*/

#include "<Namespace>/<Classname>.h" 

namespace <Namespace> {

<Classname>::<Classname>() {
}

}  // end of namespace
EndFile

BeginMessage
Completed generating Class 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			# Skeleton for Class files
14			#
15			BeginMessage
16			Processing Class file generation skeleton
17			EndMessage
18
19			BeginUsage 2
20			Class skeleton expects two arguments <Classname> and <Namespace>
21
22			<Classname> is the name of the class being generated
23			<Namespace> is the namespace containing the generated class
24
25			EndUsage
26
27			BeginReplacements
28			<Classname> arg:0
29			<Namespace> arg:1
30			<YYYYMMDD> date:yyyymmdd
31			EndReplacements
32
33			BeginMessage
34			Classname : <Classname>
35			Class Namespace : <Namespace>
36			EndMessage
37
38			BeginFileCheck
39			<Classname>.h
40			<Classname>.cpp
41			EndFileCheck
42
43			BeginFile <Classname>.h
44			/*
45			******************************************************************************
46			* *
47			* COPYRIGHT ACcESS 2004 - All Rights Reserved *
48			* *
49			* This software is the property of ACcESS. No part of this code *
50			* may be copied in any form or by any means without the expressed written *
51			* consent of ACcESS. Copying, use or modification of this software *
52			* by any unauthorised person is illegal unless that person has a software *
53			* license agreement with ACcESS. *
54			* *
55			******************************************************************************
56			*/
57
58			#if !defined <Namespace>_<Classname>_<YYYYMMDD>_H
59			#define <Namespace>_<Classname>_<YYYYMMDD>_H
60
61			namespace <Namespace> {
62
63			/**
64			\brief
65			Give a short description of what <Classname> does.
66
67			Description:
68			Give a detailed description of <Classname>
69
70			Template Parameters:
71			For templates describe any conditions that the parameters used in the
72			template must satisfy
73			*/
74			class <Classname> {
75
76			public:
77
78			/**
79			\brief
80			Default constructor for <Classname>
81
82			Description:
83			Default constructor for <Classname>
84
85			Preconditions:
86			Describe any preconditions
87
88			Throws:
89			Describe any exceptions thrown
90			*/
91			<Classname>();
92
93			protected:
94
95			private:
96			};
97
98			} // end of namespace
99			#endif
100			EndFile
101
102			BeginFile <Classname>.cpp
103			/*
104			******************************************************************************
105			* *
106			* COPYRIGHT ACcESS 2004 - All Rights Reserved *
107			* *
108			* This software is the property of ACcESS. No part of this code *
109			* may be copied in any form or by any means without the expressed written *
110			* consent of ACcESS. Copying, use or modification of this software *
111			* by any unauthorised person is illegal unless that person has a software *
112			* license agreement with ACcESS. *
113			* *
114			******************************************************************************
115			*/
116
117			#include "<Namespace>/<Classname>.h"
118
119			namespace <Namespace> {
120
121			<Classname>::<Classname>() {
122			}
123
124			} // end of namespace
125			EndFile
126
127			BeginMessage
128			Completed generating Class files
129			EndMessage
130
131
Name	Value
svn:eol-style	native
svn:executable	*
svn:keywords	Author Date Id Revision