logicalaccess::TopazCommands Class Reference

The Topaz commands class. More...

#include <topazcommands.hpp>

Inheritance diagram for logicalaccess::TopazCommands:

Public Member Functions
	TopazCommands ()
	TopazCommands (std::string ct)
virtual ByteVector	readPages (int start_page, int stop_page)
	Read several pages.
virtual void	writePages (int start_page, int stop_page, const ByteVector &buf)
	Write several pages.
virtual void	lockPage (int page)
	Set a page as read-only.
virtual ByteVector	readPage (int page)=0
	Read a whole page.
virtual void	writePage (int page, const ByteVector &buf)=0
	Write a whole page.
Public Member Functions inherited from logicalaccess::Commands
	Commands ()=delete
	Constructor.
virtual	~Commands ()
std::shared_ptr< Chip >	getChip () const override
	Get the chip.
virtual void	setChip (std::shared_ptr< Chip > chip)
	Set the chip.
std::shared_ptr< ReaderCardAdapter >	getReaderCardAdapter () const override
	Get the reader/card adapter.
virtual void	setReaderCardAdapter (std::shared_ptr< ReaderCardAdapter > adapter)
	Set the reader/card adapter.
virtual const std::string &	getCmdType () const
	Get the cmd name.
virtual void	setCmdType (const std::string &command_type)
	Set the cmd name.
Public Member Functions inherited from logicalaccess::ICommands
virtual	~ICommands ()=default
virtual std::shared_ptr< Chip >	getChip () const =0
	Get the chip.
virtual std::shared_ptr< ReaderCardAdapter >	getReaderCardAdapter () const =0
	Get the reader/card adapter.

Protected Member Functions
std::shared_ptr< TopazChip >	getTopazChip () const
Protected Member Functions inherited from logicalaccess::Commands
	Commands (std::string commandtype)
	Constructor.

Additional Inherited Members
Protected Attributes inherited from logicalaccess::Commands
std::shared_ptr< ReaderCardAdapter >	d_readerCardAdapter
	The reader/card adapter.
std::weak_ptr< Chip >	d_chip
	The chip.
std::string	d_commandtype
	The command type.

Detailed Description

The Topaz commands class.

Constructor & Destructor Documentation

TopazCommands() [1/2]

logicalaccess::TopazCommands::TopazCommands ( )

inline

TopazCommands() [2/2]

logicalaccess::TopazCommands::TopazCommands ( std::string  ct )

inlineexplicit

Member Function Documentation

getTopazChip()

std::shared_ptr< TopazChip > logicalaccess::TopazCommands::getTopazChip ( ) const

protected

lockPage()

void logicalaccess::TopazCommands::lockPage ( int  page )

virtual

Set a page as read-only.

Parameters

page	The page to lock.

readPage()

virtual ByteVector logicalaccess::TopazCommands::readPage ( int  page )

pure virtual

Read a whole page.

Parameters

sector	The page number, from 0 to 15.
buf	A buffer to fill with the data of the page.
buflen	The length of buffer. Must be at least 4 bytes long or the call will fail.

Returns

The number of bytes red, or a negative value on error.

Implemented in logicalaccess::TopazACSACRCommands, logicalaccess::TopazOmnikeyXX27Commands, logicalaccess::TopazPCSCCommands, and logicalaccess::TopazSCMCommands.

readPages()

ByteVector logicalaccess::TopazCommands::readPages ( int  start_page, int  stop_page  )

virtual

Read several pages.

Parameters

start_page	The start page number, from 0 to stop_page.
stop_page	The stop page number, from start_page to 15.
buf	The buffer to fill with the data.
buflen	The length of buf. Must be at least (stop_page - start_page + 1) * 4 bytes long.

Returns

The number of bytes red, or a negative value on error.

writePage()

virtual void logicalaccess::TopazCommands::writePage ( int  page, const ByteVector &  buf  )

pure virtual

Write a whole page.

Parameters

sector	The page number, from 0 to 15.
buf	A buffer to from which to copy the data.
buflen	The length of buffer. Must be at least 4 bytes long or the call will fail.

Returns

The number of bytes written, or a negative value on error.

Implemented in logicalaccess::TopazACSACRCommands, logicalaccess::TopazOmnikeyXX27Commands, logicalaccess::TopazPCSCCommands, and logicalaccess::TopazSCMCommands.

writePages()

void logicalaccess::TopazCommands::writePages ( int  start_page, int  stop_page, const ByteVector &  buf  )

virtual

Write several pages.

Parameters

start_page	The start page number, from 0 to stop_page.
stop_page	The stop page number, from start_page to 15.
buf	The buffer to fill with the data.
buflen	The length of buf. Must be at least (stop_page - start_page + 1) * 4 bytes long.

Returns

The number of bytes red, or a negative value on error.

---

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

• C:/dev/lla/liblogicalaccess/plugins/logicalaccess/plugins/cards/topaz/topazcommands.hpp
• C:/dev/lla/liblogicalaccess/plugins/logicalaccess/plugins/cards/topaz/topazcommands.cpp