EMANE  1.0.1
commeffectevent.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2013-2014 - Adjacent Link LLC, Bridgewater, New Jersey
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * * Redistributions of source code must retain the above copyright
10  * notice, this list of conditions and the following disclaimer.
11  * * Redistributions in binary form must reproduce the above copyright
12  * notice, this list of conditions and the following disclaimer in
13  * the documentation and/or other materials provided with the
14  * distribution.
15  * * Neither the name of Adjacent Link LLC nor the names of its
16  * contributors may be used to endorse or promote products derived
17  * from this software without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
22  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
23  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
24  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
25  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
26  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
27  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
29  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30  * POSSIBILITY OF SUCH DAMAGE.
31  */
32 
33 #ifndef EMANEEVENTSCOMMEFFECTEVENT_HEADER_
34 #define EMANEEVENTSCOMMEFFECTEVENT_HEADER_
35 
36 #include "emane/event.h"
38 #include "emane/events/eventids.h"
39 
40 #include <memory>
41 
42 namespace EMANE
43 {
44  namespace Events
45  {
53  class CommEffectEvent : public Event
54  {
55  public:
63  CommEffectEvent(const Serialization & serialization);
64 
65 
71  CommEffectEvent(const CommEffects & commEffects);
72 
78  CommEffectEvent(const CommEffectEvent & rhs);
79 
86 
93 
100 
105 
111  Serialization serialize() const override;
112 
118  const CommEffects & getCommEffects() const;
119 
121 
122  private:
123  class Implementation;
124  std::unique_ptr<Implementation> pImpl_;
125  };
126  }
127 }
128 
129 #endif // EMANEEVENTSCOMMEFFECTEVENT_HEADER_
std::string Serialization
Definition: serializable.h:42
Event interface is the base for all events.
Definition: event.h:46
Serialization serialize() const override
CommEffectEvent(const Serialization &serialization)
CommEffectEvent & operator=(const CommEffectEvent &rhs)
std::list< CommEffect > CommEffects
Definition: commeffect.h:131
Comm Effect events are used to set asynchronous link characteristics from one or more transmitting NE...
const CommEffects & getCommEffects() const
#define EMANE_EVENT_COMMEFFECT
Definition: eventids.h:42
Definition: agent.h:43