OutputConfig.hh
Go to the documentation of this file.
1 /*
2  * Copyright 2022 Open Source Robotics Foundation
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  *
16  */
17 
18 #ifndef SDF_OUTPUT_CONFIG_HH_
19 #define SDF_OUTPUT_CONFIG_HH_
20 
21 #include <gz/utils/ImplPtr.hh>
22 
23 #include "sdf/InterfaceElements.hh"
24 #include "sdf/sdf_config.h"
25 #include "sdf/system_util.hh"
26 
27 
28 namespace sdf
29 {
30 inline namespace SDF_VERSION_NAMESPACE
31 {
32 // Forward declare private data class.
33 class OutputConfigPrivate;
34 
59 {
61  public: OutputConfig();
62 
67  public: static OutputConfig &GlobalConfig();
68 
83  public: void SetToElementUseIncludeTag(bool _useIncludeTag);
84 
89  public: bool ToElementUseIncludeTag() const;
90 
92  GZ_UTILS_IMPL_PTR(dataPtr)
93 };
94 }
95 }
96 
97 #endif
This class contains configuration options for SDF output.
Definition: OutputConfig.hh:59
bool ToElementUseIncludeTag() const
Get the policy value about whether tags are reconstituted in ToElement() invocations.
static OutputConfig & GlobalConfig()
Mutable access to a singleton OutputConfig that serves as the global OutputConfig object for all pars...
void SetToElementUseIncludeTag(bool _useIncludeTag)
Several DOM classes have ToElement() methods that return an XML Element populated from the contents o...
namespace for Simulation Description Format parser
Definition: Actor.hh:35
#define SDFORMAT_VISIBLE
Use to represent "symbol visible" if supported.
Definition: system_util.hh:25