System::Xml::XPath::XPathDocument Class Reference

Inherits System::Xml::XPath::IXPathNavigable.

Public Types
typedef SharedPtr< XPathDocument >	Ptr
	An alias for shared pointer to an instance of this class. More...
Public Types inherited from System::Object
typedef SmartPtr< Object >	ptr
	Alias for smart pointer type. More...
typedef System::Details::SharedMembersType	shared_members_type
	structure to keep list of shared pointers contained in object. More...

Public Member Functions
ASPOSECPP_SHARED_API	XPathDocument (const String &uri)
ASPOSECPP_SHARED_API	XPathDocument (const SharedPtr< XmlDocument > &doc)
ASPOSECPP_SHARED_API	XPathDocument (const SharedPtr< XmlReader > &reader)
ASPOSECPP_SHARED_API	XPathDocument (const SharedPtr< XmlReader > &reader, XmlSpace space)
virtual ASPOSECPP_SHARED_API	~XPathDocument ()
	Destructor. More...
virtual ASPOSECPP_SHARED_API XPathNavigator::Ptr	CreateNavigator () override
	Constructs a new instance of XPathNavigator class. More...
XmlDocument::Ptr	GetDocument () const
	Returns an XML document represented by the current object. More...
Public Member Functions inherited from System::Object
ASPOSECPP_SHARED_API	Object ()
	Creates object. Initializes all internal data structures. More...
virtual ASPOSECPP_SHARED_API	~Object ()
	Destroys object. Frees all internal data structures. More...
ASPOSECPP_SHARED_API	Object (Object const &x)
	Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
Object &	operator= (Object const &x)
	Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
Object *	SharedRefAdded ()
	Increments shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
int	SharedRefRemovedSafe ()
	Decrements and returns shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
int	RemovedSharedRefs (int count)
	Decreases shared reference count by specified value. More...
Detail::SmartPtrCounter *	WeakRefAdded ()
	Increments weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
void	WeakRefRemoved ()
	Decrements weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
Detail::SmartPtrCounter *	GetCounter ()
	Gets reference counter data structure associated with the object. More...
int	SharedCount () const
	Gets current value of shared refernce counter. More...
ASPOSECPP_SHARED_API void	Lock ()
	Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...
ASPOSECPP_SHARED_API void	Unlock ()
	Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...
virtual ASPOSECPP_SHARED_API bool	Equals (ptr obj)
	Compares objects using C# Object.Equals semantics. More...
virtual ASPOSECPP_SHARED_API int	GetHashCode () const
	Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
virtual ASPOSECPP_SHARED_API String	ToString () ASPOSE_CONST
	Analog of C# Object.ToString() method. Enables converting custom objects to string. More...
virtual ASPOSECPP_SHARED_API ptr	MemberwiseClone () const
	Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
virtual ASPOSECPP_SHARED_API const TypeInfo &	GetType () const
	Gets actual type of object. Analog of C# System.Object.GetType() call. More...
virtual ASPOSECPP_SHARED_API bool	Is (const TypeInfo &targetType) const
	Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...
virtual ASPOSECPP_SHARED_API void	SetTemplateWeakPtr (unsigned int argument)
	Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...
template<>
bool	Equals (float const &objA, float const &objB)
template<>
bool	Equals (double const &objA, double const &objB)
template<>
bool	ReferenceEquals (String const &str, std::nullptr_t)
template<>
bool	ReferenceEquals (String const &str1, String const &str2)

Additional Inherited Members
Static Public Member Functions inherited from System::Object
static bool	ReferenceEquals (ptr const &objA, ptr const &objB)
	Compares objects by reference. More...
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type	ReferenceEquals (T const &objA, T const &objB)
	Compares objects by reference. More...
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type	ReferenceEquals (T const &objA, std::nullptr_t)
	Reference-compares value type object with nullptr. More...
template<typename T1 , typename T2 >
static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type	Equals (T1 const &objA, T2 const &objB)
	Compares reference type objects in C# style. More...
template<typename T1 , typename T2 >
static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type	Equals (T1 const &objA, T2 const &objB)
	Compares value type objects in C# style. More...
static const TypeInfo &	Type ()
	Impleemnts C# typeof(System.Object) construct. More...

Detailed Description

Provides a read-only representation of an XML document using the XPath data model. Objects of this class should only be allocated using System::MakeObject() function. Never create instance of this type on stack or using operator new, as it will result in runtime errors and/or assertion faults. Always wrap this class into System::SmartPtr pointer and use this pointer to pass it to functions as argument.

Member Typedef Documentation

Ptr

typedef SharedPtr<XPathDocument> System::Xml::XPath::XPathDocument::Ptr

An alias for shared pointer to an instance of this class.

Constructor & Destructor Documentation

XPathDocument() [1/4]

ASPOSECPP_SHARED_API System::Xml::XPath::XPathDocument::XPathDocument

(

const String &

uri

)

Constructs an XPathDocument object from the XML data in the specified resource.

Parameters

uri	A URI of the XML document

XPathDocument() [2/4]

ASPOSECPP_SHARED_API System::Xml::XPath::XPathDocument::XPathDocument

(

const SharedPtr< XmlDocument > &

doc

)

Constructs an XPathDocument object from the specified XML document.

Parameters

doc	An XML document to be represented by the object being constructed

XPathDocument() [3/4]

ASPOSECPP_SHARED_API System::Xml::XPath::XPathDocument::XPathDocument

(

const SharedPtr< XmlReader > &

reader

)

Constructs an XPathDocument object from the XML-data contained in the specified XmlReader object.

Parameters

reader

An XmlReader object that contains the XML-data.

XPathDocument() [4/4]

ASPOSECPP_SHARED_API System::Xml::XPath::XPathDocument::XPathDocument	(	const SharedPtr< XmlReader > &	reader,
		XmlSpace	space
	)

Constructs an XPathDocument object from the XML-data contained in the specified XmlReader object with the specified xml:space scope.

Parameters

reader	An XmlReader object that contains the XML-data.
space	An XmlSpace object.

~XPathDocument()

virtual ASPOSECPP_SHARED_API System::Xml::XPath::XPathDocument::~XPathDocument ( )

virtual

Destructor.

Member Function Documentation

CreateNavigator()

virtual ASPOSECPP_SHARED_API XPathNavigator::Ptr System::Xml::XPath::XPathDocument::CreateNavigator ( )

overridevirtual

Constructs a new instance of XPathNavigator class.

Implements System::Xml::XPath::IXPathNavigable.

GetDocument()

XmlDocument::Ptr System::Xml::XPath::XPathDocument::GetDocument ( ) const

inline

Returns an XML document represented by the current object.