Fawkes API Fawkes Development Version
ExitSimulationInterface.h
1
2/***************************************************************************
3 * ExitSimulationInterface.h - Fawkes BlackBoard Interface - ExitSimulationInterface
4 *
5 * Templated created: Thu Oct 12 10:49:19 2006
6 * Copyright 2016 Gesche Gierse
7 *
8 ****************************************************************************/
9
10/* This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version. A runtime exception applies to
14 * this software (see LICENSE.GPL_WRE file mentioned below for details).
15 *
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU Library General Public License for more details.
20 *
21 * Read the full text in the LICENSE.GPL_WRE file in the doc directory.
22 */
23
24#ifndef _INTERFACES_EXITSIMULATIONINTERFACE_H_
25#define _INTERFACES_EXITSIMULATIONINTERFACE_H_
26
27#include <interface/interface.h>
28#include <interface/message.h>
29#include <interface/field_iterator.h>
30
31namespace fawkes {
32
34{
35 /// @cond INTERNALS
36 INTERFACE_MGMT_FRIENDS(ExitSimulationInterface)
37 /// @endcond
38 public:
39 /* constants */
40
41 private:
42 /** Internal data storage, do NOT modify! */
43 typedef struct {
44 int64_t timestamp_sec; /**< Interface Unix timestamp, seconds */
45 int64_t timestamp_usec; /**< Interface Unix timestamp, micro-seconds */
46 bool shutdown_initiated; /**< Whether a shutdown was initiated */
47 } ExitSimulationInterface_data_t;
48
49 ExitSimulationInterface_data_t *data;
50
51 public:
52 /* messages */
54 {
55 private:
56 /** Internal data storage, do NOT modify! */
57 typedef struct {
58 int64_t timestamp_sec; /**< Interface Unix timestamp, seconds */
59 int64_t timestamp_usec; /**< Interface Unix timestamp, micro-seconds */
60 } ExitSimulationMessage_data_t;
61
62 ExitSimulationMessage_data_t *data;
63
64 public:
67
69 /* Methods */
70 virtual Message * clone() const;
71 };
72
73 virtual bool message_valid(const Message *message) const;
74 private:
77
78 public:
79 /* Methods */
80 bool is_shutdown_initiated() const;
81 void set_shutdown_initiated(const bool new_shutdown_initiated);
82 size_t maxlenof_shutdown_initiated() const;
83 virtual Message * create_message(const char *type) const;
84
85 virtual void copy_values(const Interface *other);
86 virtual const char * enum_tostring(const char *enumtype, int val) const;
87
88};
89
90} // end namespace fawkes
91
92#endif
ExitSimulationMessage Fawkes BlackBoard Interface Message.
virtual Message * clone() const
Clone this message.
ExitSimulationInterface Fawkes BlackBoard Interface.
bool is_shutdown_initiated() const
Get shutdown_initiated value.
virtual Message * create_message(const char *type) const
Create message based on type name.
virtual void copy_values(const Interface *other)
Copy values from other interface.
virtual bool message_valid(const Message *message) const
Check if message is valid and can be enqueued.
virtual const char * enum_tostring(const char *enumtype, int val) const
Convert arbitrary enum value to string.
size_t maxlenof_shutdown_initiated() const
Get maximum length of shutdown_initiated value.
void set_shutdown_initiated(const bool new_shutdown_initiated)
Set shutdown_initiated value.
Base class for all Fawkes BlackBoard interfaces.
Definition: interface.h:80
const char * type() const
Get type of interface.
Definition: interface.cpp:652
Base class for all messages passed through interfaces in Fawkes BlackBoard.
Definition: message.h:44
Fawkes library namespace.