The OSDP reader unit configuration base class. More...

#include <osdpreaderunitconfiguration.hpp>

Inheritance diagram for logicalaccess::OSDPReaderUnitConfiguration:

Public Member Functions
	OSDPReaderUnitConfiguration ()
	Constructor.

virtual	~OSDPReaderUnitConfiguration ()
	Destructor.

void	resetConfiguration () override
	Reset the configuration to default values.

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

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

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

unsigned char	getRS485Address () const
	Get the reader RS485 address.

void	setRS485Address (unsigned char address)
	Set the reader RS485 address.

bool	getVisualFeedback () const
	Get if visual feedback on card insertion/removal.

void	setVisualFeedback (bool enabled)
	Enable/Disable visual feedback on card insertion/removal.

bool	getInstallMode () const
	Get if install mode is enabled.

void	setInstallMode (bool installMode)
	Set the install mode.

bool	getTransparentMode () const
	Get if using transparent mode, false otherwise.

void	setTransparentMode (bool transparentMode)
	Set if using transparent mode, false otherwise.

std::shared_ptr< AES128Key >	getMasterKey () const
	Get the key used for AES enciphering.

void	setMasterKey (std::shared_ptr< AES128Key > key)
	Set the key used for AES enciphering.

std::shared_ptr< AES128Key >	getSCBKKey () const

void	setSCBKKey (std::shared_ptr< AES128Key > key)

std::shared_ptr< AES128Key >	getSCBKDKey () const

void	setSCBKDKey (std::shared_ptr< AES128Key > key)

Public Member Functions inherited from logicalaccess::ReaderUnitConfiguration
	ReaderUnitConfiguration (std::string rpt)
	Constructor.

virtual	~ReaderUnitConfiguration ()
	Destructor.

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

virtual void	resetConfiguration ()=0
	Reset the configuration to the default one.

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.

Protected Attributes
unsigned char	d_rs485Address
	The reader RS485 address (if communication type RS485 used).

bool	d_installMode
	Install mode, true/false for install mode (= communication encryption not mandatory).

bool	d_transparentMode
	Transparent mode, true (Mode-01) or false (Mode-00).

bool	d_visualFeedback
	The visual feedback, true/false for enabled/disabled.

std::shared_ptr< AES128Key >	d_master_key_aes
	The key used for AES enciphering.

std::shared_ptr< AES128Key >	d_scbk_key_aes

std::shared_ptr< AES128Key >	d_scbk_d_key_aes

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

Additional Inherited Members
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.

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

Detailed Description

The OSDP reader unit configuration base class.

Constructor & Destructor Documentation

◆ OSDPReaderUnitConfiguration()

logicalaccess::OSDPReaderUnitConfiguration::OSDPReaderUnitConfiguration ( )

Constructor.

◆ ~OSDPReaderUnitConfiguration()

logicalaccess::OSDPReaderUnitConfiguration::~OSDPReaderUnitConfiguration ( )

virtual

Destructor.

Member Function Documentation

◆ getDefaultXmlNodeName()

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

overridevirtual

Get the default Xml Node name for this object.

Returns: The Xml node name.

Implements logicalaccess::XmlSerializable.

◆ getInstallMode()

bool logicalaccess::OSDPReaderUnitConfiguration::getInstallMode ( ) const

Get if install mode is enabled.

Parameters

enabled True if install mode is enabled, false otherwise.

◆ getMasterKey()

std::shared_ptr< AES128Key > logicalaccess::OSDPReaderUnitConfiguration::getMasterKey ( ) const

Get the key used for AES enciphering.

Returns: The key.

◆ getRS485Address()

unsigned char logicalaccess::OSDPReaderUnitConfiguration::getRS485Address ( ) const

Get the reader RS485 address.

Returns: The RS485 address.

◆ getSCBKDKey()

std::shared_ptr< AES128Key > logicalaccess::OSDPReaderUnitConfiguration::getSCBKDKey ( ) const

◆ getSCBKKey()

std::shared_ptr< AES128Key > logicalaccess::OSDPReaderUnitConfiguration::getSCBKKey ( ) const

◆ getTransparentMode()

bool logicalaccess::OSDPReaderUnitConfiguration::getTransparentMode ( ) const

Get if using transparent mode, false otherwise.

Parameters

enabled True if transparent mode is enabled, false otherwise.

◆ getVisualFeedback()

bool logicalaccess::OSDPReaderUnitConfiguration::getVisualFeedback ( ) const

Get if visual feedback on card insertion/removal.

Parameters

enabled True if enable visual feedback is enabled, false otherwise.

◆ resetConfiguration()

void logicalaccess::OSDPReaderUnitConfiguration::resetConfiguration ( )

overridevirtual

Reset the configuration to default values.

Implements logicalaccess::ReaderUnitConfiguration.

◆ serialize()

void logicalaccess::OSDPReaderUnitConfiguration::serialize ( boost::property_tree::ptree & parentNode )

overridevirtual

Serialize the current object to XML.

Parameters

parentNode The parent node.

Implements logicalaccess::XmlSerializable.

◆ setInstallMode()

void logicalaccess::OSDPReaderUnitConfiguration::setInstallMode ( bool installMode )

Set the install mode.

Parameters

installMode True to enable install mode, false otherwise.

◆ setMasterKey()

void logicalaccess::OSDPReaderUnitConfiguration::setMasterKey ( std::shared_ptr< AES128Key > key )

Set the key used for AES enciphering.

Parameters

key The key.

◆ setRS485Address()

void logicalaccess::OSDPReaderUnitConfiguration::setRS485Address ( unsigned char address )

Set the reader RS485 address.

Parameters

address The RS485 address.

◆ setSCBKDKey()

void logicalaccess::OSDPReaderUnitConfiguration::setSCBKDKey ( std::shared_ptr< AES128Key > key )

◆ setSCBKKey()

void logicalaccess::OSDPReaderUnitConfiguration::setSCBKKey ( std::shared_ptr< AES128Key > key )

◆ setTransparentMode()

void logicalaccess::OSDPReaderUnitConfiguration::setTransparentMode ( bool transparentMode )

Set if using transparent mode, false otherwise.

Parameters

transparentMode True to enable transparent mode, false otherwise.

◆ setVisualFeedback()

void logicalaccess::OSDPReaderUnitConfiguration::setVisualFeedback ( bool enabled )

Enable/Disable visual feedback on card insertion/removal.

Parameters

enabled True to enable visual feedback, false otherwise.

◆ unSerialize()

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

overridevirtual

UnSerialize a XML node to the current object.

Parameters

node	The XML node.

Implements logicalaccess::XmlSerializable.

Member Data Documentation

◆ d_installMode

bool logicalaccess::OSDPReaderUnitConfiguration::d_installMode

protected

Install mode, true/false for install mode (= communication encryption not mandatory).

◆ d_master_key_aes

std::shared_ptr<AES128Key> logicalaccess::OSDPReaderUnitConfiguration::d_master_key_aes

protected

The key used for AES enciphering.

◆ d_rs485Address

unsigned char logicalaccess::OSDPReaderUnitConfiguration::d_rs485Address

protected

The reader RS485 address (if communication type RS485 used).

◆ d_scbk_d_key_aes

std::shared_ptr<AES128Key> logicalaccess::OSDPReaderUnitConfiguration::d_scbk_d_key_aes

protected

◆ d_scbk_key_aes

std::shared_ptr<AES128Key> logicalaccess::OSDPReaderUnitConfiguration::d_scbk_key_aes

protected

◆ d_transparentMode

bool logicalaccess::OSDPReaderUnitConfiguration::d_transparentMode

protected

Transparent mode, true (Mode-01) or false (Mode-00).

◆ d_visualFeedback

bool logicalaccess::OSDPReaderUnitConfiguration::d_visualFeedback

protected

The visual feedback, true/false for enabled/disabled.

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

C:/dev/lla/liblogicalaccess/plugins/logicalaccess/plugins/readers/osdp/osdpreaderunitconfiguration.hpp
C:/dev/lla/liblogicalaccess/plugins/logicalaccess/plugins/readers/osdp/osdpreaderunitconfiguration.cpp

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ OSDPReaderUnitConfiguration()

◆ ~OSDPReaderUnitConfiguration()

Member Function Documentation

◆ getDefaultXmlNodeName()

◆ getInstallMode()

◆ getMasterKey()

◆ getRS485Address()

◆ getSCBKDKey()

◆ getSCBKKey()

◆ getTransparentMode()

◆ getVisualFeedback()

◆ resetConfiguration()

◆ serialize()

◆ setInstallMode()

◆ setMasterKey()

◆ setRS485Address()

◆ setSCBKDKey()

◆ setSCBKKey()

◆ setTransparentMode()

◆ setVisualFeedback()

◆ unSerialize()

Member Data Documentation

◆ d_installMode

◆ d_master_key_aes

◆ d_rs485Address

◆ d_scbk_d_key_aes

◆ d_scbk_key_aes

◆ d_transparentMode

◆ d_visualFeedback