summaryrefslogtreecommitdiffstats
path: root/tags/cpp-1.0-incubating-M2-RC1/sca/runtime/core/src/tuscany/sca/model/Wire.h
blob: 707ac5da0e580e3ab7e26a0a34863efa201b41b3 (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
/*
 * 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_wire_h
#define tuscany_sca_model_wire_h

#include <string>
using std::string;

namespace tuscany
{
    namespace sca
    {
        namespace model
        {
            /**
             * Information about a wire in the model.
             */
            class Wire
            {
            public: 
            
                /**
                 * Constructor.
                 * @param source The source of the wire. Either the component and 
                 * reference name (optional) or an entry point.
                 * @param target The target of the wire. Either a component and service
                 * service name (optional) or an external sevice.
                 */
                SCA_API Wire(const string& source, const string& target);

                /**
                 * Destructor.
                 */
                SCA_API virtual ~Wire();

                /**
                 * Get the component name defined by the source of the wire.
                 * @return The component name which is the source of the wire.
                 */
                SCA_API const string& getSourceComponent() const { return sourceComponent; }

                /**
                 * Get the reference name defined by the source of the wire.
                 * @return The reference name which is the source of the wire.
                 */
                SCA_API const string& getSourceReference() const { return sourceReference; }

                /**
                 * Get the target uri defined by the target of the wire.
                 * @return The target uri which is the source of the wire.
                 */
                SCA_API const string& getTarget() { return target; }
                
             private:
                /**
                 * The source component of the wire.
                 */
                string sourceComponent;

                /**
                 * The source reference of the wire.
                 */
                string sourceReference;

                /**
                 * The target uri of the wire.
                 */
                 string target;
            };
            
        } // End namespace model
    } // End namespace sca
} // End namespace tuscany

#endif // tuscany_sca_model_wire_h