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 SoSFString SoSFString.h Inventor/fields/SoSFString.h
35 \brief The SoSFString class is a container for an SbString.
36
37 \ingroup fields
38
39 This field is used where nodes, engines or other field containers
40 needs to store a single string.
41
42 Fields of this type stores their value to file as a the string
43 within quotes.
44
45 \sa SoMFString
46 */
47
48 // *************************************************************************
49
50 #include <Inventor/fields/SoSFString.h>
51
52 #include <Inventor/SoInput.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(SoSFString, SbString, const SbString &);
62
63 // *************************************************************************
64
65 // Override from parent class.
66 void
initClass(void)67 SoSFString::initClass(void)
68 {
69 SO_SFIELD_INTERNAL_INIT_CLASS(SoSFString);
70 }
71
72 // No need to document readValue() and writeValue() here, as the
73 // necessary information is provided by the documentation of the
74 // parent classes.
75 #ifndef DOXYGEN_SKIP_THIS
76
77 SbBool
readValue(SoInput * in)78 SoSFString::readValue(SoInput * in)
79 {
80 return in->read(this->value);
81 }
82
83 void
writeValue(SoOutput * out) const84 SoSFString::writeValue(SoOutput * out) const
85 {
86 sosfstring_write_value(this, out, this->getValue());
87 }
88
89 #endif // DOXYGEN_SKIP_THIS
90
91
92 /*!
93 Set string field value from \a str.
94 */
95 void
setValue(const char * str)96 SoSFString::setValue(const char * str)
97 {
98 this->setValue(SbString(str));
99 }
100
101 // *************************************************************************
102
103 #ifdef COIN_TEST_SUITE
104
BOOST_AUTO_TEST_CASE(initialized)105 BOOST_AUTO_TEST_CASE(initialized)
106 {
107 SoSFString field;
108 BOOST_CHECK_MESSAGE(SoSFString::getClassTypeId() != SoType::badType(),
109 "SoSFString class not initialized");
110 BOOST_CHECK_MESSAGE(field.getTypeId() != SoType::badType(),
111 "missing class initialization");
112 }
113
114 #endif // COIN_TEST_SUITE
115