Asposecpplib
System::Xml::XPath::XPathNodeIterator Class Reference

Represents an iterator that iterates over a selected set of nodes. 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. More...

Inherits System::Collections::Generic::IEnumerable< XPathNavigator::Ptr >, and System::Collections::Generic::IEnumerator< XPathNavigator::Ptr >.

Public Types

typedef SharedPtr< XPathNodeIteratorPtr
 An alias for shared pointer to an instance of this class. More...
 
- Public Types inherited from System::Collections::Generic::IEnumerable< XPathNavigator::Ptr >
typedef IEnumerator< XPathNavigator::Ptr > IEnumeratorType
 Enumerator type. More...
 
using ValueType = XPathNavigator::Ptr
 
using iterator = EnumeratorBasedIterator< XPathNavigator::Ptr, IEnumerator< XPathNavigator::Ptr > >
 
using const_iterator = iterator
 
- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 
- Public Types inherited from System::Collections::Generic::IEnumerator< XPathNavigator::Ptr >
typedef XPathNavigator::Ptr ValueType
 Value type. More...
 

Public Member Functions

virtual int get_Count ()
 Returns the index of the last node in the set. More...
 
XPathNavigator::Ptr get_Current () const override
 Returns an XPathNavigator object positioned at the current context node. More...
 
virtual int get_CurrentPosition ()
 Returns the current position of the iterator. More...
 
virtual XPathNodeIterator::Ptr Clone ()
 Returns a copy of the current XPathNodeIterator object. More...
 
SharedPtr< System::Collections::Generic::IEnumerator< XPathNavigator::Ptr > > GetEnumerator () override
 Returns an IEnumerator object that iterates through the selected node set. More...
 
bool MoveNext () override
 Moves the XPathNavigator object returned by the get_Current() method to the next node in the selected node set. More...
 
- Public Member Functions inherited from System::Collections::Generic::IEnumerable< XPathNavigator::Ptr >
XPathNavigator::Ptr LINQ_ElementAt (int index)
 Returns the element at a specified index in a sequence. More...
 
XPathNavigator::Ptr LINQ_First ()
 Returns the first element of a sequence. More...
 
XPathNavigator::Ptr LINQ_First (const Func< XPathNavigator::Ptr, bool > &predicate)
 Returns the first element of a sequence that satisfy the specified condition. More...
 
XPathNavigator::Ptr LINQ_FirstOrDefault ()
 Returns the first element of a sequence, or a default value if the sequence is empty. More...
 
XPathNavigator::Ptr LINQ_FirstOrDefault (std::function< bool(XPathNavigator::Ptr)> predicate)
 Returns the first element of the sequence that satisfies a condition or a default value if no such element is found. More...
 
XPathNavigator::Ptr LINQ_Last ()
 Returns the last element of a sequence. More...
 
XPathNavigator::Ptr LINQ_LastOrDefault ()
 Returns the last element of a sequence, or a default value if the sequence is empty. More...
 
SharedPtr< List< XPathNavigator::Ptr > > LINQ_ToList ()
 Creates a List<T> from a sequence. More...
 
int LINQ_Count ()
 Returns the number of elements in the sequence (calculated via direct counting). More...
 
int LINQ_Count (const Func< XPathNavigator::Ptr, bool > &predicate)
 Returns the number of elements in the sequence that satisfy the specified condition. More...
 
System::ArrayPtr< XPathNavigator::Ptr > LINQ_ToArray ()
 Creates an array from a sequence. More...
 
bool LINQ_All (std::function< bool(XPathNavigator::Ptr)> predicate)
 Determines whether all elements of a sequence satisfy a condition. More...
 
bool LINQ_Any ()
 Determines whether a sequence contains any elements. More...
 
bool LINQ_Any (std::function< bool(XPathNavigator::Ptr)> predicate)
 Determines whether any element of a sequence exists or satisfies a condition. More...
 
SharedPtr< IEnumerable< XPathNavigator::Ptr > > LINQ_Where (std::function< bool(XPathNavigator::Ptr)> predicate)
 Filters a sequence based on the specified predicate. More...
 
bool LINQ_Contains (XPathNavigator::Ptr value)
 Determines if a sequence contains a specified value. More...
 
SharedPtr< IEnumerable< ResultType > > LINQ_Cast ()
 Casts the elements to the specified type. More...
 
SharedPtr< IEnumerable< Result > > LINQ_Cast ()
 
SharedPtr< IEnumerable< XPathNavigator::Ptr > > LINQ_OrderBy (const Func< XPathNavigator::Ptr, Key > &keySelector)
 Sorts the elements of a sequence in ascending order according to the key values selected by keySelector. More...
 
SharedPtr< IEnumerable< Source > > LINQ_OrderBy (const Func< Source, Key > &keySelector)
 
SharedPtr< IEnumerable< XPathNavigator::Ptr > > LINQ_OrderByDescending (const Func< XPathNavigator::Ptr, Key > &keySelector)
 Sorts the elements of a sequence in descending order according to the key values selected by keySelector. More...
 
SharedPtr< IEnumerable< Source > > LINQ_OrderByDescending (const Func< Source, Key > &keySelector)
 
SharedPtr< IEnumerable< ResultType > > LINQ_OfType ()
 Filters the elements of the sequence based on the specified type. More...
 
SharedPtr< IEnumerable< Result > > LINQ_OfType ()
 
SharedPtr< IEnumerable< ResultType > > LINQ_Select (const Func< XPathNavigator::Ptr, ResultType > &selector)
 Transforms elements of a sequence. More...
 
SharedPtr< IEnumerable< ResultType > > LINQ_Select (const Func< XPathNavigator::Ptr, int32_t, ResultType > &selector)
 Transforms each element of a sequence into a new form by incorporating the element's index. More...
 
SharedPtr< IEnumerable< Result > > LINQ_Select (const Func< Source, Result > &selector)
 
SharedPtr< IEnumerable< Result > > LINQ_Select (const Func< Source, int32_t, Result > &selector)
 
SharedPtr< IEnumerable< XPathNavigator::Ptr > > LINQ_Concat (SharedPtr< IEnumerable< XPathNavigator::Ptr >> sequence)
 Concatenates two sequences. More...
 
System::SharedPtr< IEnumerable< System::SharedPtr< System::Linq::IGrouping< Key, XPathNavigator::Ptr > > > > LINQ_GroupBy (System::Func< XPathNavigator::Ptr, Key > keyPredicate)
 Groups the elements of a sequence. More...
 
SharedPtr< IEnumerable< SharedPtr< System::Linq::IGrouping< Key, Source > > > > LINQ_GroupBy (System::Func< Source, Key > keyPredicate)
 
SharedPtr< IEnumerable< ResultType > > LINQ_SelectMany (const Func< XPathNavigator::Ptr, SharedPtr< IEnumerable< ResultType >>> &selector)
 Projects each element of a sequence and combines the resulting sequences into one sequence. More...
 
SharedPtr< IEnumerable< Result > > LINQ_SelectMany (const Func< Source, SharedPtr< IEnumerable< Result >>> &selector)
 
iterator begin () noexcept
 Gets iterator pointing to the first element (if any) of the collection. This iterator can't be used to change a referenced object because GetEnumerator() returns a copy-object of T. More...
 
const_iterator begin () const noexcept
 Gets iterator pointing to the first element (if any) of the const-qualified instance of the collection. More...
 
iterator end () noexcept
 Gets iterator pointing right after the last element (if any) of the collection. This iterator can't be used to change a referenced object because GetEnumerator() returns a copy-object of T. More...
 
const_iterator end () const noexcept
 Gets iterator pointing right after the last element (if any) of the const-qualified instance of the collection. More...
 
const_iterator cbegin () const noexcept
 Gets iterator pointing to the first const-qualified element (if any) of the collection. More...
 
const_iterator cend () const noexcept
 Gets iterator pointing right after the last const-qualified element (if any) of the collection. More...
 
- Public Member Functions inherited from System::Object
 Object ()
 Creates object. Initializes all internal data structures. More...
 
virtual ~Object ()
 Destroys object. Frees all internal data structures. More...
 
 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...
 
void Lock ()
 Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...
 
void Unlock ()
 Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...
 
virtual bool Equals (ptr obj)
 Compares objects using C# Object.Equals semantics. More...
 
virtual int32_t GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual String ToString () const
 Analog of C# Object.ToString() method. Enables converting custom objects to string. More...
 
virtual ptr MemberwiseClone () const
 Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
 
virtual const TypeInfoGetType () const
 Gets actual type of object. Analog of C# System.Object.GetType() call. More...
 
virtual bool Is (const TypeInfo &targetType) const
 Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...
 
virtual 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 bool FastCast (const Details::FastRttiBase &helper, void **out_ptr) const
 For internal purposes only. 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...
 
- Public Member Functions inherited from System::Collections::Generic::IEnumerator< XPathNavigator::Ptr >
virtual XPathNavigator::Ptr Current () const
 Gets current element. More...
 
virtual void Reset ()
 Resets enumerator to position before first element. More...
 
- Public Member Functions inherited from System::IDisposable
virtual void Dispose ()
 Does nothing. More...
 

Protected Member Functions

 XPathNodeIterator ()
 Constructs a new instance of XPathNodeIterator class. More...
 
 XPathNodeIterator (const XPathDocument::Ptr &doc, const XPathNavigator::Ptr &parent_navigator, xmlXPathObject *xpath_obj)
 Constructor. More...
 
 ~XPathNodeIterator () override
 Destructor. More...
 
- Protected Member Functions inherited from System::Collections::Generic::IEnumerable< XPathNavigator::Ptr >
 ~IEnumerable () override
 Destructor. More...
 

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...
 
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...
 

Detailed Description

Represents an iterator that iterates over a selected set of nodes. 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

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

Constructor & Destructor Documentation

◆ XPathNodeIterator() [1/2]

System::Xml::XPath::XPathNodeIterator::XPathNodeIterator ( )
protected

Constructs a new instance of XPathNodeIterator class.

◆ XPathNodeIterator() [2/2]

System::Xml::XPath::XPathNodeIterator::XPathNodeIterator ( const XPathDocument::Ptr doc,
const XPathNavigator::Ptr parent_navigator,
xmlXPathObject *  xpath_obj 
)
protected

Constructor.

Parameters
docDocument iterator works in.
parent_navigatorNavigator of parent element to get context information from.
xpath_objXpath object.

◆ ~XPathNodeIterator()

System::Xml::XPath::XPathNodeIterator::~XPathNodeIterator ( )
overrideprotected

Destructor.

Member Function Documentation

◆ Clone()

virtual XPathNodeIterator::Ptr System::Xml::XPath::XPathNodeIterator::Clone ( )
virtual

Returns a copy of the current XPathNodeIterator object.

◆ get_Count()

virtual int System::Xml::XPath::XPathNodeIterator::get_Count ( )
virtual

Returns the index of the last node in the set.

Returns
The inde of the last node in the set; 0 if the set is empty

◆ get_Current()

XPathNavigator::Ptr System::Xml::XPath::XPathNodeIterator::get_Current ( ) const
overridevirtual

Returns an XPathNavigator object positioned at the current context node.

Implements System::Collections::Generic::IEnumerator< XPathNavigator::Ptr >.

◆ get_CurrentPosition()

virtual int System::Xml::XPath::XPathNodeIterator::get_CurrentPosition ( )
virtual

Returns the current position of the iterator.

◆ GetEnumerator()

SharedPtr<System::Collections::Generic::IEnumerator<XPathNavigator::Ptr> > System::Xml::XPath::XPathNodeIterator::GetEnumerator ( )
overridevirtual

Returns an IEnumerator object that iterates through the selected node set.

Implements System::Collections::Generic::IEnumerable< XPathNavigator::Ptr >.

◆ MoveNext()

bool System::Xml::XPath::XPathNodeIterator::MoveNext ( )
overridevirtual

Moves the XPathNavigator object returned by the get_Current() method to the next node in the selected node set.

Implements System::Collections::Generic::IEnumerator< XPathNavigator::Ptr >.