te::xsd::Unique Class Reference

It models the unique element in an XML Schema. More...

#include <Unique.h>

Inheritance diagram for te::xsd::Unique:
te::xsd::IdentityConstraint te::xsd::Identifiable te::xsd::Annotated

Public Member Functions

void addField (Field *f)
 Adds a new field to this element. More...
 
IdentityConstraintclone () const
 It clones the object. More...
 
AnnotationgetAnnotation () const
 It returns the associated annotation. More...
 
const boost::ptr_vector< Field > & getFields () const
 It returns the list of Fields elements of this element. More...
 
std::string * getId () const
 It returns a pointer (may be NULL) to the object id. More...
 
std::string * getName () const
 It returns the name of this element. More...
 
SelectorgetSelector () const
 It returns the Selector element of this element. More...
 
Uniqueoperator= (const Unique &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 setName (std::string *name)
 It sets a name for this element. More...
 
void setSelector (Selector *s)
 It sets the Selector element of this element. More...
 
 Unique (std::string *name, Annotation *ann=0, std::string *id=0)
 Constructor. More...
 
 Unique (const Unique &rhs)
 Copy constructor. More...
 
 ~Unique ()
 Destructor. More...
 

Protected Attributes

boost::ptr_vector< Fieldm_fieldVec
 The list of fields. (Required at least one) More...
 
std::string * m_name
 It specifies the name of this element. (Required) More...
 
Selectorm_selector
 It specified the selector element of this. (Required) More...
 

Detailed Description

It models the unique element in an XML Schema.

The unique element defines that an element or an attribute value must be unique within the scope.

Definition at line 43 of file Unique.h.

Constructor & Destructor Documentation

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

Constructor.

Parameters
idIt specifies a unique ID for the element. It may be a NULL value.
nameIt specifies the name of the unique element. It is required a non-NULL value.
Note
The Unique object will take the ownership of the id and name pointers.
te::xsd::Unique::Unique ( const Unique rhs)

Copy constructor.

Parameters
rhsRight-hand-side object.
te::xsd::Unique::~Unique ( )

Destructor.

Member Function Documentation

void te::xsd::IdentityConstraint::addField ( Field f)
inherited

Adds a new field to this element.

Parameters
fThe field that will be added.
Note
The IdentityConstraint object will take the ownership of the given pointer.
IdentityConstraint* te::xsd::Unique::clone ( ) const
virtual

It clones the object.

Returns
A clone of the object. The caller will take the ownership.

Implements te::xsd::IdentityConstraint.

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

It returns the associated annotation.

Returns
The associated annotation.
const boost::ptr_vector<Field>& te::xsd::IdentityConstraint::getFields ( ) const
inherited

It returns the list of Fields elements of this element.

Returns
The list of Fields.
std::string* te::xsd::Identifiable::getId ( ) const
inherited

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

std::string* te::xsd::IdentityConstraint::getName ( ) const
inherited

It returns the name of this element.

Returns
The name of this element.
Selector* te::xsd::IdentityConstraint::getSelector ( ) const
inherited

It returns the Selector element of this element.

Returns
The Selector element.
Unique& te::xsd::Unique::operator= ( const Unique rhs)

Assignment operator.

Parameters
rhsRight-hand-side object.
Returns
A reference to this object.
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.
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.
void te::xsd::IdentityConstraint::setName ( std::string *  name)
inherited

It sets a name for this element.

Parameters
nameA name for this element. Required a non-NULL value.
Note
The IdentityConstraint object will take the ownership of the given pointer.
void te::xsd::IdentityConstraint::setSelector ( Selector s)
inherited

It sets the Selector element of this element.

Parameters
sIt specifies the Selector element.
Note
The IdentityConstraint object will take the ownership of the given pointer.

Member Data Documentation

boost::ptr_vector<Field> te::xsd::IdentityConstraint::m_fieldVec
protectedinherited

The list of fields. (Required at least one)

Definition at line 147 of file IdentityConstraint.h.

std::string* te::xsd::IdentityConstraint::m_name
protectedinherited

It specifies the name of this element. (Required)

Definition at line 145 of file IdentityConstraint.h.

Selector* te::xsd::IdentityConstraint::m_selector
protectedinherited

It specified the selector element of this. (Required)

Definition at line 146 of file IdentityConstraint.h.


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