Aspose::BarCode::ComplexBarcode::MaxiCodeCodetextMode3 Class Reference

Class for encoding and decoding the text embedded in the MaxiCode code for modes 3. More...

Inherits Aspose::BarCode::ComplexBarcode::MaxiCodeStructuredCodetext.

Public Member Functions

Aspose::BarCode::Generation::MaxiCodeMode GetMode () const override
 Gets MaxiCode mode. More...
 
- Public Member Functions inherited from Aspose::BarCode::ComplexBarcode::MaxiCodeStructuredCodetext
System::String get_PostalCode ()
 Identifies the postal code. Must be 9 digits in mode 2 or 6 alphanumeric symbols in mode 3. More...
 
void set_PostalCode (System::String value)
 Identifies the postal code. Must be 9 digits in mode 2 or 6 alphanumeric symbols in mode 3. More...
 
int32_t get_CountryCode ()
 Identifies 3 digit country code. More...
 
void set_CountryCode (int32_t value)
 Identifies 3 digit country code. More...
 
int32_t get_ServiceCategory ()
 Identifies 3 digit service category. More...
 
void set_ServiceCategory (int32_t value)
 Identifies 3 digit service category. More...
 
System::SharedPtr< MaxiCodeSecondMessageget_SecondMessage () const
 Identifies second message of the barcode. More...
 
void set_SecondMessage (System::SharedPtr< MaxiCodeSecondMessage > value)
 Identifies second message of the barcode. More...
 
System::String GetConstructedCodetext () override
 Constructs codetext More...
 
void InitFromString (System::String constructedCodetext) override
 Initializes instance from constructed codetext. More...
 
bool Equals (System::SharedPtr< System::Object > obj) override
 Returns a value indicating whether this instance is equal to a specified MaxiCodeStructuredCodetext value. More...
 
int32_t GetHashCode () const override
 Returns the hash code for this instance. More...
 
 MaxiCodeStructuredCodetext ()
 
- Public Member Functions inherited from Aspose::BarCode::ComplexBarcode::MaxiCodeCodetext
Aspose::BarCode::Generation::MaxiCodeEncodeMode get_MaxiCodeEncodeMode () const
 Gets a MaxiCode encode mode. Default value: Auto. More...
 
void set_MaxiCodeEncodeMode (Aspose::BarCode::Generation::MaxiCodeEncodeMode value)
 Sets a MaxiCode encode mode. Default value: Auto. More...
 
Aspose::BarCode::Generation::ECIEncodings get_ECIEncoding ()
 Gets ECI encoding. Used when MaxiCodeEncodeMode is Auto. Default value: ISO-8859-1 More...
 
void set_ECIEncoding (Aspose::BarCode::Generation::ECIEncodings value)
 Sets ECI encoding. Used when MaxiCodeEncodeMode is Auto. Default value: ISO-8859-1 More...
 
System::SharedPtr< Aspose::BarCode::Generation::BaseEncodeTypeGetBarcodeType () override
 Gets barcode type. More...
 
 MaxiCodeCodetext ()
 
- 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 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)
 
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)
 

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

Class for encoding and decoding the text embedded in the MaxiCode code for modes 3.

This sample shows how to encode and decode MaxiCode codetext for mode 3.

[C#]
//Mode 3 with standart second message
MaxiCodeCodetextMode3 maxiCodeCodetext = new MaxiCodeCodetextMode3();
maxiCodeCodetext.PostalCode = "B1050";
maxiCodeCodetext.CountryCode = 056;
maxiCodeCodetext.ServiceCategory = 999;
MaxiCodeStandartSecondMessage maxiCodeStandartSecondMessage = new MaxiCodeStandartSecondMessage();
maxiCodeStandartSecondMessage.Message = "Test message";
maxiCodeCodetext.SecondMessage = maxiCodeStandartSecondMessage;
using (ComplexBarcodeGenerator complexGenerator = new ComplexBarcodeGenerator(maxiCodeCodetext))
{
complexGenerator.GenerateBarCodeImage();
}
//Mode 3 with structured second message
MaxiCodeCodetextMode3 maxiCodeCodetext = new MaxiCodeCodetextMode3();
maxiCodeCodetext.PostalCode = "B1050";
maxiCodeCodetext.CountryCode = 056;
maxiCodeCodetext.ServiceCategory = 999;
MaxiCodeStructuredSecondMessage maxiCodeStructuredSecondMessage = new MaxiCodeStructuredSecondMessage();
maxiCodeStructuredSecondMessage.Add("634 ALPHA DRIVE");
maxiCodeStructuredSecondMessage.Add("PITTSBURGH");
maxiCodeStructuredSecondMessage.Add("PA");
maxiCodeStructuredSecondMessage.Year = 99;
maxiCodeCodetext.SecondMessage = maxiCodeStructuredSecondMessage;
using (ComplexBarcodeGenerator complexGenerator = new ComplexBarcodeGenerator(maxiCodeCodetext))
{
complexGenerator.GenerateBarCodeImage();
}
//Decoding raw codetext with standart second message
using (BarCodeReader reader = new BarCodeReader(@"c:\test.png", DecodeType.MaxiCode))
{
foreach (BarCodeResult result in reader.ReadBarCodes())
{
MaxiCodeCodetext resultMaxiCodeCodetext = ComplexCodetextReader.TryDecodeMaxiCode(result.Extended.MaxiCode.MaxiCodeMode, result.CodeText);
if (resultMaxiCodeCodetext is MaxiCodeCodetextMode3){
MaxiCodeCodetextMode3 maxiCodeStructuredCodetext = (MaxiCodeCodetextMode3)resultMaxiCodeCodetext;
Console.WriteLine("BarCode Type: " + maxiCodeStructuredCodetext.PostalCode);
Console.WriteLine("MaxiCode mode: " + maxiCodeStructuredCodetext.CountryCode);
Console.WriteLine("BarCode CodeText: " + maxiCodeStructuredCodetext.ServiceCategory);
if (maxiCodeStructuredCodetext.SecondMessage is MaxiCodeStandartSecondMessage){
MaxiCodeStandartSecondMessage secondMessage = (MaxiCodeStandartSecondMessage)maxiCodeStructuredCodetext.SecondMessage;
Console.WriteLine("Message: " + secondMessage.Message);
}
}
}
}
//Decoding raw codetext with structured second message
using (BarCodeReader reader = new BarCodeReader(@"c:\test.png", DecodeType.MaxiCode))
{
foreach (BarCodeResult result in reader.ReadBarCodes())
{
MaxiCodeCodetext resultMaxiCodeCodetext = ComplexCodetextReader.TryDecodeMaxiCode(result.Extended.MaxiCode.MaxiCodeMode, result.CodeText);
if (resultMaxiCodeCodetext is MaxiCodeCodetextMode3){
MaxiCodeCodetextMode3 maxiCodeStructuredCodetext = (MaxiCodeCodetextMode3)resultMaxiCodeCodetext;
Console.WriteLine("BarCode Type: " + maxiCodeStructuredCodetext.PostalCode);
Console.WriteLine("MaxiCode mode: " + maxiCodeStructuredCodetext.CountryCode);
Console.WriteLine("BarCode CodeText: " + maxiCodeStructuredCodetext.ServiceCategory);
if (maxiCodeStructuredCodetext.SecondMessage is MaxiCodeStructuredSecondMessage){
MaxiCodeStructuredSecondMessage secondMessage = (MaxiCodeStructuredSecondMessage)maxiCodeStructuredCodetext.SecondMessage;
Console.WriteLine("Message:");
foreach (var identifier in secondMessage.Identifiers){
Console.WriteLine(identifier);
}
}
}
}
}

Member Function Documentation

◆ GetMode()

Aspose::BarCode::Generation::MaxiCodeMode Aspose::BarCode::ComplexBarcode::MaxiCodeCodetextMode3::GetMode ( ) const
overridevirtual

Gets MaxiCode mode.

Returns
MaxiCode mode

Implements Aspose::BarCode::ComplexBarcode::MaxiCodeCodetext.