Xerces-C++: XSModelGroup.hpp Source File

Xerces-C++ 3.3.0

XSModelGroup.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_XSMODELGROUP_HPP)
23#define XERCESC_INCLUDE_GUARD_XSMODELGROUP_HPP
24
25#include <xercesc/framework/psvi/XSObject.hpp>
26
27 XERCES_CPP_NAMESPACE_BEGIN
28
36// forward declarations
37class XSAnnotation;
38class XSParticle;
39
40 class XMLPARSER_EXPORT XSModelGroup : public XSObject
41{
42public:
43
44 // Content model compositors
45 enum COMPOSITOR_TYPE {
49 COMPOSITOR_SEQUENCE = 1,
53 COMPOSITOR_CHOICE = 2,
59 COMPOSITOR_ALL = 3
60 };
61
62 // Constructors and Destructor
63 // -----------------------------------------------------------------------
66
76 XSModelGroup
77 (
78 COMPOSITOR_TYPE compositorType
79 , XSParticleList* const particleList
80 , XSAnnotation* const annot
81 , XSModel* const xsModel
82 , MemoryManager* const manager = XMLPlatformUtils::fgMemoryManager
83 );
84
86
89 ~XSModelGroup();
91
92 //---------------------
95
101 COMPOSITOR_TYPE getCompositor() const;
102
106 XSParticleList *getParticles() const;
107
111 XSAnnotation *getAnnotation() const;
112
114
115 //----------------------------------
119
121private:
122
123 // -----------------------------------------------------------------------
124 // Unimplemented constructors and operators
125 // -----------------------------------------------------------------------
126 XSModelGroup(const XSModelGroup&);
127 XSModelGroup & operator=(const XSModelGroup &);
128
129protected:
130
131 // -----------------------------------------------------------------------
132 // data members
133 // -----------------------------------------------------------------------
134 COMPOSITOR_TYPE fCompositorType;
135 XSParticleList* fParticleList;
136 XSAnnotation* fAnnotation;
137};
138
139 inline XSModelGroup::COMPOSITOR_TYPE XSModelGroup::getCompositor() const
140{
141 return fCompositorType;
142}
143
144 inline XSParticleList* XSModelGroup::getParticles() const
145{
146 return fParticleList;
147}
148
149 inline XSAnnotation* XSModelGroup::getAnnotation() const
150{
151 return fAnnotation;
152}
153
154 XERCES_CPP_NAMESPACE_END
155
156#endif
XSParticleList
RefVectorOf< XSParticle > XSParticleList
Definition XSConstants.hpp:52
XSObject.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
MemoryManager
Configurable memory manager.
Definition MemoryManager.hpp:40
XMLPlatformUtils::fgMemoryManager
static MemoryManager * fgMemoryManager
The configurable memory manager.
Definition PlatformUtils.hpp:121
XSAnnotation
Definition XSAnnotation.hpp:42
XSModelGroup
Definition XSModelGroup.hpp:41
XSModelGroup::getParticles
XSParticleList * getParticles() const
A list of [particles].
Definition XSModelGroup.hpp:144
XSModelGroup::XSModelGroup
XSModelGroup(COMPOSITOR_TYPE compositorType, XSParticleList *const particleList, XSAnnotation *const annot, XSModel *const xsModel, MemoryManager *const manager=XMLPlatformUtils::fgMemoryManager)
The default constructor.
XSModelGroup::fAnnotation
XSAnnotation * fAnnotation
Definition XSModelGroup.hpp:136
XSModelGroup::getAnnotation
XSAnnotation * getAnnotation() const
Optional.
Definition XSModelGroup.hpp:149
XSModelGroup::COMPOSITOR_TYPE
COMPOSITOR_TYPE
Definition XSModelGroup.hpp:45
XSModelGroup::fCompositorType
COMPOSITOR_TYPE fCompositorType
Definition XSModelGroup.hpp:134
XSModelGroup::getCompositor
COMPOSITOR_TYPE getCompositor() const
[compositor]: one of all, choice or sequence.
Definition XSModelGroup.hpp:139
XSModelGroup::fParticleList
XSParticleList * fParticleList
Definition XSModelGroup.hpp:135
XSModelGroup::~XSModelGroup
~XSModelGroup()
XSModel
Definition XSModel.hpp:60
XSObject
Definition XSObject.hpp:43
XSParticle
Definition XSParticle.hpp:42