eVision::EQRCodeDecodedStreamPart Class Reference

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

#include <eVision/EasyQRCode/EQRCodeDecodedStreamPart.h>

Collaboration diagram for eVision::EQRCodeDecodedStreamPart:

Public Member Functions
	EQRCodeDecodedStreamPart ()
	Creates an EQRCodeDecodedStreamPart::EQRCodeDecodedStreamPart object.
	EQRCodeDecodedStreamPart (const eVision::EQRCodeDecodedStreamPart &other)
	Copy constructor of an EQRCodeDecodedStreamPart object.
virtual	~EQRCodeDecodedStreamPart () throw ()
eVision::EQRCodeDecodedStreamPart &	operator= (const eVision::EQRCodeDecodedStreamPart &other)
	Assignment operator.
eVision::EQRCodeEncoding	GetEncoding ()
	Encoding scheme used for this part of the decoded stream. Available values are contained in the EQRCodeEncoding enum.
std::vector< uint8_t >	GetDecodedData ()
	Decoded data of this part of the decoded stream represented as a vector of bytes.
int	GetECITableIndicator ()
	Extended Channel Interpretation (ECI) table indicator.
std::string	GetDecodedString () const
	String containing the concatenated decoded data of this part of the decoded stream.
std::string	GetDecodedString (eVision::EByteInterpretationMode byteInterpretationMode) const
	String containing the concatenated decoded data of this part of the decoded stream.
std::string	GetReserved1 () const
	EQRCodeDecodedStreamPart (CppWrapperInternal::InternalConstructor)

Public Attributes
CppWrapperInternal::WrappedClass	wrappedClass_

Detailed Description

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

License(s): EasyQRCode

Constructor & Destructor Documentation

EQRCodeDecodedStreamPart() [1/3]

eVision::EQRCodeDecodedStreamPart::EQRCodeDecodedStreamPart

(

)

Creates an EQRCodeDecodedStreamPart::EQRCodeDecodedStreamPart object.

EQRCodeDecodedStreamPart() [2/3]

eVision::EQRCodeDecodedStreamPart::EQRCodeDecodedStreamPart

(

const eVision::EQRCodeDecodedStreamPart &

other

)

Copy constructor of an EQRCodeDecodedStreamPart object.

Parameters

other

Another EQRCodeDecodedStreamPart.

~EQRCodeDecodedStreamPart()

eVision::EQRCodeDecodedStreamPart::~EQRCodeDecodedStreamPart ( ) throw (  )

virtual

EQRCodeDecodedStreamPart() [3/3]

eVision::EQRCodeDecodedStreamPart::EQRCodeDecodedStreamPart

(

CppWrapperInternal::InternalConstructor

)

Member Function Documentation

GetDecodedData()

std::vector< uint8_t > eVision::EQRCodeDecodedStreamPart::GetDecodedData

(

)

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

GetDecodedString() [1/2]

std::string eVision::EQRCodeDecodedStreamPart::GetDecodedString

(

)

const

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

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 EByteInterpretationMode::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 EByteInterpretationMode for more options.

GetDecodedString() [2/2]

std::string eVision::EQRCodeDecodedStreamPart::GetDecodedString

(

eVision::EByteInterpretationMode

byteInterpretationMode

)

const

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

Parameters

byteInterpretationMode

The EByteInterpretationMode that should be used to interpret bytes.

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 EByteInterpretationMode::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 EByteInterpretationMode for more options.

GetECITableIndicator()

int eVision::EQRCodeDecodedStreamPart::GetECITableIndicator

(

)

Extended Channel Interpretation (ECI) table indicator.

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

GetEncoding()

eVision::EQRCodeEncoding eVision::EQRCodeDecodedStreamPart::GetEncoding

(

)

Encoding scheme used for this part of the decoded stream. Available values are contained in the EQRCodeEncoding enum.

GetReserved1()

std::string eVision::EQRCodeDecodedStreamPart::GetReserved1

(

)

const

operator=()

eVision::EQRCodeDecodedStreamPart & eVision::EQRCodeDecodedStreamPart::operator=

(

const eVision::EQRCodeDecodedStreamPart &

other

)

Assignment operator.

Parameters

other

The EQRCodeDecodedStreamPart::EQRCodeDecodedStreamPart object that should be copied.

Member Data Documentation

wrappedClass_

CppWrapperInternal::WrappedClass eVision::EQRCodeDecodedStreamPart::wrappedClass_