Fast DDS  Version 3.6.1.0
Fast DDS
VerbatimTextDescriptor.hpp
1 // Copyright 2023 Proyectos y Sistemas de Mantenimiento SL (eProsima).
2 //
3 // Licensed under the Apache License, Version 2.0 (the "License");
4 // you may not use this file except in compliance with the License.
5 // You may obtain a copy of the License at
6 //
7 // http://www.apache.org/licenses/LICENSE-2.0
8 //
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS IS" BASIS,
11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 // See the License for the specific language governing permissions and
13 // limitations under the License.
14 
15 #ifndef FASTDDS_DDS_XTYPES_DYNAMIC_TYPES__VERBATIMTEXTDESCRIPTOR_HPP
16 #define FASTDDS_DDS_XTYPES_DYNAMIC_TYPES__VERBATIMTEXTDESCRIPTOR_HPP
17 
18 #include <string>
19 
20 #include <fastdds/dds/core/ReturnCode.hpp>
21 #include <fastdds/dds/xtypes/dynamic_types/Types.hpp>
22 #include <fastdds/fastdds_dll.hpp>
23 
24 namespace eprosima {
25 namespace fastdds {
26 namespace dds {
27 
28 class FASTDDS_EXPORTED_API VerbatimTextDescriptor
29 {
30 public:
31 
33 
38  virtual std::string& placement() = 0;
39 
44  virtual const std::string& placement() const = 0;
45 
50  virtual void placement(
51  const std::string& placement) = 0;
52 
57  virtual void placement(
58  std::string&& placement) = 0;
59 
64  virtual std::string& text() = 0;
65 
70  virtual const std::string& text() const = 0;
71 
76  virtual void text(
77  const std::string& text) = 0;
78 
83  virtual void text(
84  std::string&& text) = 0;
85 
95 
101  virtual bool equals(
103 
108  virtual bool is_consistent() = 0;
109 
110 protected:
111 
113 
115  const VerbatimTextDescriptor& type) = default;
116 
118  VerbatimTextDescriptor&& type) = default;
119 
120  virtual ~VerbatimTextDescriptor() = default;
121 
122 private:
123 
124  VerbatimTextDescriptor& operator =(
125  const VerbatimTextDescriptor& type) = delete;
126 
127  VerbatimTextDescriptor& operator =(
128  VerbatimTextDescriptor&& type) = delete;
129 };
130 
131 } // namespace dds
132 } // namespace fastdds
133 } // namespace eprosima
134 
135 #endif // FASTDDS_DDS_XTYPES_DYNAMIC_TYPES__VERBATIMTEXTDESCRIPTOR_HPP
Definition: VerbatimTextDescriptor.hpp:29
virtual void placement(const std::string &placement)=0
Sets the location within the generated output at which the output text should be inserted.
virtual bool is_consistent()=0
Indicates whether the states of all of this descriptor's properties are consistent.
virtual void placement(std::string &&placement)=0
Sets the location within the generated output at which the output text should be inserted.
virtual void text(std::string &&text)=0
Sets the literal output text.
virtual const std::string & text() const =0
Returns the literal output text.
virtual const std::string & placement() const =0
Returns the location within the generated output at which the output text should be inserted.
virtual bool equals(traits< VerbatimTextDescriptor >::ref_type descriptor)=0
Compares.
VerbatimTextDescriptor(const VerbatimTextDescriptor &type)=default
virtual std::string & text()=0
Returns the literal output text.
virtual std::string & placement()=0
Returns the location within the generated output at which the output text should be inserted.
VerbatimTextDescriptor(VerbatimTextDescriptor &&type)=default
virtual ReturnCode_t copy_from(traits< VerbatimTextDescriptor >::ref_type descriptor)=0
Overwrites the contents of this descriptor with those of another descriptor.
virtual void text(const std::string &text)=0
Sets the literal output text.
typename traits< VerbatimTextDescriptor >::ref_type _ref_type
Definition: VerbatimTextDescriptor.hpp:32
Definition: DomainParticipant.hpp:46
int32_t ReturnCode_t
Definition: DDSReturnCode.hpp:59
typename ::std::shared_ptr< T > ref_type
Definition: type_traits.hpp:29