This class models a sequence element in a XML Schema. More...

#include <Sequence.h>

Inheritance diagram for te::xsd::Sequence:

Public Member Functions
void	addAny (Any *a)
	It adds an any to this Sequence element. More...

void	addContent (Content *c)
	It adds a Content element to this Sequence element. More...

void	addElement (Element *e)
	It adds an element to this Sequence element. More...

Content *	clone () const

Annotation *	getAnnotation () const
	It returns the associated annotation. More...

const boost::ptr_vector< Any > &	getAnys () const
	It returns the list of any elements of Choice. More...

const boost::ptr_vector < Content > &	getContents () const
	It returns the list of Content elements of Choice. More...

const boost::ptr_vector < Element > &	getElements () const
	It returns the list of elements of All. More...

std::string *	getId () const
	It returns a pointer (may be NULL) to the object id. More...

const unsigned int	getMaxOccurs () const
	It returns the maxOccurs values. More...

const unsigned int	getMinOccurs () const
	It returns the minOccurs values. More...

Sequence &	operator= (const Sequence &rhs)
	Assignment operator. More...

	Sequence (unsigned int minOccurs=1, unsigned int maxOccurs=1, Annotation ann=0, std::string id=0)
	Constructor. More...

	Sequence (const Sequence &rhs)
	Copy constructor. More...

void	setAnnotation (Annotation *ann)
	It sets the associated annotation. More...

void	setId (std::string *id)
	it sets the id. More...

void	setMaxOccurs (unsigned int maxOccurs)
	It sets the maxOccurs value. More...

void	setMinOccurs (unsigned int minOccurs)
	It sets the minOccurs value. More...

	~Sequence ()
	Destructor. More...

Static Public Attributes
static const unsigned int	unbounded = std::numeric_limits<unsigned int>::max()
	Identifer for "unbounded" max values. More...

Protected Attributes
unsigned int	m_maxOccurs
	It specifies the maximum number of times the any element can occur in the parent element. The value can be any number >= 0, or if you want to set no limit on the maximum number, use the value "unbounded". Default value is 1. (Optional) More...

unsigned int	m_minOccurs
	It specifies the minimum number of times the any element can occur in the parent element. The value can be any number >= 0. Default value is 1. (Optional) More...

Private Attributes
boost::ptr_vector< Any >	m_anyVec
	The list of any elements. More...

boost::ptr_vector< Content >	m_contentVec
	The list of Contents elements (group \| choice \| sequence). More...

boost::ptr_vector< Element >	m_elementVec
	The list of elements. More...

Detailed Description

This class models a sequence element in a XML Schema.

The sequence element specifies that the child elements must appear in a sequence. Each child element can occur from 0 to any number of times.

Note: Parent elements: group, choice, sequence, complexType, restriction (both simpleContent and complexContent), extension (both simpleContent and complexContent)

Definition at line 58 of file Sequence.h.

Constructor & Destructor Documentation

te::xsd::Sequence::Sequence	(	unsigned int	minOccurs = `1`,
		unsigned int	maxOccurs = `1`,
		Annotation *	ann = `0`,
		std::string *	id = `0`
	)

Constructor.

Parameters

id	It specifies a unique ID for the element. It can be a NULL value.
minOccurs	The minimum number of times the element can occur.
maxOccurs	The maximum number of times the element can occur.

Definition at line 33 of file Sequence.cpp.

te::xsd::Sequence::Sequence ( const Sequence & rhs )

Copy constructor.

Parameters

rhs	Right-hand-side object.

Definition at line 40 of file Sequence.cpp.

te::xsd::Sequence::~Sequence ( )

Destructor.

Definition at line 47 of file Sequence.cpp.

Member Function Documentation

void te::xsd::Sequence::addAny ( Any * a )

It adds an any to this Sequence element.

Parameters

a	The any that will be added.

Note: The Sequence object will take the ownership of the given pointer.

Definition at line 81 of file Sequence.cpp.

void te::xsd::Sequence::addContent ( Content * c )

It adds a Content element to this Sequence element.

Parameters

c	The appropriate Content element. It can be: group \| choice \| sequence.

Note: The Sequence object will take the ownership of the given pointer.

Definition at line 76 of file Sequence.cpp.

void te::xsd::Sequence::addElement ( Element * e )

It adds an element to this Sequence element.

Parameters

e	The element that will be added.

Note: The Sequence object will take the ownership of the given pointer.

Definition at line 71 of file Sequence.cpp.

te::xsd::Content * te::xsd::Sequence::clone ( ) const

virtual

Implements te::xsd::Content.

Definition at line 86 of file Sequence.cpp.

te::xsd::Annotation * te::xsd::Annotated::getAnnotation ( ) const

inherited

It returns the associated annotation.

Returns: The associated annotation.

Definition at line 30 of file Annotated.cpp.

References te::xsd::Annotated::m_annotation.

const boost::ptr_vector< te::xsd::Any > & te::xsd::Sequence::getAnys ( ) const

It returns the list of any elements of Choice.

Returns: The list of any elements.

Definition at line 66 of file Sequence.cpp.

const boost::ptr_vector< te::xsd::Content > & te::xsd::Sequence::getContents ( ) const

It returns the list of Content elements of Choice.

Returns: The list of Content elements: group | choice | sequence.

Definition at line 61 of file Sequence.cpp.

const boost::ptr_vector< te::xsd::Element > & te::xsd::Sequence::getElements ( ) const

It returns the list of elements of All.

Returns: The list of elements.

Definition at line 56 of file Sequence.cpp.

std::string * te::xsd::Identifiable::getId ( ) const

inherited

It returns a pointer (may be NULL) to the object id.

Definition at line 35 of file Identifiable.cpp.

const unsigned int te::xsd::Occurs::getMaxOccurs ( ) const

inherited

It returns the maxOccurs values.

Returns: The maxOccurs value.

Definition at line 40 of file Occurs.cpp.

const unsigned int te::xsd::Occurs::getMinOccurs ( ) const

inherited

It returns the minOccurs values.

Returns: The minOccurs value.

Definition at line 35 of file Occurs.cpp.

References te::xsd::Occurs::m_minOccurs.

te::xsd::Sequence & te::xsd::Sequence::operator= ( const Sequence & rhs )

Assignment operator.

Parameters

rhs	Right-hand-side object.

Returns: A reference to this object.

Definition at line 51 of file Sequence.cpp.

void te::xsd::Annotated::setAnnotation ( Annotation * ann )

inherited

It sets the associated annotation.

Parameters

ann	The annotation to be associated to the object. The annotated class will take the ownership of the given pointer.

Definition at line 35 of file Annotated.cpp.

Referenced by te::serialize::ReadAnnotated().

void te::xsd::Identifiable::setId ( std::string * id )

inherited

it sets the id.

Parameters

id	The id to be associated to the object. It will take the ownership of the given string.

Definition at line 29 of file Identifiable.cpp.

References te::xsd::Identifiable::m_id.

Referenced by te::serialize::ReadIdentifiable().

void te::xsd::Occurs::setMaxOccurs ( unsigned int maxOccurs )

inherited

It sets the maxOccurs value.

Parameters

maxOccurs The maxOccurs value. The value can be any number >= 0.

Note: If you want to set no limit on the maximum number, use the value "unbounded" defined as te::xsd::Occurs::unbounded.

Definition at line 50 of file Occurs.cpp.

Referenced by te::serialize::ReadOccurs().

void te::xsd::Occurs::setMinOccurs ( unsigned int minOccurs )

inherited

It sets the minOccurs value.

Parameters

minOccurs The minOccurs value. The value can be any number >= 0.

Definition at line 45 of file Occurs.cpp.

Referenced by te::serialize::ReadOccurs().

Member Data Documentation

boost::ptr_vector<Any> te::xsd::Sequence::m_anyVec

private

The list of any elements.

Definition at line 148 of file Sequence.h.

boost::ptr_vector<Content> te::xsd::Sequence::m_contentVec

private

The list of Contents elements (group | choice | sequence).

Definition at line 147 of file Sequence.h.

boost::ptr_vector<Element> te::xsd::Sequence::m_elementVec

private

The list of elements.

Definition at line 146 of file Sequence.h.

unsigned int te::xsd::Occurs::m_maxOccurs

protectedinherited

It specifies the maximum number of times the any element can occur in the parent element. The value can be any number >= 0, or if you want to set no limit on the maximum number, use the value "unbounded". Default value is 1. (Optional)

Definition at line 113 of file Occurs.h.

Referenced by te::xsd::Occurs::operator=().

unsigned int te::xsd::Occurs::m_minOccurs

protectedinherited

It specifies the minimum number of times the any element can occur in the parent element. The value can be any number >= 0. Default value is 1. (Optional)

Definition at line 112 of file Occurs.h.

Referenced by te::xsd::Occurs::getMinOccurs(), and te::xsd::Occurs::operator=().

const unsigned int te::xsd::Occurs::unbounded = std::numeric_limits<unsigned int>::max()

staticinherited

Identifer for "unbounded" max values.

Definition at line 108 of file Occurs.h.

Referenced by te::serialize::ReadOccurs().

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

/home/castejon/castejon_files/develop/terralib5/git/src/terralib/xsd/Sequence.h
/home/castejon/castejon_files/develop/terralib5/git/src/terralib/xsd/Sequence.cpp

Public Member Functions

Static Public Attributes

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation