1 /**************************************************************************\
2 * Copyright (c) Kongsberg Oil & Gas Technologies AS
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 are
7 * met:
8 *
9 * Redistributions of source code must retain the above copyright notice,
10 * this list of conditions and the following disclaimer.
11 *
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 *
16 * Neither the name of the copyright holder nor the names of its
17 * contributors may be used to endorse or promote products derived from
18 * this software without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
24 * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
25 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
26 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
30 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 \**************************************************************************/
32
33 /*!
34 \class SoSFBool SoSFBool.h Inventor/fields/SoSFBool.h
35 \brief The SoSFBool class is a container for an SbBool value.
36
37 \ingroup fields
38
39 This field is used where nodes, engines or other field containers
40 needs to store a boolean on/off or TRUE/FALSE value, like for
41 instance as the "on" field of the SoPointLight, SoSpotLight and
42 SoDirectionalLight node classes.
43
44 \sa SoMFBool
45 */
46
47 // *************************************************************************
48
49 #include <Inventor/fields/SoSFBool.h>
50
51 #include <Inventor/SoInput.h>
52 #include <Inventor/SoOutput.h>
53 #include <Inventor/errors/SoDebugError.h>
54 #include <Inventor/errors/SoReadError.h>
55
56 #include "fields/SoSubFieldP.h"
57 #include "fields/shared.h"
58
59 // *************************************************************************
60
61 SO_SFIELD_SOURCE(SoSFBool, SbBool, SbBool);
62
63 // *************************************************************************
64
65 // Override from parent.
66 void
initClass(void)67 SoSFBool::initClass(void)
68 {
69 SO_SFIELD_INTERNAL_INIT_CLASS(SoSFBool);
70 }
71
72
73 // No need to document readValue() and writeValue() here, as the
74 // necessary information is provided by the documentation of the
75 // parent classes.
76 #ifndef DOXYGEN_SKIP_THIS
77
78 SbBool
readValue(SoInput * in)79 SoSFBool::readValue(SoInput * in)
80 {
81 SbBool val;
82 if (!sosfbool_read_value(in, val)) return FALSE;
83 this->value = val;
84 return TRUE;
85 }
86
87 void
writeValue(SoOutput * out) const88 SoSFBool::writeValue(SoOutput * out) const
89 {
90 sosfbool_write_value(out, this->getValue());
91 }
92
93 #endif // DOXYGEN_SKIP_THIS
94
95 // *************************************************************************
96
97 #ifdef COIN_TEST_SUITE
98
BOOST_AUTO_TEST_CASE(initialized)99 BOOST_AUTO_TEST_CASE(initialized)
100 {
101 SoSFBool field;
102 BOOST_CHECK_MESSAGE(SoSFBool::getClassTypeId() != SoType::badType(),
103 "SoSFBool class not initialized");
104 BOOST_CHECK_MESSAGE(field.getTypeId() != SoType::badType(),
105 "missing class initialization");
106 }
107
BOOST_AUTO_TEST_CASE(textinput)108 BOOST_AUTO_TEST_CASE(textinput)
109 {
110 SbBool ok;
111 SoSFBool field;
112 ok = field.set("TRUE");
113 BOOST_CHECK_MESSAGE(ok == TRUE, "did not accept 'TRUE'");
114 BOOST_CHECK_EQUAL(field.getValue(), TRUE);
115 ok = field.set("FALSE");
116 BOOST_CHECK_MESSAGE(ok == TRUE, "did not accept 'FALSE'");
117 BOOST_CHECK_EQUAL(field.getValue(), FALSE);
118
119 TestSuite::ResetReadErrorCount();
120 static const char * filters[] = { "Invalid value", NULL };
121 TestSuite::PushMessageSuppressFilters(filters);
122 ok = field.set("MAYBE"); // emits two error messages
123 BOOST_CHECK_MESSAGE(ok == FALSE, "did accept 'MAYBE'");
124 BOOST_CHECK_MESSAGE(TestSuite::GetReadErrorCount() == 1, "did not emit error");
125 TestSuite::PopMessageSuppressFilters();
126 TestSuite::ResetReadErrorCount();
127
128 ok = field.set("0");
129 BOOST_CHECK_MESSAGE(ok == TRUE, "did not accept '0'");
130 BOOST_CHECK_EQUAL(field.getValue(), FALSE);
131 ok = field.set("1");
132 BOOST_CHECK_MESSAGE(ok == TRUE, "did not accept '1'");
133 BOOST_CHECK_EQUAL(field.getValue(), TRUE);
134
135 static const char * filters2[] = { "Illegal value", NULL };
136 TestSuite::PushMessageSuppressFilters(filters2);
137 ok = field.set("2");
138 BOOST_CHECK_MESSAGE(ok == FALSE, "did accept '2'");
139 TestSuite::PopMessageSuppressFilters();
140 TestSuite::ResetReadErrorCount();
141 }
142
143 #endif // COIN_TEST_SUITE
144