ping_message.h
Go to the documentation of this file.
1 /*
2  * Software License Agreement (BSD License)
3  *
4  * Copyright (c) 2011, Southwest Research Institute
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions are met:
9  *
10  * * Redistributions of source code must retain the above copyright
11  * notice, this list of conditions and the following disclaimer.
12  * * Redistributions in binary form must reproduce the above copyright
13  * notice, this list of conditions and the following disclaimer in the
14  * documentation and/or other materials provided with the distribution.
15  * * Neither the name of the Southwest Research Institute, nor the names
16  * of its 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 "AS IS"
20  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
23  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29  * POSSIBILITY OF SUCH DAMAGE.
30  */
31 
32 #ifndef PING_MESSAGE_H
33 #define PING_MESSAGE_H
34 
35 #ifndef FLATHEADERS
38 #else
39 #include "typed_message.h"
40 #include "simple_message.h"
41 #endif
42 
43 
44 namespace industrial
45 {
46 namespace ping_message
47 {
48 
53 //* PingMessage
61 {
62 public:
63 
70  PingMessage(void);
71 
76  ~PingMessage(void);
77 
84 
89  void init();
90 
97  {
98  return false;
99  }
100 
101  // Overrides - SimpleSerialize
102  bool load(industrial::byte_array::ByteArray *buffer){return true;}
103  bool unload(industrial::byte_array::ByteArray *buffer){return true;}
104  unsigned int byteLength(){return 0;}
105 
106 private:
107 
108 
109 };
110 
111 }
112 }
113 
114 #endif /* PING_MESSAGE_H */
industrial
Definition: byte_array.h:45
simple_message.h
industrial::ping_message::PingMessage::byteLength
unsigned int byteLength()
Virtual method returns the object size when packed into a ByteArray.
Definition: ping_message.h:104
industrial::ping_message::PingMessage::PingMessage
PingMessage(void)
Default constructor.
Definition: ping_message.cpp:50
industrial::simple_message::SimpleMessage
This class defines a simple messaging protocol for communicating with an industrial robot controller.
Definition: simple_message.h:164
industrial::byte_array::ByteArray
The byte array wraps a dynamic array of bytes (i.e. char).
Definition: byte_array.h:80
industrial::ping_message::PingMessage::toTopic
bool toTopic(industrial::simple_message::SimpleMessage &msg)
The ping message overrides the base method toTopic to always return false. A ping cannot be sent as a...
Definition: ping_message.h:96
industrial::ping_message::PingMessage::load
bool load(industrial::byte_array::ByteArray *buffer)
Virtual method for loading an object into a ByteArray.
Definition: ping_message.h:102
industrial::ping_message::PingMessage
Class encapsulated ping message generation methods (either to or from a SimpleMessage type.
Definition: ping_message.h:60
industrial::ping_message::PingMessage::init
void init()
Initializes a new ping message.
Definition: ping_message.cpp:80
industrial::typed_message::TypedMessage
Message interface for typed messages built from SimpleMessage.
Definition: typed_message.h:74
typed_message.h
industrial::ping_message::PingMessage::unload
bool unload(industrial::byte_array::ByteArray *buffer)
Virtual method for unloading an object from a ByteArray.
Definition: ping_message.h:103
industrial::ping_message::PingMessage::~PingMessage
~PingMessage(void)
Destructor.
Definition: ping_message.cpp:55


simple_message
Author(s): Shaun Edwards
autogenerated on Wed Mar 2 2022 00:24:53