CodePorting.Translator.Cs2Cpp.Framework
System::Xml::XPath::XPathItem Class Referenceabstract

Represents an item in the XQuery 1.0 and XPath 2.0 Data Model. More...

#include <xpath_item.h>

Inherits System::Object.

Inherited by System::Xml::Schema::XmlAtomicValue, and System::Xml::XPath::XPathNavigator.

Public Types

using Ptr = SharedPtr< XPathItem >
 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

virtual bool get_IsNode ()=0
 When overridden in a derived class, gets a value indicating whether the item represents an XPath node or an atomic value. More...
 
virtual SharedPtr< System::Xml::Schema::XmlSchemaTypeget_XmlType ()=0
 When overridden in a derived class, gets the XmlSchemaType for the item. More...
 
virtual String get_Value ()=0
 When overridden in a derived class, gets the string value of the item. More...
 
virtual SharedPtr< Objectget_TypedValue ()=0
 When overridden in a derived class, gets the current item as a boxed object of the most appropriate type according to its schema type. More...
 
virtual TypeInfo get_ValueType ()=0
 When overridden in a derived class, gets the type of the item. More...
 
virtual bool get_ValueAsBoolean ()=0
 When overridden in a derived class, gets the item's value as a Boolean. More...
 
virtual DateTime get_ValueAsDateTime ()=0
 When overridden in a derived class, gets the item's value as a DateTime. More...
 
virtual double get_ValueAsDouble ()=0
 When overridden in a derived class, gets the item's value as a Double. More...
 
virtual int32_t get_ValueAsInt ()=0
 When overridden in a derived class, gets the item's value as an Int32. More...
 
virtual int64_t get_ValueAsLong ()=0
 When overridden in a derived class, gets the item's value as an Int64. More...
 
virtual SharedPtr< ObjectValueAs (const TypeInfo &returnType)
 Returns the item's value as the specified type. More...
 
virtual SharedPtr< ObjectValueAs (const TypeInfo &returnType, SharedPtr< IXmlNamespaceResolver > nsResolver)=0
 When overridden in a derived class, returns the item's value as the type specified using the IXmlNamespaceResolver object specified to resolve namespace prefixes. 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...
 

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 item in the XQuery 1.0 and XPath 2.0 Data Model.

Member Typedef Documentation

◆ Ptr

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

Member Function Documentation

◆ get_IsNode()

virtual bool System::Xml::XPath::XPathItem::get_IsNode ( )
pure virtual

When overridden in a derived class, gets a value indicating whether the item represents an XPath node or an atomic value.

Returns
true if the item represents an XPath node; false if the item represents an atomic value.

Implemented in System::Xml::Schema::XmlAtomicValue, and System::Xml::XPath::XPathNavigator.

◆ get_TypedValue()

virtual SharedPtr< Object > System::Xml::XPath::XPathItem::get_TypedValue ( )
pure virtual

When overridden in a derived class, gets the current item as a boxed object of the most appropriate type according to its schema type.

Returns
The current item as a boxed object of the most appropriate type.

Implemented in System::Xml::Schema::XmlAtomicValue, and System::Xml::XPath::XPathNavigator.

◆ get_Value()

virtual String System::Xml::XPath::XPathItem::get_Value ( )
pure virtual

When overridden in a derived class, gets the string value of the item.

Returns
The string value of the item.

Implemented in System::Xml::Schema::XmlAtomicValue.

◆ get_ValueAsBoolean()

virtual bool System::Xml::XPath::XPathItem::get_ValueAsBoolean ( )
pure virtual

When overridden in a derived class, gets the item's value as a Boolean.

Returns
The item's value as a Boolean.
Exceptions
FormatExceptionThe item's value is not in the correct format for the Boolean type.
InvalidCastExceptionThe attempted cast to Boolean is not valid.

Implemented in System::Xml::Schema::XmlAtomicValue, and System::Xml::XPath::XPathNavigator.

◆ get_ValueAsDateTime()

virtual DateTime System::Xml::XPath::XPathItem::get_ValueAsDateTime ( )
pure virtual

When overridden in a derived class, gets the item's value as a DateTime.

Returns
The item's value as a DateTime.
Exceptions
FormatExceptionThe item's value is not in the correct format for the DateTime type.
InvalidCastExceptionThe attempted cast to DateTime is not valid.

Implemented in System::Xml::Schema::XmlAtomicValue, and System::Xml::XPath::XPathNavigator.

◆ get_ValueAsDouble()

virtual double System::Xml::XPath::XPathItem::get_ValueAsDouble ( )
pure virtual

When overridden in a derived class, gets the item's value as a Double.

Returns
The item's value as a Double.
Exceptions
FormatExceptionThe item's value is not in the correct format for the Double type.
InvalidCastExceptionThe attempted cast to Double is not valid.
OverflowExceptionThe attempted cast resulted in an overflow.

Implemented in System::Xml::Schema::XmlAtomicValue, and System::Xml::XPath::XPathNavigator.

◆ get_ValueAsInt()

virtual int32_t System::Xml::XPath::XPathItem::get_ValueAsInt ( )
pure virtual

When overridden in a derived class, gets the item's value as an Int32.

Returns
The item's value as an Int32.
Exceptions
FormatExceptionThe item's value is not in the correct format for the Int32 type.
InvalidCastExceptionThe attempted cast to Int32 is not valid.
OverflowExceptionThe attempted cast resulted in an overflow.

Implemented in System::Xml::Schema::XmlAtomicValue, and System::Xml::XPath::XPathNavigator.

◆ get_ValueAsLong()

virtual int64_t System::Xml::XPath::XPathItem::get_ValueAsLong ( )
pure virtual

When overridden in a derived class, gets the item's value as an Int64.

Returns
The item's value as an Int64.
Exceptions
FormatExceptionThe item's value is not in the correct format for the Int64 type.
InvalidCastExceptionThe attempted cast to Int64 is not valid.
OverflowExceptionThe attempted cast resulted in an overflow.

Implemented in System::Xml::Schema::XmlAtomicValue, and System::Xml::XPath::XPathNavigator.

◆ get_ValueType()

virtual TypeInfo System::Xml::XPath::XPathItem::get_ValueType ( )
pure virtual

When overridden in a derived class, gets the type of the item.

Returns
The type of the item. The default value is String.

Implemented in System::Xml::Schema::XmlAtomicValue, and System::Xml::XPath::XPathNavigator.

◆ get_XmlType()

virtual SharedPtr< System::Xml::Schema::XmlSchemaType > System::Xml::XPath::XPathItem::get_XmlType ( )
pure virtual

When overridden in a derived class, gets the XmlSchemaType for the item.

Returns
The XmlSchemaType for the item.

Implemented in System::Xml::Schema::XmlAtomicValue, and System::Xml::XPath::XPathNavigator.

◆ ValueAs() [1/2]

virtual SharedPtr< Object > System::Xml::XPath::XPathItem::ValueAs ( const TypeInfo returnType)
virtual

Returns the item's value as the specified type.

Parameters
returnTypeThe type to return the item value as.
Returns
The value of the item as the type requested.
Exceptions
FormatExceptionThe item's value is not in the correct format for the target type.
InvalidCastExceptionThe attempted cast is not valid.
OverflowExceptionThe attempted cast resulted in an overflow.

◆ ValueAs() [2/2]

virtual SharedPtr< Object > System::Xml::XPath::XPathItem::ValueAs ( const TypeInfo returnType,
SharedPtr< IXmlNamespaceResolver nsResolver 
)
pure virtual

When overridden in a derived class, returns the item's value as the type specified using the IXmlNamespaceResolver object specified to resolve namespace prefixes.

Parameters
returnTypeThe type to return the item's value as.
nsResolverThe IXmlNamespaceResolver object used to resolve namespace prefixes.
Returns
The value of the item as the type requested.
Exceptions
FormatExceptionThe item's value is not in the correct format for the target type.
InvalidCastExceptionThe attempted cast is not valid.
OverflowExceptionThe attempted cast resulted in an overflow.

Implemented in System::Xml::XPath::XPathNavigator, and System::Xml::Schema::XmlAtomicValue.