The ModelGroup covers four XML Schema model groups: xs:sequence, xs:choice, xs:all, and xs:group. A ModelGroup may contain any number of XMLSchemaParticles, interchanging between XMLElements and XMLModelGroups, BUT there are some fairly heavy restrictions on the xs:all model group, marginally enforced by this class and by XMLSchemaComplexType. This class is not exactly a top-level element, in that only xs:group is allowed to appear at the top level, but it is definitely worthwhile for this class to implement the write_definition funciton. More...

#include <XMLSchemaGeneration.hh>

Inheritance diagram for utility::tag::XMLSchemaModelGroup:

[legend]

Public Member Functions
	XMLSchemaModelGroup ()

	~XMLSchemaModelGroup () override

	XMLSchemaModelGroup (XMLSchemaModelGroupType type)

	XMLSchemaModelGroup (XMLSchemaModelGroupType type, std::list< XMLSchemaParticleCOP > const &particles)

	XMLSchemaModelGroup (std::string const &group_name)

XMLSchemaModelGroup &	type (XMLSchemaModelGroupType type)

XMLSchemaModelGroup &	append_particle (XMLSchemaParticleCOP particle)

XMLSchemaModelGroup &	append_particles (std::list< XMLSchemaParticleCOP > const &particles)

XMLSchemaModelGroup &	group_name (std::string const &name)

std::string const &	element_name () const override

void	write_definition (int indentation, std::ostream &os) const override

void	prepare_for_output (XMLSchemaDefinition &xsd) const override

Public Member Functions inherited from utility::tag::XMLSchemaParticle
	XMLSchemaParticle ()

	~XMLSchemaParticle () override

XMLSchemaParticle &	min_occurs (int setting)

XMLSchemaParticle &	max_occurs (int setting)

int	min_occurs () const

int	max_occurs () const

Public Member Functions inherited from utility::VirtualBase
	VirtualBase ()=default
	Default constructor. More...

virtual	~VirtualBase ()=default
	The virtual destructor is one of the main reasons for the VirtualBase class. More...

	VirtualBase (VirtualBase const &)=default

	VirtualBase (VirtualBase &&)=default

VirtualBase &	operator= (VirtualBase const &)=default

VirtualBase &	operator= (VirtualBase &&)=default

Private Member Functions
void	validate_content () const

bool	is_group_holding_all () const

Private Attributes
XMLSchemaModelGroupType	type_

std::list< XMLSchemaParticleCOP >	particles_

std::string	group_name_

Detailed Description

The ModelGroup covers four XML Schema model groups: xs:sequence, xs:choice, xs:all, and xs:group. A ModelGroup may contain any number of XMLSchemaParticles, interchanging between XMLElements and XMLModelGroups, BUT there are some fairly heavy restrictions on the xs:all model group, marginally enforced by this class and by XMLSchemaComplexType. This class is not exactly a top-level element, in that only xs:group is allowed to appear at the top level, but it is definitely worthwhile for this class to implement the write_definition funciton.

Constructor & Destructor Documentation

utility::tag::XMLSchemaModelGroup::XMLSchemaModelGroup ( )

utility::tag::XMLSchemaModelGroup::~XMLSchemaModelGroup ( )

overridedefault

utility::tag::XMLSchemaModelGroup::XMLSchemaModelGroup ( XMLSchemaModelGroupType type )

utility::tag::XMLSchemaModelGroup::XMLSchemaModelGroup	(	XMLSchemaModelGroupType	type,
		std::list< XMLSchemaParticleCOP > const &	particles
	)

References validate_content().

utility::tag::XMLSchemaModelGroup::XMLSchemaModelGroup ( std::string const & group_name )

Member Function Documentation

XMLSchemaModelGroup & utility::tag::XMLSchemaModelGroup::append_particle ( XMLSchemaParticleCOP particle )

References particles_, and validate_content().

Referenced by utility::tag::define_xml_schema_group().

XMLSchemaModelGroup & utility::tag::XMLSchemaModelGroup::append_particles ( std::list< XMLSchemaParticleCOP > const & particles )

References particles_, and validate_content().

std::string const & utility::tag::XMLSchemaModelGroup::element_name ( ) const

overridevirtual

Implements utility::tag::XMLSchemaTopLevelElement.

References group_name_.

XMLSchemaModelGroup & utility::tag::XMLSchemaModelGroup::group_name ( std::string const & name )

References group_name_, name, type_, and utility::tag::xsmgt_group.

Referenced by utility::tag::define_xml_schema_group().

bool utility::tag::XMLSchemaModelGroup::is_group_holding_all ( ) const

private

References utility::pointer::dynamic_pointer_cast(), particles_, type_, utility::tag::xsmgt_all, and utility::tag::xsmgt_group.

Referenced by write_definition().

void utility::tag::XMLSchemaModelGroup::prepare_for_output ( XMLSchemaDefinition & xsd ) const

overridevirtual

Implements utility::tag::XMLSchemaTopLevelElement.

References particles_.

XMLSchemaModelGroup & utility::tag::XMLSchemaModelGroup::type ( XMLSchemaModelGroupType type )

References type_, and validate_content().

void utility::tag::XMLSchemaModelGroup::validate_content ( ) const

private

References CREATE_EXCEPTION, utility::pointer::dynamic_pointer_cast(), particles_, type_, utility::tag::xsmgt_all, and utility::tag::xsmgt_group.

Referenced by append_particle(), append_particles(), type(), and XMLSchemaModelGroup().

void utility::tag::XMLSchemaModelGroup::write_definition	(	int	indentation,
		std::ostream &	os
	)		const

overridevirtual

Implements utility::tag::XMLSchemaTopLevelElement.

References group_name_, utility::tag::indent_w_spaces(), is_group_holding_all(), utility::tag::XMLSchemaParticle::max_occurs(), utility::tag::XMLSchemaParticle::min_occurs(), particles_, type_, utility::tag::write_min_occurs_max_occurs_if_necessary(), utility::tag::xsmgt_all, utility::tag::xsmgt_choice, utility::tag::xsmgt_group, and utility::tag::xsmgt_sequence.

Member Data Documentation

std::string utility::tag::XMLSchemaModelGroup::group_name_

private

Referenced by element_name(), group_name(), and write_definition().

std::list< XMLSchemaParticleCOP > utility::tag::XMLSchemaModelGroup::particles_

private

Referenced by append_particle(), append_particles(), is_group_holding_all(), prepare_for_output(), validate_content(), and write_definition().

XMLSchemaModelGroupType utility::tag::XMLSchemaModelGroup::type_

private

Referenced by group_name(), is_group_holding_all(), type(), validate_content(), and write_definition().

The documentation for this class was generated from the following files:

src/utility/tag/XMLSchemaGeneration.hh
src/utility/tag/XMLSchemaGeneration.cc

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation