All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
te::xsd::Any Class Reference

It models the XML Schema any element. More...

#include <Any.h>

Inheritance diagram for te::xsd::Any:
te::xsd::Occurs te::xsd::Identifiable te::xsd::Annotated

Public Member Functions

 Any (Annotation *ann=0, std::string *id=0)
 Constructor. More...
 
 Any (const Any &rhs)
 Copy constructor. More...
 
AnnotationgetAnnotation () const
 It returns the associated annotation. 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...
 
std::string * getNamespace () const
 It returns the namespaces containing the elements that can be used. More...
 
ProcessContents getProcessContent () const
 It returns how the XML processor should handle validation against the elements specified by this any element. More...
 
Anyoperator= (const Any &rhs)
 Assignment operator. 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...
 
void setNamespace (std::string *ns)
 It sets the namespaces containing the elements that can be used. More...
 
void setProcessContents (ProcessContents pc)
 It sets how the XML processor should handle validation against the elements specified by this any element. More...
 
 ~Any ()
 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

std::string * m_namespace
 It specifies the namespaces containing the elements that can be used. (Optional) More...
 
ProcessContents m_pContents
 It specifies how the XML processor should handle validation against the elements specified by this any element. (Optional) More...
 

Detailed Description

It models the XML Schema any element.

The any element can be used to extend the XML document with elements not specified by the schema.

Definition at line 49 of file Any.h.

Constructor & Destructor Documentation

te::xsd::Any::Any ( Annotation ann = 0,
std::string *  id = 0 
)

Constructor.

Parameters
annAn annotation.
idIt specifies a unique ID for the element.
Note
The Any object will take the ownership of the annotation and id.

Definition at line 29 of file Any.cpp.

te::xsd::Any::Any ( const Any rhs)

Copy constructor.

Parameters
rhsRight-hand-side object.

Definition at line 37 of file Any.cpp.

References m_namespace, and m_pContents.

te::xsd::Any::~Any ( )

Destructor.

Definition at line 47 of file Any.cpp.

Member Function Documentation

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.

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.

std::string * te::xsd::Any::getNamespace ( ) const

It returns the namespaces containing the elements that can be used.

Returns
The namespaces containing the elements that can be used.

Definition at line 72 of file Any.cpp.

te::xsd::ProcessContents te::xsd::Any::getProcessContent ( ) const

It returns how the XML processor should handle validation against the elements specified by this any element.

Returns
The mode how the XML processor should handle validation: STRICT | LAX | SKIP.

Definition at line 77 of file Any.cpp.

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

Assignment operator.

Parameters
rhsRight-hand-side object.
Returns
A reference to this object.

Definition at line 52 of file Any.cpp.

References m_namespace, m_pContents, te::xsd::Identifiable::operator=(), te::xsd::Annotated::operator=(), and te::xsd::Occurs::operator=().

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

It sets the associated annotation.

Parameters
annThe 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::xsd::serialize::ReadAnnotated().

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

it sets the id.

Parameters
idThe 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::xsd::serialize::ReadIdentifiable().

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

It sets the maxOccurs value.

Parameters
maxOccursThe 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::xsd::serialize::ReadOccurs().

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

It sets the minOccurs value.

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

Definition at line 45 of file Occurs.cpp.

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

void te::xsd::Any::setNamespace ( std::string *  ns)

It sets the namespaces containing the elements that can be used.

Parameters
nsThe namespaces that will be used.
Note
The Any object will take the ownership of the given pointer.

Definition at line 82 of file Any.cpp.

void te::xsd::Any::setProcessContents ( ProcessContents  pc)

It sets how the XML processor should handle validation against the elements specified by this any element.

Parameters
pcIt specifies how the XML processor should handle validation: STRICT | LAX | SKIP.

Definition at line 88 of file Any.cpp.

Member Data Documentation

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=().

std::string* te::xsd::Any::m_namespace
private

It specifies the namespaces containing the elements that can be used. (Optional)

Definition at line 114 of file Any.h.

Referenced by Any(), and operator=().

ProcessContents te::xsd::Any::m_pContents
private

It specifies how the XML processor should handle validation against the elements specified by this any element. (Optional)

Definition at line 115 of file Any.h.

Referenced by Any(), and 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::xsd::serialize::ReadOccurs().


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