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

Provides a fast, read-only, in-memory representation of an XML document by using the XPath data model. More...

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

Public Types

using Ptr = SharedPtr< XPathDocument >
 An alias for shared pointer to an instance of this class. More...
 
- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 

Public Member Functions

ASPOSECPP_SHARED_API XPathDocument (const SharedPtr< XmlReader > &reader)
 Initializes a new instance of the XPathDocument class from the XML data that is contained in the specified XmlReader object. More...
 
ASPOSECPP_SHARED_API XPathDocument (const SharedPtr< XmlReader > &reader, XmlSpace space)
 Initializes a new instance of the XPathDocument class from the XML data that is contained in the specified XmlReader object with the specified white space handling. More...
 
ASPOSECPP_SHARED_API XPathDocument (const SharedPtr< IO::TextReader > &textReader)
 Initializes a new instance of the XPathDocument class from the XML data that is contained in the specified TextReader object. More...
 
ASPOSECPP_SHARED_API XPathDocument (const SharedPtr< IO::Stream > &stream)
 Initializes a new instance of the XPathDocument class from the XML data in the specified Stream object. More...
 
ASPOSECPP_SHARED_API XPathDocument (const String &uri)
 Initializes a new instance of the XPathDocument class from the XML data in the specified file. More...
 
ASPOSECPP_SHARED_API XPathDocument (const String &uri, XmlSpace space)
 Initializes a new instance of the XPathDocument class from the XML data in the file specified with the white space handling specified. More...
 
ASPOSECPP_SHARED_API SharedPtr< XPathNavigatorCreateNavigator () override
 Initializes a read-only XPathNavigator object for navigating through nodes in this XPathDocument. 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...
 
Objectoperator= (Object const &x)
 Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
ObjectSharedRefAdded ()
 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 reference 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 int32_t GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual ASPOSECPP_SHARED_API String ToString () 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 TypeInfoGetType () 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 (uint32_t argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...
 
virtual ASPOSECPP_SHARED_API bool FastCast (const Details::FastRttiBase &helper, void **out_ptr) const
 For internal purposes only. More...
 
template<>
bool Equals (float const &objA, float const &objB)
 Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...
 
template<>
bool Equals (double const &objA, double const &objB)
 Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...
 
template<>
bool ReferenceEquals (String const &str, std::nullptr_t)
 Specialization of Object::ReferenceEquals for case of string and nullptr. More...
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 Specialization of Object::ReferenceEquals for case of strings. More...
 

Protected Member Functions

virtual ASPOSECPP_SHARED_API ~XPathDocument ()
 

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 TypeInfoType ()
 Implements C# typeof(System.Object) construct. More...
 

Detailed Description

Provides a fast, read-only, in-memory representation of an XML document by using the XPath data model.

Attention
Objects of this class should only be allocated using System::MakeObject() function. Never create instances 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

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

Constructor & Destructor Documentation

◆ XPathDocument() [1/6]

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

Initializes a new instance of the XPathDocument class from the XML data that is contained in the specified XmlReader object.

Parameters
readerThe XmlReader object that contains the XML data.
Exceptions
XmlExceptionAn error was encountered in the XML data. The XPathDocument remains empty.
ArgumentNullExceptionThe XmlReader object passed as a parameter is nullptr.

◆ XPathDocument() [2/6]

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

Initializes a new instance of the XPathDocument class from the XML data that is contained in the specified XmlReader object with the specified white space handling.

Parameters
readerThe XmlReader object that contains the XML data.
spaceAn XmlSpace object.
Exceptions
XmlExceptionAn error was encountered in the XML data. The XPathDocument remains empty.
ArgumentNullExceptionThe XmlReader object parameter or XmlSpace object parameter is nullptr.

◆ XPathDocument() [3/6]

ASPOSECPP_SHARED_API System::Xml::XPath::XPathDocument::XPathDocument ( const SharedPtr< IO::TextReader > &  textReader)

Initializes a new instance of the XPathDocument class from the XML data that is contained in the specified TextReader object.

Parameters
textReaderThe TextReader object that contains the XML data.
Exceptions
XmlExceptionAn error was encountered in the XML data. The XPathDocument remains empty.
ArgumentNullExceptionThe TextReader object passed as a parameter is nullptr.

◆ XPathDocument() [4/6]

ASPOSECPP_SHARED_API System::Xml::XPath::XPathDocument::XPathDocument ( const SharedPtr< IO::Stream > &  stream)

Initializes a new instance of the XPathDocument class from the XML data in the specified Stream object.

Parameters
streamThe Stream object that contains the XML data.
Exceptions
XmlExceptionAn error was encountered in the XML data. The XPathDocument remains empty.
ArgumentNullExceptionThe Stream object passed as a parameter is nullptr.

◆ XPathDocument() [5/6]

ASPOSECPP_SHARED_API System::Xml::XPath::XPathDocument::XPathDocument ( const String uri)

Initializes a new instance of the XPathDocument class from the XML data in the specified file.

Parameters
uriThe path of the file that contains the XML data.
Exceptions
XmlExceptionAn error was encountered in the XML data. The XPathDocument remains empty.
ArgumentNullExceptionThe file path parameter is nullptr.

◆ XPathDocument() [6/6]

ASPOSECPP_SHARED_API System::Xml::XPath::XPathDocument::XPathDocument ( const String uri,
XmlSpace  space 
)

Initializes a new instance of the XPathDocument class from the XML data in the file specified with the white space handling specified.

Parameters
uriThe path of the file that contains the XML data.
spaceAn XmlSpace object.
Exceptions
XmlExceptionAn error was encountered in the XML data. The XPathDocument remains empty.
ArgumentNullExceptionThe file path parameter or XmlSpace object parameter is nullptr.

◆ ~XPathDocument()

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

Member Function Documentation

◆ CreateNavigator()

ASPOSECPP_SHARED_API SharedPtr<XPathNavigator> System::Xml::XPath::XPathDocument::CreateNavigator ( )
overridevirtual

Initializes a read-only XPathNavigator object for navigating through nodes in this XPathDocument.

Returns
A read-only XPathNavigator object.

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