eVision Python API
Loading...
Searching...
No Matches
eVision.EQRCodeDecodedStreamPart Class Reference

Represents part of a decoded stream, eVision.EQRCodeDecodedStream, extracted from a QR code (eVision.EQRCode). More...

Public Member Functions

None __init__ (self)
 Creates an eVision.EQRCodeDecodedStreamPart.__init__ object.
None __init__ (self, eVision.EQRCodeDecodedStreamPart other)
 Copy constructor of an eVision.EQRCodeDecodedStreamPart object.
str GetDecodedString (self)
 String containing the concatenated decoded data of this part of the decoded stream.
str GetDecodedString (self, eVision.EByteInterpretationMode byteInterpretationMode)
 String containing the concatenated decoded data of this part of the decoded stream.
eVision.EQRCodeEncoding Encoding (self)
 Encoding scheme used for this part of the decoded stream.
list[int] DecodedData (self)
 Decoded data of this part of the decoded stream represented as a vector of bytes.
int ECITableIndicator (self)
 Extended Channel Interpretation (ECI) table indicator.
str Reserved1 (self)

Detailed Description

Represents part of a decoded stream, eVision.EQRCodeDecodedStream, extracted from a QR code (eVision.EQRCode).

Remarks:

License(s): EasyQRCode

Constructor & Destructor Documentation

◆ __init__() [1/2]

None eVision.EQRCodeDecodedStreamPart.__init__ ( self)

◆ __init__() [2/2]

None eVision.EQRCodeDecodedStreamPart.__init__ ( self,
eVision.EQRCodeDecodedStreamPart other )

Copy constructor of an eVision.EQRCodeDecodedStreamPart object.

Parameters
otherAnother eVision.EQRCodeDecodedStreamPart.

Member Function Documentation

◆ DecodedData()

list[int] eVision.EQRCodeDecodedStreamPart.DecodedData ( self)

Decoded data of this part of the decoded stream represented as a vector of bytes.

◆ ECITableIndicator()

int eVision.EQRCodeDecodedStreamPart.ECITableIndicator ( self)

Extended Channel Interpretation (ECI) table indicator.

Remarks:

The ECI table indicator is relevant if the coding mode of the QR code is eVision.EQRCodeCodingMode.ECI only. Value is otherwise set to -1.

◆ Encoding()

eVision.EQRCodeEncoding eVision.EQRCodeDecodedStreamPart.Encoding ( self)

Encoding scheme used for this part of the decoded stream.

Available values are contained in the eVision.EQRCodeEncoding enum.

◆ GetDecodedString() [1/2]

str eVision.EQRCodeDecodedStreamPart.GetDecodedString ( self)

String containing the concatenated decoded data of this part of the decoded stream.

Remarks:

No parameter is required if no bytes are encoded or if the ECI byte encoding mode is supported. Exception will be thrown if a parameter is required or if a wrong one is used.

The eVision.EByteInterpretationMode.Hexadecimal parameter throws no exception and will return the bytes hexadecimal values wrapped between '0xEFBFBD'. This mode overrides the ECI mode. Sample : RC -> EFBFBD + RC + EFBFBD -> EFBFBD5243EFBFBD

See eVision.EByteInterpretationMode for more options.

◆ GetDecodedString() [2/2]

str eVision.EQRCodeDecodedStreamPart.GetDecodedString ( self,
eVision.EByteInterpretationMode byteInterpretationMode )

String containing the concatenated decoded data of this part of the decoded stream.

Remarks:

No parameter is required if no bytes are encoded or if the ECI byte encoding mode is supported. Exception will be thrown if a parameter is required or if a wrong one is used.

The eVision.EByteInterpretationMode.Hexadecimal parameter throws no exception and will return the bytes hexadecimal values wrapped between '0xEFBFBD'. This mode overrides the ECI mode. Sample : RC -> EFBFBD + RC + EFBFBD -> EFBFBD5243EFBFBD

See eVision.EByteInterpretationMode for more options.

Parameters
byteInterpretationModeThe eVision.EByteInterpretationMode that should be used to interpret bytes.

◆ Reserved1()

str eVision.EQRCodeDecodedStreamPart.Reserved1 ( self)