summaryrefslogtreecommitdiffstats
path: root/tags/native-sca-1.0.incubating-M3-RC4/runtime/extensions/cpp/src/tuscany/sca/cpp/model/CPPImplementation.h
blob: 11f487361dd903ac6f1c4607b0bd5581bbbeb364 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 * 
 *   http://www.apache.org/licenses/LICENSE-2.0
 *   
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

/* $Rev$ $Date$ */

#ifndef tuscany_sca_cpp_model_cppimplementation_h
#define tuscany_sca_cpp_model_cppimplementation_h

#include <map>
#include <string>

#include "tuscany/sca/model/ComponentType.h"

namespace tuscany
{
    namespace sca
    {
        namespace cpp
        {
            /**
             * Holds information about an SCA implementation written in C++
             */
            class CPPImplementation : public tuscany::sca::model::ComponentType
            {
                
            public:
                /**
                 * Scope of the component implementation.
                 */
                enum Scope
                {
                    COMPOSITE,
                    STATELESS
                };

                /**
                 * Constructor.
                 * @param dllName Name of the shared library.
                 * @param header Name of the header file that contains the class declaring the 
                 * implementation class.
                 * @param className Name of the class in the header file (could be a blank string
                 * if this is not specified).
                 */
                CPPImplementation(tuscany::sca::model::Composite* composite,
                    const std::string& library, const std::string& header, const std::string&headerPath,
                    const std::string& headerStub, const std::string& className, Scope scope);
                
                /**
                 * Destructor
                 */
                virtual ~CPPImplementation();

                /**
                 * Initialize a component of this type.
                 * @param component The component to initialize.
                 */
                virtual void initializeComponent(tuscany::sca::model::Component* component);

                /**
                 * Returns the name of the shared library.
                 * @return The name of the shared library.
                 */
                const std::string& getLibrary() const { return library; }

                /**
                 * Get the name of the header file.
                 * @return Name of the header file.
                 */
                const std::string& getHeader() const { return header; }

                /**
                 * Get the header file name without the extension.
                 * @return The name of the header file without any extension.
                 */
                const std::string& getHeaderStub() const { return headerStub; }

                /**
                 * Get the header path.
                 * @return The pathe element of the header.
                 */
                const std::string& getHeaderPath() const { return headerPath; }

                /**
                 * Get the name of the class.
                 * @return The class name if specified.
                 */
                const std::string& getClass() const { return className; }
                
                /**
                 * Returns the implementation scope
                 */
                 Scope getScope() { return scope; }
                
            private:
                
                /**
                 * Name of the shared library.
                 */
                std::string library;

                /**
                 * Name of the header file describing the interface.
                 */
                std::string header;

                /**
                 * Name of the header file without the extension.
                 */
                std::string headerStub;

                /**
                 * Path element of the header.
                 */
                std::string headerPath;

                /**
                 * Name of the class in the header file declaring the implementation.
                 * May be an empty string if not set in the SCDL file.
                 */
                std::string className;
                
                /**
                 * Scope of the implementation
                 */
                Scope scope;
            };
            
        } // End namespace cpp
    } // End namespace sca
} // End namespace tuscany

#endif // tuscany_sca_cpp_model_cppimplementation_h