General operation result interface that defines common methods that concrete plugin operation result should implement. More...

#include "IOperationResult.h"

Inherits System::Object.

Inherited by Aspose::Pdf::Plugins::FileResult, Aspose::Pdf::Plugins::ObjectResult, Aspose::Pdf::Plugins::StreamResult, and Aspose::Pdf::Plugins::StringResult.

Public Member Functions
virtual bool	get_IsFile ()=0
	Indicates whether the result is a path to an output file. More...

virtual bool	get_IsStream ()=0
	Indicates whether the result is an output stream. More...

virtual bool	get_IsString ()=0
	Indicates whether the result is a text string. More...

virtual System::SharedPtr< System::Object >	get_Data ()=0
	Gets raw data. More...

virtual System::String	ToFile ()=0
	Tries to convert the result to the file. More...

virtual System::SharedPtr< System::IO::Stream >	ToStream ()=0
	Tries to convert the result to the stream 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 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 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 (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...

Additional Inherited Members
Public Types inherited from System::Object
typedef SmartPtr< Object >	ptr
	Alias for smart pointer type. More...

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

Detailed Description

General operation result interface that defines common methods that concrete plugin operation result should implement.

Member Function Documentation

◆ get_Data()

virtual System::SharedPtr<System::Object> Aspose::Pdf::Plugins::IOperationResult::get_Data ( )

pure virtual

Gets raw data.

Returns: An object representing output data.

Implemented in Aspose::Pdf::Plugins::FileResult, Aspose::Pdf::Plugins::StreamResult, Aspose::Pdf::Plugins::StringResult, and Aspose::Pdf::Plugins::ObjectResult.

◆ get_IsFile()

virtual bool Aspose::Pdf::Plugins::IOperationResult::get_IsFile ( )

pure virtual

Indicates whether the result is a path to an output file.

Returns: true if the result is a file; otherwise false.

Implemented in Aspose::Pdf::Plugins::FileResult, Aspose::Pdf::Plugins::StreamResult, Aspose::Pdf::Plugins::StringResult, and Aspose::Pdf::Plugins::ObjectResult.

◆ get_IsStream()

virtual bool Aspose::Pdf::Plugins::IOperationResult::get_IsStream ( )

pure virtual

Indicates whether the result is an output stream.

Returns: true if the result is a stream object; otherwise false.

Implemented in Aspose::Pdf::Plugins::FileResult, Aspose::Pdf::Plugins::StreamResult, Aspose::Pdf::Plugins::StringResult, and Aspose::Pdf::Plugins::ObjectResult.

◆ get_IsString()

virtual bool Aspose::Pdf::Plugins::IOperationResult::get_IsString ( )

pure virtual

Indicates whether the result is a text string.

Returns: true if the result is a string; otherwise false.

Implemented in Aspose::Pdf::Plugins::FileResult, Aspose::Pdf::Plugins::StreamResult, Aspose::Pdf::Plugins::StringResult, and Aspose::Pdf::Plugins::ObjectResult.

◆ ToFile()

virtual System::String Aspose::Pdf::Plugins::IOperationResult::ToFile ( )

pure virtual

Tries to convert the result to the file.

Returns: A string representing the path to the output file if the result is file; otherwise null.

Implemented in Aspose::Pdf::Plugins::FileResult, Aspose::Pdf::Plugins::StreamResult, Aspose::Pdf::Plugins::StringResult, and Aspose::Pdf::Plugins::ObjectResult.

◆ ToStream()

virtual System::SharedPtr<System::IO::Stream> Aspose::Pdf::Plugins::IOperationResult::ToStream ( )

pure virtual

Tries to convert the result to the stream object.

Returns: A stream object representing the output data if the result is stream; otherwise null.

Implemented in Aspose::Pdf::Plugins::FileResult, Aspose::Pdf::Plugins::StreamResult, Aspose::Pdf::Plugins::StringResult, and Aspose::Pdf::Plugins::ObjectResult.

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ get_Data()

◆ get_IsFile()

◆ get_IsStream()

◆ get_IsString()

◆ ToFile()

◆ ToStream()