Class corresponding to the XML Schema IDREF built-in type. More...

#include <types.hxx>

Inheritance diagram for idref< C, B, T >:

Public Types
typedef T	ref_type
	Referenced type.

Constructors
typedef void(idref::*	bool_convertible) ()
	Opaque type that can be evaluated as true or false.

	idref (const C *s)
	Initialize an instance with a copy of a C string.

	idref (const C *s, std::size_t n)
	Initialize an instance with a character array.

	idref (std::size_t n, C c)
	Initialize an instance with multiple copies of the same character.

	idref (const std::basic_string< C > &s)
	Initialize an instance with a copy of a standard string.

	idref (const std::basic_string< C > &s, std::size_t pos, std::size_t n=std::basic_string< C >::npos)
	Initialize an instance with a copy of a substring.

	idref (const idref &x, flags f=0, container *c=0)
	Copy constructor.

virtual idref *	_clone (flags f=0, container *c=0) const
	Copy the instance polymorphically.

template<typename S >
	idref (istream< S > &s, flags f=0, container *c=0)
	Create an instance from a data representation stream.

	idref (const xercesc::DOMElement &e, flags f=0, container *c=0)
	Create an instance from a DOM element.

	idref (const xercesc::DOMAttr &a, flags f=0, container *c=0)
	Create an instance from a DOM Attribute.

	idref (const std::basic_string< C > &s, const xercesc::DOMElement e, flags f=0, container c=0)
	Create an instance from a string fragment.

idref &	operator= (C c)
	Assign a character to the instance.

idref &	operator= (const C *s)
	Assign a C string to the instance.

idref &	operator= (const std::basic_string< C > &s)
	Assign a standard string to the instance.

idref &	operator= (const idref &x)
	Copy assignment operator.

const ref_type *	operator-> () const
	Call referenced object.

ref_type *	operator-> ()
	Call referenced object.

const ref_type &	operator* () const
	Dereference referenced object.

ref_type &	operator* ()
	Dereference referenced object.

const ref_type *	get () const
	Get a constant pointer to the referenced object.

ref_type *	get ()
	Get a pointer to the referenced object.

	operator bool_convertible () const
	Implicit conversion to boolean type.

Detailed Description

template<typename C, typename B, typename T>
class xsd::cxx::tree::idref< C, B, T >

Class corresponding to the XML Schema IDREF built-in type.

The idref class publicly inherits from and has the same set of constructors as std::basic_string. It therefore can be used as std::string (or std::wstring if you are using wchar_t as the character type).

The idref class also provides an autopointer-like interface for resolving referenced objects. By default the object is returned as type (mapping for anyType) but statically-typed idref can be created using the XML Schema extension. See the C++/Tree Mapping User Manual for more information.

Constructor & Destructor Documentation

◆ idref() [1/10]

template<typename C , typename B , typename T >

idref ( const C * s )

inline

Initialize an instance with a copy of a C string.

Parameters

s	A C string to copy.

◆ idref() [2/10]

template<typename C , typename B , typename T >

idref	(	const C *	s,
		std::size_t	n
	)

inline

Initialize an instance with a character array.

Parameters

s	A character array to copy.
n	A number of character to copy.

◆ idref() [3/10]

template<typename C , typename B , typename T >

idref	(	std::size_t	n,
		C	c
	)

inline

Initialize an instance with multiple copies of the same character.

Parameters

n	A number of copies to create.
c	A character to copy.

◆ idref() [4/10]

template<typename C , typename B , typename T >

idref ( const std::basic_string< C > & s )

inline

Initialize an instance with a copy of a standard string.

Parameters

s	A standard string to copy.

◆ idref() [5/10]

template<typename C , typename B , typename T >

idref	(	const std::basic_string< C > &	s,
		std::size_t	pos,
		std::size_t	n = `std::basic_string<C>::npos`
	)

inline

Initialize an instance with a copy of a substring.

Parameters

s	A standard string to copy the substring from.
pos	An index of the first character to copy from.
n	A number of characters to copy.

◆ idref() [6/10]

template<typename C , typename B , typename T >

idref	(	const idref< C, B, T > &	x,
		flags	f = `0`,
		container *	c = `0`
	)

inline

Copy constructor.

Parameters

x	An instance to make a copy of.
f	Flags to create the copy with.
c	A pointer to the object that will contain the copy.

For polymorphic object models use the _clone function instead.

◆ idref() [7/10]

template<typename C , typename B , typename T >

template<typename S >

idref	(	istream< S > &	s,
		flags	f = `0`,
		container *	c = `0`
	)

Create an instance from a data representation stream.

Parameters

s	A stream to extract the data from.
f	Flags to create the new instance with.
c	A pointer to the object that will contain the new instance.

◆ idref() [8/10]

template<typename C , typename B , typename T >

idref	(	const xercesc::DOMElement &	e,
		flags	f = `0`,
		container *	c = `0`
	)

Create an instance from a DOM element.

Parameters

e	A DOM element to extract the data from.
f	Flags to create the new instance with.
c	A pointer to the object that will contain the new instance.

◆ idref() [9/10]

template<typename C , typename B , typename T >

idref	(	const xercesc::DOMAttr &	a,
		flags	f = `0`,
		container *	c = `0`
	)

Create an instance from a DOM Attribute.

Parameters

a	A DOM attribute to extract the data from.
f	Flags to create the new instance with.
c	A pointer to the object that will contain the new instance.

◆ idref() [10/10]

template<typename C , typename B , typename T >

idref	(	const std::basic_string< C > &	s,
		const xercesc::DOMElement *	e,
		flags	f = `0`,
		container *	c = `0`
	)

Create an instance from a string fragment.

Parameters

s	A string fragment to extract the data from.
e	A pointer to DOM element containing the string fragment.
f	Flags to create the new instance with.
c	A pointer to the object that will contain the new instance.

Member Function Documentation

◆ _clone()

template<typename C , typename B , typename T >

virtual idref * _clone	(	flags	f = `0`,
		container *	c = `0`
	)		const

virtual

Copy the instance polymorphically.

Parameters

f	Flags to create the copy with.
c	A pointer to the object that will contain the copy.

Returns: A pointer to the dynamically allocated copy.

This function ensures that the dynamic type of the instance is used for copying and should be used for polymorphic object models instead of the copy constructor.

◆ operator=() [1/4]

template<typename C , typename B , typename T >

idref & operator= ( C c )

inline

Assign a character to the instance.

The resulting idref has only one character.

Parameters

c	A character to assign.

Returns: A reference to the instance.

◆ operator=() [2/4]

template<typename C , typename B , typename T >

idref & operator= ( const C * s )

inline

Assign a C string to the instance.

The resulting idref contains a copy of the C string.

Parameters

s	A C string to assign.

Returns: A reference to the instance.

◆ operator=() [3/4]

template<typename C , typename B , typename T >

idref & operator= ( const std::basic_string< C > & s )

inline

Assign a standard string to the instance.

The resulting idref contains a copy of the standard string.

Parameters

s	A standard string to assign.

Returns: A reference to the instance.

◆ operator=() [4/4]

template<typename C , typename B , typename T >

idref & operator= ( const idref< C, B, T > & x )

inline

Copy assignment operator.

Parameters

x	An instance to assign.

Returns: A reference to the instance.

◆ operator->() [1/2]

template<typename C , typename B , typename T >

const ref_type * operator-> ( ) const

inline

Call referenced object.

Returns: A constant pointer to the referenced object.

References idref< C, B, T >::get().

◆ operator->() [2/2]

template<typename C , typename B , typename T >

ref_type * operator-> ( )

inline

Call referenced object.

Returns: A pointer to the referenced object.

References idref< C, B, T >::get().

◆ operator*() [1/2]

template<typename C , typename B , typename T >

const ref_type & operator* ( ) const

inline

Dereference referenced object.

Returns: A constant C++ reference to the referenced object.

References idref< C, B, T >::get().

◆ operator*() [2/2]

template<typename C , typename B , typename T >

ref_type & operator* ( )

inline

Dereference referenced object.

Returns: A C++ reference to the referenced object.

References idref< C, B, T >::get().

◆ get() [1/2]

template<typename C , typename B , typename T >

const ref_type * get ( ) const

inline

Get a constant pointer to the referenced object.

Returns: A constant pointer to the referenced object or 0 if the object of this type is not found.

Referenced by idref< C, B, T >::operator*(), idref< C, B, T >::operator*(), idref< C, B, T >::operator->(), and idref< C, B, T >::operator->().

◆ get() [2/2]

template<typename C , typename B , typename T >

ref_type * get ( )

inline

Get a pointer to the referenced object.

Returns: A pointer to the referenced object or 0 if the object of this type is not found.

◆ operator bool_convertible()

template<typename C , typename B , typename T >

operator bool_convertible ( ) const

inline

Implicit conversion to boolean type.

Returns: True if the referenced object is found, false otherwise.

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

types.hxx

Public Types

Constructors

Detailed Description

Constructor & Destructor Documentation

◆ idref() [1/10]

◆ idref() [2/10]

◆ idref() [3/10]

◆ idref() [4/10]

◆ idref() [5/10]

◆ idref() [6/10]

◆ idref() [7/10]

◆ idref() [8/10]

◆ idref() [9/10]

◆ idref() [10/10]

Member Function Documentation

◆ _clone()

◆ operator=() [1/4]

◆ operator=() [2/4]

◆ operator=() [3/4]

◆ operator=() [4/4]

◆ operator->() [1/2]

◆ operator->() [2/2]

◆ operator*() [1/2]

◆ operator*() [2/2]

◆ get() [1/2]

◆ get() [2/2]

◆ operator bool_convertible()