summaryrefslogtreecommitdiffstats
path: root/tags/native-sca-1.0.incubating-M3/runtime/core/src/tuscany/sca/model/ReferenceType.h
blob: 87d38ab3303ac51e48bf1e4cb73a83536cd44829 (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
/*
 * 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_model_referencetype_h
#define tuscany_sca_model_referencetype_h

#include <string>

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

namespace tuscany
{
    namespace sca
    {
        namespace model
        {
            class ComponentType;
            class Interface;
            class Binding;
            
            /**
             * Represents an SCA reference. SCA references within an implementation represent
             * links to services that the implementation uses that must be provided by other components
             * in the SCA system.
             */
            class ReferenceType : public Contract
            {
            public:

                /**
                 * Multiplicity (how many wires can be connected to this
                 * reference)
                 */
                enum Multiplicity
                {
                    ZERO_ONE = 1,
                    ONE_ONE = 2,
                    ZERO_MANY = 3,
                    ONE_MANY = 4,
                    UNKNOWN = 0,
                };

                /**
                 * Constructor.
                 * @param name The name of the reference.
                 */
                SCA_API ReferenceType(ComponentType* componentType, const std::string& name,
                    Interface* intface, Interface* callbackInterface, Multiplicity multiplicity);
                    
                /**
                 * Destructor.
                 */;
                SCA_API virtual ~ReferenceType();
                
                /**
                 * Returns the component type on which this reference is defined.
                 * @return The component type on which this reference is defined.
                 */
                SCA_API ComponentType* getComponentType() const { return componentType; }

                /**
                 * Returns the name of the reference.
                 * @return The name of the reference.
                 */
                SCA_API const std::string& getName() const { return name; }

                /**
                 * Returns the multiplicity allowed for wires connected to this reference.
                 * @return The multiplicity allowed for wires connected to this reference
                 */
                SCA_API Multiplicity getMultiplicity() const { return multiplicity; }

                /**
                 * Returns the binding supported by the reference.
                 * @return The binding supported by the reference.
                 */
                SCA_API Binding* getBinding() const;

                /**
                 * Sets the binding supported by the reference.
                 * @param binding The binding supported by the reference.
                 */
                SCA_API void setBinding(Binding* binding);
                
                /**
                 * Get the multiplicity corresponding to the given
                 * string.
                 */
                static Multiplicity getMultiplicityFromString(const std::string& multip);

            private:
            
                /**
                 * The component type on which this reference is defined.
                 */
                 ComponentType *componentType;
            
                /**
                 * The name of the reference type.
                 */
                std::string name;
                
                /**
                 * The multiplicity allowed for wires connected to this reference.
                 */
                Multiplicity multiplicity;

                /**
                 * The binding supported by this reference type.
                 */
                 Binding* binding;

             };
            
        } // End namespace model
    } // End namespace sca
} // End namespace tuscany

#endif // tuscany_sca_model_referencetype_h