Aspose::BarCode::BarCodeRecognition::BarCodeResult Class Referencefinal

Stores recognized barcode data like SingleDecodeType type, System::String codetext, BarCodeRegionParameters region and other parameters More...

Inherits System::ICloneable, and System::IEquatable< System::SharedPtr< Aspose::BarCode::BarCodeRecognition::BarCodeResult > >.

Public Member Functions

double get_ReadingQuality ()
 Gets the reading quality. Works for 1D and postal barcodes. More...
 
BarCodeConfidence get_Confidence ()
 Gets recognition confidence level of the recognized barcode More...
 
System::String get_CodeText ()
 Gets the code text More...
 
System::ArrayPtr< uint8_t > get_CodeBytes ()
 Gets the encoded code bytes More...
 
System::SharedPtr< SingleDecodeTypeget_CodeType ()
 Gets the barcode type More...
 
System::String get_CodeTypeName ()
 Gets the name of the barcode type More...
 
System::SharedPtr< BarCodeRegionParametersget_Region ()
 Gets the barcode region More...
 
System::SharedPtr< BarCodeExtendedParametersget_Extended ()
 Gets extended parameters of recognized barcode More...
 
System::String GetCodeText (System::SharedPtr< System::Text::Encoding > encoding)
 Gets the code text with encoding. More...
 
bool Equals (System::SharedPtr< BarCodeResult > other) override
 Returns a value indicating whether this instance is equal to a specified BarCodeResult value. More...
 
int32_t GetHashCode () const override
 Returns the hash code for this instance. More...
 
System::SharedPtr< System::ObjectClone () override
 Creates a copy of BarCodeResult class. More...
 
 BarCodeResult (System::SharedPtr< BarCodeResult > result)
 Creates a a copy of the BarCodeResult class. More...
 
System::String ToString () const override
 Returns a human-readable string representation of this BarCodeResult. 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 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)
 
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)
 

Friends

bool operator== (System::SharedPtr< BarCodeResult > first, System::SharedPtr< BarCodeResult > second)
 
bool operator!= (System::SharedPtr< BarCodeResult > first, System::SharedPtr< BarCodeResult > second)
 

Additional Inherited Members

- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 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 TypeInfoType ()
 Implements C# typeof(System.Object) construct. More...
 

Detailed Description

Stores recognized barcode data like SingleDecodeType type, System::String codetext, BarCodeRegionParameters region and other parameters

This sample shows how to obtain BarCodeResult.

[C#]
using (BarcodeGenerator generator = new BarcodeGenerator(EncodeTypes.Code128, "12345"))
{
generator.Save(@"c:\test.png");
}
using (BarCodeReader reader = new BarCodeReader(@"c:\test.png", DecodeType.Code39Standard, DecodeType.Code128))
{
foreach (BarCodeResult result in reader.ReadBarCodes())
{
Console.WriteLine("BarCode Type: " + result.CodeTypeName);
Console.WriteLine("BarCode CodeText: " + result.CodeText);
Console.WriteLine("BarCode Confidence: " + result.Confidence);
Console.WriteLine("BarCode ReadingQuality: " + result.ReadingQuality);
Console.WriteLine("BarCode Angle: " + result.Region.Angle);
}
}
[VB.NET]
Using generator As New BarcodeGenerator(EncodeTypes.Code128, "12345")
generator.Save("c:\test.png")
End Using
Using reader As New BarCodeReader("c:\test.png", DecodeType.Code39Standard, DecodeType.Code128)
For Each result As BarCodeResult In reader.ReadBarCodes()
Console.WriteLine("BarCode Type: " + result.CodeTypeName)
Console.WriteLine("BarCode CodeText: " + result.CodeText)
Console.WriteLine("BarCode Confidence: " + result.Confidence)
Console.WriteLine("BarCode ReadingQuality: " + result.ReadingQuality)
Console.WriteLine("BarCode Angle: " + result.Region.Angle)
Next
End Using

Constructor & Destructor Documentation

◆ BarCodeResult()

Aspose::BarCode::BarCodeRecognition::BarCodeResult::BarCodeResult ( System::SharedPtr< BarCodeResult result)

Creates a a copy of the BarCodeResult class.

Parameters
resultAn copy BarCodeResult instance.

Member Function Documentation

◆ Clone()

System::SharedPtr<System::Object> Aspose::BarCode::BarCodeRecognition::BarCodeResult::Clone ( )
overridevirtual

Creates a copy of BarCodeResult class.

Returns
Returns copy of BarCodeResult class.

Implements System::ICloneable.

◆ Equals()

bool Aspose::BarCode::BarCodeRecognition::BarCodeResult::Equals ( System::SharedPtr< BarCodeResult other)
overridevirtual

Returns a value indicating whether this instance is equal to a specified BarCodeResult value.

Parameters
otherAn BarCodeResult value to compare to this instance.
Returns
true if obj has the same value as this instance; otherwise, false.

Implements System::IEquatable< System::SharedPtr< Aspose::BarCode::BarCodeRecognition::BarCodeResult > >.

◆ get_CodeBytes()

System::ArrayPtr<uint8_t> Aspose::BarCode::BarCodeRecognition::BarCodeResult::get_CodeBytes ( )

Gets the encoded code bytes

The code bytes of the barcode

◆ get_CodeText()

System::String Aspose::BarCode::BarCodeRecognition::BarCodeResult::get_CodeText ( )

Gets the code text

The code text of the barcode

◆ get_CodeType()

System::SharedPtr<SingleDecodeType> Aspose::BarCode::BarCodeRecognition::BarCodeResult::get_CodeType ( )

Gets the barcode type

The type information of the recognized barcode

◆ get_CodeTypeName()

System::String Aspose::BarCode::BarCodeRecognition::BarCodeResult::get_CodeTypeName ( )

Gets the name of the barcode type

The type name of the recognized barcode

◆ get_Confidence()

BarCodeConfidence Aspose::BarCode::BarCodeRecognition::BarCodeResult::get_Confidence ( )

Gets recognition confidence level of the recognized barcode

BarCodeConfidence::Strong does not have fakes or misrecognitions, BarCodeConfidence::Moderate could sometimes have fakes or incorrect codetext because this confidence level for barcodews with weak cheksum or even without it, BarCodeConfidence::None always has incorrect codetext and could be fake recognitions

◆ get_Extended()

System::SharedPtr<BarCodeExtendedParameters> Aspose::BarCode::BarCodeRecognition::BarCodeResult::get_Extended ( )

Gets extended parameters of recognized barcode

The extended parameters of recognized barcode

◆ get_ReadingQuality()

double Aspose::BarCode::BarCodeRecognition::BarCodeResult::get_ReadingQuality ( )

Gets the reading quality. Works for 1D and postal barcodes.

The reading quality percent

◆ get_Region()

System::SharedPtr<BarCodeRegionParameters> Aspose::BarCode::BarCodeRecognition::BarCodeResult::get_Region ( )

Gets the barcode region

The region of the recognized barcode

◆ GetCodeText()

System::String Aspose::BarCode::BarCodeRecognition::BarCodeResult::GetCodeText ( System::SharedPtr< System::Text::Encoding encoding)

Gets the code text with encoding.

Parameters
encodingThe encoding for codetext.
Returns
A string containing recognized code text.

◆ GetHashCode()

int32_t Aspose::BarCode::BarCodeRecognition::BarCodeResult::GetHashCode ( ) const
overridevirtual

Returns the hash code for this instance.

Returns
A 32-bit signed integer hash code.

Reimplemented from System::Object.

◆ ToString()

System::String Aspose::BarCode::BarCodeRecognition::BarCodeResult::ToString ( ) const
overridevirtual

Returns a human-readable string representation of this BarCodeResult.

Returns
A string that represents this BarCodeResult.

Reimplemented from System::Object.

Friends And Related Function Documentation

◆ operator!=

bool operator!= ( System::SharedPtr< BarCodeResult first,
System::SharedPtr< BarCodeResult second 
)
friend

◆ operator==

bool operator== ( System::SharedPtr< BarCodeResult first,
System::SharedPtr< BarCodeResult second 
)
friend