Xerces-C++ 3.2.5

XSObject.hpp
Go to the documentation of this file.
1/*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache License, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the License for the specific language governing permissions and
15 * limitations under the License.
16 */
17
18/*
19 * $Id$
20 */
21
22#if !defined(XERCESC_INCLUDE_GUARD_XSOBJECT_HPP)
23#define XERCESC_INCLUDE_GUARD_XSOBJECT_HPP
24
25#include <xercesc/util/PlatformUtils.hpp>
26#include <xercesc/framework/psvi/XSConstants.hpp>
27
28 XERCES_CPP_NAMESPACE_BEGIN
29
38// forward declarations
39 class XSNamespaceItem;
40 class XSModel;
41
42 class XMLPARSER_EXPORT XSObject : public XMemory
43{
44 public:
45
46 // Constructors and Destructor
47 // -----------------------------------------------------------------------
50
58 XSObject
59 (
60 XSConstants::COMPONENT_TYPE compType
61 , XSModel* const xsModel
62 , MemoryManager* const manager = XMLPlatformUtils::fgMemoryManager
63 );
64
66
69 virtual ~XSObject();
71
72 //---------------------
76
81 XSConstants::COMPONENT_TYPE getType() const;
82
87 virtual const XMLCh* getName() const;
88
93 virtual const XMLCh* getNamespace() const;
94
100 virtual XSNamespaceItem *getNamespaceItem();
101
108 virtual XMLSize_t getId() const;
109
111
112 //----------------------------------
119 void setId(XMLSize_t id);
121
122 private:
123
124 // -----------------------------------------------------------------------
125 // Unimplemented constructors and operators
126 // -----------------------------------------------------------------------
127 XSObject(const XSObject&);
128 XSObject & operator=(const XSObject &);
129
130 protected:
131
132 // -----------------------------------------------------------------------
133 // data members
134 // -----------------------------------------------------------------------
135 // fMemoryManager:
136 // used for any memory allocations
137 // fComponentType
138 // the type of the actual component
139 XSConstants::COMPONENT_TYPE fComponentType;
140 XSModel* fXSModel;
141 MemoryManager* fMemoryManager;
142 XMLSize_t fId;
143};
144
145 inline XSConstants::COMPONENT_TYPE XSObject::getType() const
146{
147 return fComponentType;
148}
149
150 XERCES_CPP_NAMESPACE_END
151
152#endif
PlatformUtils.hpp
XSConstants.hpp
XMLPARSER_EXPORT
#define XMLPARSER_EXPORT
Definition XercesDefs.hpp:163
XERCES_CPP_NAMESPACE_BEGIN
#define XERCES_CPP_NAMESPACE_BEGIN
Definition XercesDefs.hpp:112
XERCES_CPP_NAMESPACE_END
#define XERCES_CPP_NAMESPACE_END
Definition XercesDefs.hpp:113
XMLCh
uint16_t XMLCh
Definition Xerces_autoconf_config.hpp:120
XMLSize_t
size_t XMLSize_t
Definition Xerces_autoconf_config.hpp:112
MemoryManager
Configurable memory manager.
Definition MemoryManager.hpp:40
XMLPlatformUtils::fgMemoryManager
static MemoryManager * fgMemoryManager
The configurable memory manager.
Definition PlatformUtils.hpp:121
XMemory
This class makes it possible to override the C++ memory management by adding new/delete operators to ...
Definition XMemory.hpp:41
XSConstants::COMPONENT_TYPE
COMPONENT_TYPE
Definition XSConstants.hpp:61
XSModel
Definition XSModel.hpp:60
XSNamespaceItem
Definition XSNamespaceItem.hpp:54
XSObject
Definition XSObject.hpp:43
XSObject::~XSObject
virtual ~XSObject()
XSObject::getType
XSConstants::COMPONENT_TYPE getType() const
The type of this object, i.e.
Definition XSObject.hpp:145
XSObject::XSObject
XSObject(XSConstants::COMPONENT_TYPE compType, XSModel *const xsModel, MemoryManager *const manager=XMLPlatformUtils::fgMemoryManager)
The default constructor.
XSObject::getNamespaceItem
virtual XSNamespaceItem * getNamespaceItem()
A namespace schema information item corresponding to the target namespace of the component,...
XSObject::fXSModel
XSModel * fXSModel
Definition XSObject.hpp:140
XSObject::getId
virtual XMLSize_t getId() const
Optional.
XSObject::fId
XMLSize_t fId
Definition XSObject.hpp:142
XSObject::getName
virtual const XMLCh * getName() const
The name of type NCName of this declaration as defined in XML Namespaces.
XSObject::fMemoryManager
MemoryManager * fMemoryManager
Definition XSObject.hpp:141
XSObject::getNamespace
virtual const XMLCh * getNamespace() const
The [target namespace] of this object, or null if it is unspecified.
XSObject::fComponentType
XSConstants::COMPONENT_TYPE fComponentType
Definition XSObject.hpp:139
XSObject::setId
void setId(XMLSize_t id)
methods needed by implementation