C++ SDK Reference  12.5
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
diguyLogChannel.h
Go to the documentation of this file.
1 
2 /*
3  * Copyright (C) 1992-2013 Boston Dynamics
4  * ALL RIGHTS RESERVED.
5  *
6  * These coded instructions, statements, and computer programs
7  * contain unpublished proprietary information of Boston Dynamics
8  * and are protected by Copyright Laws of the United States.
9  * They may not be used, duplicated, or disclosed in any form, in
10  * whole or in part, without the prior written consent from Boston
11  * Dynamics.
12  *
13  * RESTRICTED RIGHTS LEGEND
14  * Use, duplication, or disclosure by the government is subject
15  * to restrictions as set forth in FAR 52.227.19(c)(2) or
16  * subparagraph (c)(1)(ii) of the Rights in Technical Data and
17  * Computer Software clause at DFARS 252.227-7013 and/or in
18  * similar or successor clauses in the FAR, or the DOD or NASA
19  * FAR Supplement, or to subparagraphs (c)(1) and (c)(2) of the
20  * Commercial Computer Software--Restricted Rights at 48 CFR
21  * 52.227-19, as applicable. Unpublished-rights reserved under
22  * the Copyright Laws of the United States.
23  * Contractor/Manufacturer is:
24  * Boston Dynamics/78 Fourth Avenue/Waltham MA 02451.
25  */
26 
27 /*********************************************************************/
33 #ifndef __diguyLogChannel_H
34 #define __diguyLogChannel_H
35 
36 #ifdef SWIG
37 %module diguyLogChannel
38 #else
39 #define CPLUSPLUS_ONLY
40 #endif
41 
42 #ifdef CPLUSPLUS_ONLY
43 class bdiLog;
44 
45 #include <stdio.h> // for NULL definition
46 #include <diguy_constants.h>
47 
48 typedef const char* diguyLogPrefixFunction(void* user_data);
49 
50 #endif
51 
52 
53 #include <declspec_diguy.h>
54 
55 
56 /****************************************************************************/
57 class BDI_DECLSPEC_diguy diguyLogChannel
58 {
59 
60 public:
61 
62  /*l
63  *b Description:
64  **
65  ** Documentation pending.
66  */
67  int print(int notify_level, const char* text);
68 
69  /*l
70  *b Description:
71  **
72  ** Documentation pending.
73  */
74  void set_text_color(float r, float g, float b, float a);
75  void get_text_color(float* r, float* g, float* b, float* a);
76 
77  void set_static_prefix(const char* prefix);
78  const char* get_static_prefix();
79 
80 #ifdef CPLUSPLUS_ONLY
81 
82  void set_prefix_function(diguyLogPrefixFunction* prefix_function,
83  void* prefix_function_user_data);
84  diguyLogPrefixFunction* get_prefix_function();
85  void* get_prefix_function_user_data();
86 
87 #endif
88 
89  int file_enable(int notify_level,
90  const char* filename,
91  int clear_file = 1);
92  int file_disable();
93 
98 #ifdef CPLUSPLUS_ONLY
99 
100  bdiLog* get_scripted_object() {return m_scripted_object;}
101 
102 private:
103 
104  /*l
105  ** A private constructor.
106  */
107  diguyLogChannel(bdiLog* scripted_object);
108 
109  /*l
110  ** A pointer to internal data.
111  */
112  bdiLog* m_scripted_object;
113 
114  friend class bdiLog;
115 
116 #endif
117 
118 };
119 
120 #endif /* __diguyLogChannel_H */
121