rec::robotino::api2 C++ interface
CustomMessage.h
1 //Copyright (c) ...
2 //
3 //REC Robotics Equipment Corporation GmbH, Planegg, Germany. All rights reserved.
4 //Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
5 //1) Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
6 //2) Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
7 //
8 //THIS SOFTWARE IS PROVIDED BY REC ROBOTICS EQUIPMENT CORPORATION GMBH �AS IS� AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
9 //THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL REC ROBOTICS EQUIPMENT CORPORATION GMBH
10 //BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
11 //GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
12 //LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
13 //
14 //Copyright (c) ...
15 //
16 //REC Robotics Equipment Corporation GmbH, Planegg, Germany. Alle Rechte vorbehalten.
17 //Weiterverbreitung und Verwendung in nichtkompilierter oder kompilierter Form, mit oder ohne Ver�nderung, sind unter den folgenden Bedingungen zul�ssig:
18 //1) Weiterverbreitete nichtkompilierte Exemplare m�ssen das obige Copyright, diese Liste der Bedingungen und den folgenden Haftungsausschluss im Quelltext enthalten.
19 //2) Weiterverbreitete kompilierte Exemplare m�ssen das obige Copyright, diese Liste der Bedingungen und den folgenden Haftungsausschluss in der Dokumentation und/oder anderen Materialien, die mit dem Exemplar verbreitet werden, enthalten.
20 //
21 //DIESE SOFTWARE WIRD VON REC ROBOTICS EQUIPMENT CORPORATION GMBH OHNE JEGLICHE SPEZIELLE ODER IMPLIZIERTE GARANTIEN ZUR VERF�GUNG GESTELLT, DIE UNTER
22 //ANDEREM EINSCHLIESSEN: DIE IMPLIZIERTE GARANTIE DER VERWENDBARKEIT DER SOFTWARE F�R EINEN BESTIMMTEN ZWECK. AUF KEINEN FALL IST REC ROBOTICS EQUIPMENT CORPORATION GMBH
23 //F�R IRGENDWELCHE DIREKTEN, INDIREKTEN, ZUF�LLIGEN, SPEZIELLEN, BEISPIELHAFTEN ODER FOLGESCH�DEN (UNTER ANDEREM VERSCHAFFEN VON ERSATZG�TERN ODER -DIENSTLEISTUNGEN;
24 //EINSCHR�NKUNG DER NUTZUNGSF�HIGKEIT; VERLUST VON NUTZUNGSF�HIGKEIT; DATEN; PROFIT ODER GESCH�FTSUNTERBRECHUNG), WIE AUCH IMMER VERURSACHT UND UNTER WELCHER VERPFLICHTUNG
25 //AUCH IMMER, OB IN VERTRAG, STRIKTER VERPFLICHTUNG ODER UNERLAUBTER HANDLUNG (INKLUSIVE FAHRL�SSIGKEIT) VERANTWORTLICH, AUF WELCHEM WEG SIE AUCH IMMER DURCH DIE BENUTZUNG
26 //DIESER SOFTWARE ENTSTANDEN SIND, SOGAR, WENN SIE AUF DIE M�GLICHKEIT EINES SOLCHEN SCHADENS HINGEWIESEN WORDEN SIND.
27 
28 #ifndef _REC_ROBOTINO_API2_CUSTOMMESSAGE_H_
29 #define _REC_ROBOTINO_API2_CUSTOMMESSAGE_H_
30 
31 #include "rec/robotino/api2/defines.h"
32 #include "rec/robotino/api2/ComObject.h"
33 
34 namespace rec
35 {
36  namespace robotino
37  {
38  namespace api2
39  {
40  class CustomMessageImpl;
44  class
45 #ifdef REC_ROBOTINO_API2_CLASS_ATTRIBUTE
46  REC_ROBOTINO_API2_CLASS_ATTRIBUTE
47 #endif
48  CustomMessage : public ComObject
49  {
50  friend class CustomMessageImpl;
51  public:
52  CustomMessage();
53 
54  virtual ~CustomMessage();
55 
63  void setComId( const ComId& id );
64 
71  void processEvents();
72 
80  void setCustomMessage( unsigned int id, const char* const data, unsigned int dataSize );
81 
90  virtual void customMessageEvent( unsigned int id, const char* const data, unsigned int dataSize );
91 
92  private:
93  CustomMessageImpl* _impl;
94  };
95  }
96  }
97 }
98 #endif //_REC_ROBOTINO_API2_CUSTOMMESSAGE_H_
99 
100 
Represents Robotino's custom message communication channel module.
Definition: CustomMessage.h:44
The base class for all Robotino objects.
Definition: ComObject.h:44
Definition: AnalogInput.h:36
The id of a Com object.
Definition: ComId.h:48