The card types. More...

#include <readerunit.hpp>

Inheritance diagram for logicalaccess::ReaderUnit:

Public Member Functions
	ReaderUnit (std::string rpt)
	Constructor.

virtual	~ReaderUnit ()
	Destructor.

std::string	getRPType () const
	Get the reader provider type.

virtual ByteVector	getPingCommand () const
	Get the reader ping command.

virtual bool	waitInsertion (unsigned int maxwait)=0
	Wait for a card insertion.

virtual bool	waitInsertion (const ByteVector &identifier, unsigned int maxwait)
	Wait for a specific card insertion.

virtual bool	waitRemoval (unsigned int maxwait)=0
	Wait for a card removal.

virtual bool	isConnected ()=0
	Check if the card is connected.

std::string	getCardType () const
	Get the forced card type.

virtual void	setCardType (std::string cardType)=0
	Set the forced card type.

virtual std::shared_ptr< Chip >	createChip (std::string type)
	Create the chip object from card type.

virtual std::shared_ptr< Chip >	createChip (std::string type, const ByteVector &identifier)
	Create the chip object from card type with identifier.

virtual ByteVector	getNumber (std::shared_ptr< Chip > chip)
	Get the number from the embedded licensing configuration.

virtual std::shared_ptr< Chip >	getSingleChip ()=0
	Get the first and/or most accurate chip found.

virtual std::vector< std::shared_ptr< Chip > >	getChipList ()=0
	Get chip available in the RFID rang.

virtual ByteVector	getNumber (std::shared_ptr< Chip > chip, std::shared_ptr< CardsFormatComposite > composite)
	Get the number from the reader format composite.

virtual bool	connect ()=0
	Connect to the card.

virtual bool	reconnect (int action=0)
	Reconnect to the card with the currently active share mode on the same reader.

virtual void	disconnect ()=0
	Disconnect from the card.

virtual bool	connectToReader ()=0
	Connect to the reader. Implicit connection on first command sent.

virtual void	disconnectFromReader ()=0
	Disconnect from reader.

virtual std::string	getName () const =0
	Get the reader unit name.

virtual std::string	getConnectedName ()
	Get the connected reader unit name.

virtual std::shared_ptr< ReaderUnitConfiguration >	getConfiguration ()
	Get the reader unit configuration.

virtual void	setConfiguration (std::shared_ptr< ReaderUnitConfiguration > config)
	Set the reader unit configuration.

virtual std::shared_ptr< ReaderCardAdapter >	getDefaultReaderCardAdapter ()
	Get the default reader/card adapter.

virtual void	setDefaultReaderCardAdapter (std::shared_ptr< ReaderCardAdapter > defaultRca)
	Set the default reader/card adapter.

virtual std::shared_ptr< DataTransport >	getDataTransport () const
	Get the data transport layer.

virtual void	setDataTransport (std::shared_ptr< DataTransport > dataTransport)
	Set the data transport layer.

virtual std::string	getReaderSerialNumber ()=0
	Get a string hexadecimal representation of the reader serial number.

std::string	getDefaultXmlNodeName () const override
	Get the default Xml Node name for this object.

void	serialize (boost::property_tree::ptree &node) override
	Serialize the current object to XML.

void	unSerialize (boost::property_tree::ptree &node) override
	UnSerialize a XML node to the current object.

void	unSerialize (boost::property_tree::ptree &node, const std::string &rootNode) override
	UnSerialize object from a Xml node.

std::shared_ptr< ReaderProvider >	getReaderProvider () const
	Get the associated reader provider.

void	setReaderProvider (std::weak_ptr< ReaderProvider > provider)
	Set the associated reader provider.

virtual std::shared_ptr< LCDDisplay >	getLCDDisplay ()
	Get the LCD Display for this reader unit.

virtual void	setLCDDisplay (std::shared_ptr< LCDDisplay > d)
	Get the LCD Display for this reader unit.

virtual std::shared_ptr< LEDBuzzerDisplay >	getLEDBuzzerDisplay ()
	Get the LED/Buzzer Display for this reader unit.

virtual void	setLEDBuzzerDisplay (std::shared_ptr< LEDBuzzerDisplay > lbd)
	Get the LCD Display for this reader unit.

virtual void	setCardTechnologies (const TechnoBitset &bitset)

virtual TechnoBitset	getCardTechnologies ()

virtual TechnoBitset	getPossibleCardTechnologies ()

virtual ReaderServicePtr	getService (const ReaderServiceType &type)

virtual std::string	serialize ()
	Serialize object to Xml Node string.

virtual void	serialize (boost::property_tree::ptree &parentNode)=0
	Serialize object to Xml Node.

virtual void	unSerialize (boost::property_tree::ptree &node)=0
	UnSerialize object from a Xml Node.

virtual void	unSerialize (const std::string &xmlstring, const std::string &rootNode)
	UnSerialize object from a Xml Node string.

virtual void	unSerialize (std::istream &is, const std::string &rootNode)
	UnSerialize object from a Xml node.

virtual void	unSerialize (boost::property_tree::ptree &node, const std::string &rootNode)
	UnSerialize object from a Xml node.

Public Member Functions inherited from logicalaccess::XmlSerializable
virtual	~XmlSerializable ()=default

virtual std::string	serialize ()
	Serialize object to Xml Node string.

virtual std::string	serializeWithHeaders ()
	Serialize object to Xml Node string, with xml headers.

virtual void	serialize (boost::property_tree::ptree &parentNode)=0
	Serialize object to Xml Node.

virtual void	serializeToFile (const std::string &filename)
	Serialize object to a Xml file.

virtual void	unSerialize (boost::property_tree::ptree &node)=0
	UnSerialize object from a Xml Node.

virtual void	unSerialize (const std::string &xmlstring, const std::string &rootNode)
	UnSerialize object from a Xml Node string.

virtual void	unSerialize (std::istream &is, const std::string &rootNode)
	UnSerialize object from a Xml node.

virtual void	unSerialize (boost::property_tree::ptree &node, const std::string &rootNode)
	UnSerialize object from a Xml node.

virtual void	unSerializeFromFile (const std::string &filename)
	UnSerialize object from a Xml file.

virtual std::string	getDefaultXmlNodeName () const =0
	Get the default Xml Node name for this object.

Static Public Member Functions
static uint64_t	getFormatedNumber (const ByteVector &number, int padding)
	Get the number as decimal a number.

static std::string	getFormatedNumber (const ByteVector &number)
	Get a string hexadecimal representation of the number.

Static Public Member Functions inherited from logicalaccess::XmlSerializable
static std::string	removeXmlDeclaration (const std::string &xmlstring)
	Remove Xml declaration from a xml string.

static ByteVector	formatHexString (std::string hexstr)
	Format hex string to hex string with space.

Protected Member Functions
virtual std::shared_ptr< ResultChecker >	createDefaultResultChecker () const

virtual std::shared_ptr< CardProbe >	createCardProbe ()

Protected Attributes
std::string	d_readerProviderType
	The associated reader provider type for the reader unit configuration.

std::string	d_card_type
	The forced card type.

std::weak_ptr< ReaderProvider >	d_readerProvider
	The associated reader provider for the reader unit.

std::shared_ptr< ReaderUnitConfiguration >	d_readerUnitConfig
	The reader unit configuration.

std::shared_ptr< Chip >	d_insertedChip
	The inserted chip.

std::shared_ptr< LCDDisplay >	d_lcdDisplay
	The inserted chip.

std::shared_ptr< LEDBuzzerDisplay >	d_ledBuzzerDisplay
	The inserted chip.

Private Attributes
std::shared_ptr< ReaderCardAdapter >	d_defaultReaderCardAdapter
	The default reader/card adapter.

std::shared_ptr< DataTransport >	d_dataTransport
	The data transport layer.

Additional Inherited Members
Static Protected Member Functions inherited from logicalaccess::XmlSerializable
static unsigned long long	atoull (const std::string &str)

Detailed Description

The card types.

The reader unit base class. This is an object for a specific reader instance to detect card and interact with the reader.

Constructor & Destructor Documentation

◆ ReaderUnit()

logicalaccess::ReaderUnit::ReaderUnit ( std::string rpt )

explicit

Constructor.

◆ ~ReaderUnit()

logicalaccess::ReaderUnit::~ReaderUnit ( )

virtual

Destructor.

Member Function Documentation

◆ connect()

virtual bool logicalaccess::ReaderUnit::connect ( )

pure virtual

Connect to the card.

Returns: True if the card was connected without error, false otherwise.

If the card handle was already connected, connect() first call disconnect(). If you intend to do a reconnection, call reconnect() instead.

Implemented in logicalaccess::DummyReaderUnit, logicalaccess::DeisterReaderUnit, logicalaccess::ElatecReaderUnit, logicalaccess::GunneboReaderUnit, logicalaccess::ISO7816ReaderUnit, logicalaccess::KeyboardReaderUnit, logicalaccess::LibUSBReaderUnit, logicalaccess::OK5553ReaderUnit, logicalaccess::OSDPReaderUnit, logicalaccess::PCSCReaderUnit, logicalaccess::ACSACR1222LReaderUnit, logicalaccess::ID3ReaderUnit, logicalaccess::RFIDeasReaderUnit, and logicalaccess::STidSTRReaderUnit.

◆ connectToReader()

virtual bool logicalaccess::ReaderUnit::connectToReader ( )

pure virtual

Connect to the reader. Implicit connection on first command sent.

Returns: True if the connection successed.

Implemented in logicalaccess::DummyReaderUnit, logicalaccess::DeisterReaderUnit, logicalaccess::ElatecReaderUnit, logicalaccess::GunneboReaderUnit, logicalaccess::ISO7816ReaderUnit, logicalaccess::KeyboardReaderUnit, logicalaccess::LibUSBReaderUnit, logicalaccess::OK5553ReaderUnit, logicalaccess::OSDPReaderUnit, logicalaccess::PCSCReaderUnit, logicalaccess::ACSACR1222LReaderUnit, logicalaccess::OmnikeyLANXX21ReaderUnit, logicalaccess::RFIDeasReaderUnit, and logicalaccess::STidSTRReaderUnit.

◆ createCardProbe()

std::shared_ptr< CardProbe > logicalaccess::ReaderUnit::createCardProbe ( )

protectedvirtual

Create a new CardProbe object that works with the current reader.

This is required because the behaviour of reader varies a lot when probing for cards.

The default implementation returns nullptr;

Reimplemented in logicalaccess::DummyReaderUnit, logicalaccess::ISO7816ReaderUnit, logicalaccess::PCSCReaderUnit, logicalaccess::ID3ReaderUnit, and logicalaccess::SpringCardReaderUnit.

◆ createChip() [1/2]

std::shared_ptr< Chip > logicalaccess::ReaderUnit::createChip ( std::string type )

virtual

Create the chip object from card type.

Parameters

type	The card type.

Returns: The chip.

Reimplemented in logicalaccess::DeisterReaderUnit, logicalaccess::ElatecReaderUnit, logicalaccess::GunneboReaderUnit, logicalaccess::KeyboardReaderUnit, logicalaccess::LibUSBReaderUnit, logicalaccess::OK5553ReaderUnit, logicalaccess::OSDPReaderUnit, logicalaccess::PCSCReaderUnit, logicalaccess::OmnikeyXX25ReaderUnit, logicalaccess::RFIDeasReaderUnit, and logicalaccess::STidSTRReaderUnit.

◆ createChip() [2/2]

std::shared_ptr< Chip > logicalaccess::ReaderUnit::createChip	(	std::string	type,
		const ByteVector &	identifier
	)

virtual

Create the chip object from card type with identifier.

Parameters

type	The card type.
identifier	The chip identifier.

Returns: The chip.

◆ createDefaultResultChecker()

std::shared_ptr< ResultChecker > logicalaccess::ReaderUnit::createDefaultResultChecker ( ) const

protectedvirtual

Create a new ResultChecker object that make sense for the current reader.

It's possible that this ResultChecker won't be used, as more fine-grained check regarding reader/card-type combination happen.

The default implementation returns nullptr.

Reimplemented in logicalaccess::DummyReaderUnit, logicalaccess::ISO7816ReaderUnit, logicalaccess::PCSCReaderUnit, logicalaccess::ACSACR1222LReaderUnit, logicalaccess::ACSACRReaderUnit, and logicalaccess::SpringCardReaderUnit.

◆ disconnect()

virtual void logicalaccess::ReaderUnit::disconnect ( )

pure virtual

Disconnect from the card.

Implemented in logicalaccess::DummyReaderUnit, logicalaccess::DeisterReaderUnit, logicalaccess::ElatecReaderUnit, logicalaccess::GunneboReaderUnit, logicalaccess::ISO7816ReaderUnit, logicalaccess::KeyboardReaderUnit, logicalaccess::LibUSBReaderUnit, logicalaccess::OK5553ReaderUnit, logicalaccess::OSDPReaderUnit, logicalaccess::PCSCReaderUnit, logicalaccess::ID3ReaderUnit, logicalaccess::RFIDeasReaderUnit, and logicalaccess::STidSTRReaderUnit.

◆ disconnectFromReader()

virtual void logicalaccess::ReaderUnit::disconnectFromReader ( )

pure virtual

Disconnect from reader.

Implemented in logicalaccess::DummyReaderUnit, logicalaccess::DeisterReaderUnit, logicalaccess::ElatecReaderUnit, logicalaccess::GunneboReaderUnit, logicalaccess::ISO7816ReaderUnit, logicalaccess::KeyboardReaderUnit, logicalaccess::LibUSBReaderUnit, logicalaccess::OK5553ReaderUnit, logicalaccess::OSDPReaderUnit, logicalaccess::PCSCReaderUnit, logicalaccess::ACSACR1222LReaderUnit, logicalaccess::OmnikeyLANXX21ReaderUnit, logicalaccess::RFIDeasReaderUnit, and logicalaccess::STidSTRReaderUnit.

◆ getCardTechnologies()

TechnoBitset logicalaccess::ReaderUnit::getCardTechnologies ( )

virtual

Return a bitset describing which cards technology are enabled.

The default implementation returns a bitset with all flags set to false.

Reimplemented in logicalaccess::PCSCReaderUnit, and logicalaccess::OmnikeyXX21ReaderUnit.

◆ getCardType()

std::string logicalaccess::ReaderUnit::getCardType ( ) const

inline

Get the forced card type.

Returns: The forced card type.

◆ getChipList()

virtual std::vector< std::shared_ptr< Chip > > logicalaccess::ReaderUnit::getChipList ( )

pure virtual

Get chip available in the RFID rang.

Returns: The chip list.

Implemented in logicalaccess::DummyReaderUnit, logicalaccess::DeisterReaderUnit, logicalaccess::ElatecReaderUnit, logicalaccess::GunneboReaderUnit, logicalaccess::ISO7816ReaderUnit, logicalaccess::KeyboardReaderUnit, logicalaccess::LibUSBReaderUnit, logicalaccess::OK5553ReaderUnit, logicalaccess::OSDPReaderUnit, logicalaccess::PCSCReaderUnit, logicalaccess::ID3ReaderUnit, logicalaccess::RFIDeasReaderUnit, and logicalaccess::STidSTRReaderUnit.

◆ getConfiguration()

std::shared_ptr< ReaderUnitConfiguration > logicalaccess::ReaderUnit::getConfiguration ( )

virtual

Get the reader unit configuration.

Returns: The reader unit configuration.

Reimplemented in logicalaccess::PCSCReaderUnit.

◆ getConnectedName()

virtual std::string logicalaccess::ReaderUnit::getConnectedName ( )

inlinevirtual

Get the connected reader unit name.

Returns: The connected reader unit name.

Reimplemented in logicalaccess::DeisterReaderUnit, logicalaccess::ElatecReaderUnit, logicalaccess::GunneboReaderUnit, logicalaccess::KeyboardReaderUnit, logicalaccess::LibUSBReaderUnit, logicalaccess::OK5553ReaderUnit, logicalaccess::OSDPReaderUnit, logicalaccess::PCSCReaderUnit, logicalaccess::RFIDeasReaderUnit, and logicalaccess::STidSTRReaderUnit.

◆ getDataTransport()

std::shared_ptr< DataTransport > logicalaccess::ReaderUnit::getDataTransport ( ) const

virtual

Get the data transport layer.

Returns: The data transport layer.

◆ getDefaultReaderCardAdapter()

std::shared_ptr< ReaderCardAdapter > logicalaccess::ReaderUnit::getDefaultReaderCardAdapter ( )

virtual

Get the default reader/card adapter.

Returns: The default reader/card adapter.

◆ getDefaultXmlNodeName()

std::string logicalaccess::ReaderUnit::getDefaultXmlNodeName ( ) const

overridevirtual

Get the default Xml Node name for this object.

Returns: The Xml node name.

Implements logicalaccess::XmlSerializable.

◆ getFormatedNumber() [1/2]

std::string logicalaccess::ReaderUnit::getFormatedNumber ( const ByteVector & number )

static

Get a string hexadecimal representation of the number.

Parameters

number The buffer with the number.

Returns: The number or an empty string on error.

◆ getFormatedNumber() [2/2]

uint64_t logicalaccess::ReaderUnit::getFormatedNumber	(	const ByteVector &	number,
		int	padding
	)

static

Get the number as decimal a number.

Parameters

number	The buffer with the number.
padding	Add or soustract a value to the number (Generaly used for a cards pack).

Returns: The number as a decimal representation.

◆ getLCDDisplay()

std::shared_ptr< LCDDisplay > logicalaccess::ReaderUnit::getLCDDisplay ( )

virtual

Get the LCD Display for this reader unit.

Returns: The LCD Display.

Reimplemented in logicalaccess::OSDPReaderUnit, logicalaccess::PCSCReaderUnit, and logicalaccess::ACSACR1222LReaderUnit.

◆ getLEDBuzzerDisplay()

std::shared_ptr< LEDBuzzerDisplay > logicalaccess::ReaderUnit::getLEDBuzzerDisplay ( )

virtual

Get the LED/Buzzer Display for this reader unit.

Returns: The LED/Buzzer Display.

Reimplemented in logicalaccess::OSDPReaderUnit, logicalaccess::PCSCReaderUnit, and logicalaccess::ACSACR1222LReaderUnit.

◆ getName()

virtual std::string logicalaccess::ReaderUnit::getName ( ) const

pure virtual

Get the reader unit name.

Returns: The reader unit name.

Implemented in logicalaccess::DummyReaderUnit, logicalaccess::DeisterReaderUnit, logicalaccess::ElatecReaderUnit, logicalaccess::GunneboReaderUnit, logicalaccess::ISO7816ReaderUnit, logicalaccess::KeyboardReaderUnit, logicalaccess::LibUSBReaderUnit, logicalaccess::OK5553ReaderUnit, logicalaccess::OSDPReaderUnit, logicalaccess::PCSCReaderUnit, logicalaccess::RFIDeasReaderUnit, and logicalaccess::STidSTRReaderUnit.

◆ getNumber() [1/2]

ByteVector logicalaccess::ReaderUnit::getNumber ( std::shared_ptr< Chip > chip )

virtual

Get the number from the embedded licensing configuration.

Parameters

chip	The chip object.

Returns: The identifier number.

Reimplemented in logicalaccess::LibUSBReaderUnit.

◆ getNumber() [2/2]

ByteVector logicalaccess::ReaderUnit::getNumber	(	std::shared_ptr< Chip >	chip,
		std::shared_ptr< CardsFormatComposite >	composite
	)

virtual

Get the number from the reader format composite.

Parameters

chip	The chip object.
composite	The card format composite.

Returns: The identifier number.

◆ getPingCommand()

ByteVector logicalaccess::ReaderUnit::getPingCommand ( ) const

virtual

Get the reader ping command.

Returns: The ping command.

Reimplemented in logicalaccess::DeisterReaderUnit, logicalaccess::ElatecReaderUnit, logicalaccess::GunneboReaderUnit, and logicalaccess::STidSTRReaderUnit.

◆ getPossibleCardTechnologies()

TechnoBitset logicalaccess::ReaderUnit::getPossibleCardTechnologies ( )

virtual

This returns a bitset of all technologies that can potentially be enabled on the reader.

This is useful because the TechnoBitset enumerate all possible technologies accros all the readers.

The default implementation returns an empty bitset.

Reimplemented in logicalaccess::OmnikeyXX21ReaderUnit.

◆ getReaderProvider()

std::shared_ptr< ReaderProvider > logicalaccess::ReaderUnit::getReaderProvider ( ) const

inline

Get the associated reader provider.

Returns: The associated reader provider.

◆ getReaderSerialNumber()

virtual std::string logicalaccess::ReaderUnit::getReaderSerialNumber ( )

pure virtual

Get a string hexadecimal representation of the reader serial number.

Returns: The reader serial number or an empty string on error.

Implemented in logicalaccess::DummyReaderUnit, logicalaccess::DeisterReaderUnit, logicalaccess::ElatecReaderUnit, logicalaccess::GunneboReaderUnit, logicalaccess::ISO7816ReaderUnit, logicalaccess::KeyboardReaderUnit, logicalaccess::LibUSBReaderUnit, logicalaccess::OK5553ReaderUnit, logicalaccess::OSDPReaderUnit, logicalaccess::PCSCReaderUnit, logicalaccess::ACSACR1222LReaderUnit, logicalaccess::RFIDeasReaderUnit, and logicalaccess::STidSTRReaderUnit.

◆ getRPType()

std::string logicalaccess::ReaderUnit::getRPType ( ) const

Get the reader provider type.

Returns: The reader provider type.

◆ getService()

ReaderServicePtr logicalaccess::ReaderUnit::getService ( const ReaderServiceType & type )

virtual

Request a service object of type type.

The service object will be associated with the current reader.

The default implementation returns nullptr;

Reimplemented in logicalaccess::PCSCReaderUnit, and logicalaccess::OmnikeyXX21ReaderUnit.

◆ getSingleChip()

virtual std::shared_ptr< Chip > logicalaccess::ReaderUnit::getSingleChip ( )

pure virtual

Get the first and/or most accurate chip found.

Returns: The single chip.

Implemented in logicalaccess::DummyReaderUnit, logicalaccess::DeisterReaderUnit, logicalaccess::ElatecReaderUnit, logicalaccess::GunneboReaderUnit, logicalaccess::ISO7816ReaderUnit, logicalaccess::KeyboardReaderUnit, logicalaccess::LibUSBReaderUnit, logicalaccess::OK5553ReaderUnit, logicalaccess::OSDPReaderUnit, logicalaccess::PCSCReaderUnit, logicalaccess::RFIDeasReaderUnit, and logicalaccess::STidSTRReaderUnit.

◆ isConnected()

virtual bool logicalaccess::ReaderUnit::isConnected ( )

pure virtual

Check if the card is connected.

Returns: True if the card is connected, false otherwise.

Implemented in logicalaccess::DummyReaderUnit, logicalaccess::DeisterReaderUnit, logicalaccess::ElatecReaderUnit, logicalaccess::GunneboReaderUnit, logicalaccess::ISO7816ReaderUnit, logicalaccess::KeyboardReaderUnit, logicalaccess::LibUSBReaderUnit, logicalaccess::OK5553ReaderUnit, logicalaccess::OSDPReaderUnit, logicalaccess::PCSCReaderUnit, logicalaccess::RFIDeasReaderUnit, and logicalaccess::STidSTRReaderUnit.

◆ reconnect()

virtual bool logicalaccess::ReaderUnit::reconnect ( int action = 0 )

inlinevirtual

Reconnect to the card with the currently active share mode on the same reader.

Returns: True if the card was reconnected without error, false otherwise.

Reimplemented in logicalaccess::ISO7816ReaderUnit, and logicalaccess::PCSCReaderUnit.

◆ serialize() [1/3]

std::string logicalaccess::XmlSerializable::serialize ( )

virtual

Serialize object to Xml Node string.

Returns: The serialized object.

Reimplemented from logicalaccess::XmlSerializable.

◆ serialize() [2/3]

void logicalaccess::ReaderUnit::serialize ( boost::property_tree::ptree & node )

overridevirtual

Serialize the current object to XML.

Parameters

parentNode The parent node.

Implements logicalaccess::XmlSerializable.

Reimplemented in logicalaccess::DeisterReaderUnit, logicalaccess::ElatecReaderUnit, logicalaccess::GunneboReaderUnit, logicalaccess::KeyboardReaderUnit, logicalaccess::LibUSBReaderUnit, logicalaccess::OK5553ReaderUnit, logicalaccess::OSDPReaderUnit, logicalaccess::PCSCReaderUnit, logicalaccess::RFIDeasReaderUnit, and logicalaccess::STidSTRReaderUnit.

◆ serialize() [3/3]

virtual void logicalaccess::XmlSerializable::serialize ( boost::property_tree::ptree & parentNode )

virtual

Serialize object to Xml Node.

Parameters

os	The XML stream.

Implements logicalaccess::XmlSerializable.

◆ setCardTechnologies()

void logicalaccess::ReaderUnit::setCardTechnologies ( const TechnoBitset & bitset )

virtual

Request that the reader enable or disable the various card technologies as described in the bitset. The default implementation just does nothing.

Reimplemented in logicalaccess::PCSCReaderUnit, and logicalaccess::OmnikeyXX21ReaderUnit.

◆ setCardType()

virtual void logicalaccess::ReaderUnit::setCardType ( std::string cardType )

pure virtual

Set the forced card type.

Parameters

cardType The forced card type.

Implemented in logicalaccess::DummyReaderUnit, logicalaccess::DeisterReaderUnit, logicalaccess::ElatecReaderUnit, logicalaccess::GunneboReaderUnit, logicalaccess::KeyboardReaderUnit, logicalaccess::LibUSBReaderUnit, logicalaccess::OK5553ReaderUnit, logicalaccess::OSDPReaderUnit, logicalaccess::PCSCReaderUnit, logicalaccess::RFIDeasReaderUnit, logicalaccess::STidSTRReaderUnit, and logicalaccess::ISO7816ReaderUnit.

◆ setConfiguration()

void logicalaccess::ReaderUnit::setConfiguration ( std::shared_ptr< ReaderUnitConfiguration > config )

virtual

Set the reader unit configuration.

Parameters

config The reader unit configuration.

Reimplemented in logicalaccess::GunneboReaderUnit, and logicalaccess::PCSCReaderUnit.

◆ setDataTransport()

void logicalaccess::ReaderUnit::setDataTransport ( std::shared_ptr< DataTransport > dataTransport )

virtual

Set the data transport layer.

Parameters

dataTransport The data transport layer.

◆ setDefaultReaderCardAdapter()

void logicalaccess::ReaderUnit::setDefaultReaderCardAdapter ( std::shared_ptr< ReaderCardAdapter > defaultRca )

virtual

Set the default reader/card adapter.

Parameters

defaultRca The default reader/card adapter.

◆ setLCDDisplay()

void logicalaccess::ReaderUnit::setLCDDisplay ( std::shared_ptr< LCDDisplay > d )

virtual

Get the LCD Display for this reader unit.

Returns: The LCD Display.

Reimplemented in logicalaccess::PCSCReaderUnit.

◆ setLEDBuzzerDisplay()

void logicalaccess::ReaderUnit::setLEDBuzzerDisplay ( std::shared_ptr< LEDBuzzerDisplay > lbd )

virtual

Get the LCD Display for this reader unit.

Returns: The LCD Display.

Reimplemented in logicalaccess::PCSCReaderUnit.

◆ setReaderProvider()

void logicalaccess::ReaderUnit::setReaderProvider ( std::weak_ptr< ReaderProvider > provider )

inline

Set the associated reader provider.

Parameters

provider The associated reader provider.

◆ unSerialize() [1/6]

void logicalaccess::ReaderUnit::unSerialize ( boost::property_tree::ptree & node )

overridevirtual

UnSerialize a XML node to the current object.

Parameters

node	The XML node.

Implements logicalaccess::XmlSerializable.

Reimplemented in logicalaccess::DeisterReaderUnit, logicalaccess::ElatecReaderUnit, logicalaccess::GunneboReaderUnit, logicalaccess::KeyboardReaderUnit, logicalaccess::LibUSBReaderUnit, logicalaccess::OK5553ReaderUnit, logicalaccess::OSDPReaderUnit, logicalaccess::PCSCReaderUnit, logicalaccess::RFIDeasReaderUnit, and logicalaccess::STidSTRReaderUnit.

◆ unSerialize() [2/6]

virtual void logicalaccess::XmlSerializable::unSerialize ( boost::property_tree::ptree & node )

virtual

UnSerialize object from a Xml Node.

Parameters

node	The Xml node.

Implements logicalaccess::XmlSerializable.

◆ unSerialize() [3/6]

void logicalaccess::XmlSerializable::unSerialize	(	boost::property_tree::ptree &	node,
		const std::string &	rootNode
	)

virtual

UnSerialize object from a Xml node.

Parameters

node	The Xml node.
rootNode	The root node.

Returns: True on success, false otherwise.

Reimplemented from logicalaccess::XmlSerializable.

◆ unSerialize() [4/6]

void logicalaccess::ReaderUnit::unSerialize	(	boost::property_tree::ptree &	node,
		const std::string &	rootNode
	)

overridevirtual

UnSerialize object from a Xml node.

Parameters

node	The Xml node.
rootNode	The root node.

Returns: True on success, false otherwise.

Reimplemented from logicalaccess::XmlSerializable.

◆ unSerialize() [5/6]

void logicalaccess::XmlSerializable::unSerialize	(	const std::string &	xmlstring,
		const std::string &	rootNode
	)

virtual

UnSerialize object from a Xml Node string.

Parameters

xmlstring	The Xml Node string.
rootNode	The root node.

Returns: True on success, false otherwise.

Reimplemented from logicalaccess::XmlSerializable.

◆ unSerialize() [6/6]

void logicalaccess::XmlSerializable::unSerialize	(	std::istream &	is,
		const std::string &	rootNode
	)

virtual

UnSerialize object from a Xml node.

Parameters

is	The Xml stream.
rootNode	The root node.

Returns: True on success, false otherwise.

Reimplemented from logicalaccess::XmlSerializable.

◆ waitInsertion() [1/2]

bool logicalaccess::ReaderUnit::waitInsertion	(	const ByteVector &	identifier,
		unsigned int	maxwait
	)

virtual

Wait for a specific card insertion.

Parameters

identifier	The chip identifier to wait.
maxwait	The maximum time to wait for, in milliseconds. If maxwait is zero, then the call never times out.

Returns: True if a card was inserted, false otherwise. If a card was inserted, the name of the reader on which the insertion was detected is accessible with getReader().

Warning: If the card is already connected, then the method always fail. Generic and heavy behavior, should be implemented correctly for each reader type.

◆ waitInsertion() [2/2]

virtual bool logicalaccess::ReaderUnit::waitInsertion ( unsigned int maxwait )

pure virtual

Wait for a card insertion.

Parameters

maxwait The maximum time to wait for, in milliseconds. If maxwait is zero, then the call never times out.

Returns: True if a card was inserted, false otherwise. If a card was inserted, the name of the reader on which the insertion was detected is accessible with getReader().

Warning: If the card is already connected, then the method always fail.

Implemented in logicalaccess::DummyReaderUnit, logicalaccess::DeisterReaderUnit, logicalaccess::ElatecReaderUnit, logicalaccess::GunneboReaderUnit, logicalaccess::KeyboardReaderUnit, logicalaccess::LibUSBReaderUnit, logicalaccess::OK5553ReaderUnit, logicalaccess::OSDPReaderUnit, logicalaccess::PCSCReaderUnit, logicalaccess::RFIDeasReaderUnit, logicalaccess::STidSTRReaderUnit, and logicalaccess::ISO7816ReaderUnit.

◆ waitRemoval()

virtual bool logicalaccess::ReaderUnit::waitRemoval ( unsigned int maxwait )

pure virtual

Wait for a card removal.

Parameters

maxwait The maximum time to wait for, in milliseconds. If maxwait is zero, then the call never times out.

Returns: True if a card was removed, false otherwise. If a card was removed, the name of the reader on which the removal was detected is accessible with getReader().

Member Data Documentation

◆ d_card_type

std::string logicalaccess::ReaderUnit::d_card_type

protected

The forced card type.

◆ d_dataTransport

std::shared_ptr<DataTransport> logicalaccess::ReaderUnit::d_dataTransport

private

The data transport layer.

◆ d_defaultReaderCardAdapter

std::shared_ptr<ReaderCardAdapter> logicalaccess::ReaderUnit::d_defaultReaderCardAdapter

private

The default reader/card adapter.

◆ d_insertedChip

std::shared_ptr<Chip> logicalaccess::ReaderUnit::d_insertedChip

protected

The inserted chip.

◆ d_lcdDisplay

std::shared_ptr<LCDDisplay> logicalaccess::ReaderUnit::d_lcdDisplay

protected

The inserted chip.

◆ d_ledBuzzerDisplay

std::shared_ptr<LEDBuzzerDisplay> logicalaccess::ReaderUnit::d_ledBuzzerDisplay

protected

The inserted chip.

◆ d_readerProvider

std::weak_ptr<ReaderProvider> logicalaccess::ReaderUnit::d_readerProvider

protected

The associated reader provider for the reader unit.

◆ d_readerProviderType

std::string logicalaccess::ReaderUnit::d_readerProviderType

protected

The associated reader provider type for the reader unit configuration.

◆ d_readerUnitConfig

std::shared_ptr<ReaderUnitConfiguration> logicalaccess::ReaderUnit::d_readerUnitConfig

protected

The reader unit configuration.

The documentation for this class was generated from the following files:

C:/dev/lla/liblogicalaccess/include/logicalaccess/readerproviders/readerunit.hpp
C:/dev/lla/liblogicalaccess/src/readerproviders/readerunit.cpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ReaderUnit()

◆ ~ReaderUnit()

Member Function Documentation

◆ connect()

◆ connectToReader()

◆ createCardProbe()

◆ createChip() [1/2]

◆ createChip() [2/2]

◆ createDefaultResultChecker()

◆ disconnect()

◆ disconnectFromReader()

◆ getCardTechnologies()

◆ getCardType()

◆ getChipList()

◆ getConfiguration()

◆ getConnectedName()

◆ getDataTransport()

◆ getDefaultReaderCardAdapter()

◆ getDefaultXmlNodeName()

◆ getFormatedNumber() [1/2]

◆ getFormatedNumber() [2/2]

◆ getLCDDisplay()

◆ getLEDBuzzerDisplay()

◆ getName()

◆ getNumber() [1/2]

◆ getNumber() [2/2]

◆ getPingCommand()

◆ getPossibleCardTechnologies()

◆ getReaderProvider()

◆ getReaderSerialNumber()

◆ getRPType()

◆ getService()

◆ getSingleChip()

◆ isConnected()

◆ reconnect()

◆ serialize() [1/3]

◆ serialize() [2/3]

◆ serialize() [3/3]

◆ setCardTechnologies()

◆ setCardType()

◆ setConfiguration()

◆ setDataTransport()

◆ setDefaultReaderCardAdapter()

◆ setLCDDisplay()

◆ setLEDBuzzerDisplay()

◆ setReaderProvider()

◆ unSerialize() [1/6]

◆ unSerialize() [2/6]

◆ unSerialize() [3/6]

◆ unSerialize() [4/6]

◆ unSerialize() [5/6]

◆ unSerialize() [6/6]

◆ waitInsertion() [1/2]

◆ waitInsertion() [2/2]

◆ waitRemoval()

Member Data Documentation

◆ d_card_type

◆ d_dataTransport

◆ d_defaultReaderCardAdapter

◆ d_insertedChip

◆ d_lcdDisplay

◆ d_ledBuzzerDisplay

◆ d_readerProvider

◆ d_readerProviderType

◆ d_readerUnitConfig