InlineContent.h
Go to the documentation of this file.
1 /* Copyright (C) 2008 National Institute For Space Research (INPE) - Brazil.
2 
3  This file is part of the TerraLib - a Framework for building GIS enabled applications.
4 
5  TerraLib is free software: you can redistribute it and/or modify
6  it under the terms of the GNU Lesser General Public License as published by
7  the Free Software Foundation, either version 3 of the License,
8  or (at your option) any later version.
9 
10  TerraLib is distributed in the hope that it will be useful,
11  but WITHOUT ANY WARRANTY; without even the implied warranty of
12  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13  GNU Lesser General Public License for more details.
14 
15  You should have received a copy of the GNU Lesser General Public License
16  along with TerraLib. See COPYING. If not, write to
17  TerraLib Team at <terralib-team@terralib.org>.
18  */
19 
20 /*!
21  \file terralib/se/InlineContent.h
22 
23  \brief InlineContent is XML or base64 encoded content in some externally-defined format that is included in an SE in-line.
24 */
25 
26 #ifndef __TERRALIB_SE_INTERNAL_INLINECONTENT_H
27 #define __TERRALIB_SE_INTERNAL_INLINECONTENT_H
28 
29 // TerraLib
30 #include "Config.h"
31 
32 // STL
33 #include <string>
34 
35 // Boost
36 #include <boost/noncopyable.hpp>
37 
38 namespace te
39 {
40  namespace se
41  {
42  /*!
43  \class InlineContent
44 
45  \brief InlineContent is XML- or base64-encoded encoded content in some externally-defined format that is included in an SE in-line.
46 
47  \sa Mark, ExternalGraphic
48 
49  \todo Esta classe precisa lidar com dados mixed!
50  */
51  class TESEEXPORT InlineContent : public boost::noncopyable
52  {
53  public:
54 
55  /*!
56  \enum EncodingType
57 
58  \brief The format type of encoded data.
59  */
61  {
62  XML, /*!< XML encoded. */
63  BASE64 /*!< Base-64 encoded. */
64  };
65 
66  /** @name Initializer Methods
67  * Methods related to instantiation and destruction.
68  */
69  //@{
70 
71  /*!
72  \brief It initializes a new InlineContent.
73 
74  \param e Encoding type.
75  */
76  explicit InlineContent(const EncodingType& e);
77 
78  /*! \brief Destructor. */
79  ~InlineContent();
80 
81  //@}
82 
83  /** @name Accessor methods
84  * Methods used to get or set properties.
85  */
86  //@{
87 
88  void setData(const std::string& d);
89 
90  const std::string& getData() const;
91 
92  void setEncoding(EncodingType e);
93 
94  EncodingType getEncoding() const;
95 
96  //@}
97 
98  /*! \brief It creates a new copy of this object. */
99  InlineContent* clone() const;
100 
101  private:
102 
103  std::string m_data; //!< The inlined data. (Optional)
104  EncodingType m_encoding; //!< The possible values are: xml or base64. (Mandatory)
105  };
106 
107  } // end namespace se
108 } // end namespace te
109 
110 #endif // __TERRALIB_SE_INTERNAL_INLINECONTENT_H
111 
InlineContent is XML- or base64-encoded encoded content in some externally-defined format that is inc...
Definition: InlineContent.h:51
EncodingType
Supported character encodings.
Definition: CharEncoding.h:50
URI C++ Library.
EncodingType m_encoding
The possible values are: xml or base64. (Mandatory)
#define TESEEXPORT
You can use this macro in order to export/import classes and functions from this module.
Definition: Config.h:187
Configuration flags for the Symbology Encoding support of TerraLib.
std::string m_data
The inlined data. (Optional)
EncodingType
The format type of encoded data.
Definition: InlineContent.h:60