LibLogicalAccess  2.5.0
An Open Source RFID Library
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
logicalaccess::KeyboardReaderUnitConfiguration Class Reference

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

#include <keyboardreaderunitconfiguration.hpp>

Inheritance diagram for logicalaccess::KeyboardReaderUnitConfiguration:
logicalaccess::ReaderUnitConfiguration logicalaccess::XmlSerializable

Public Member Functions

 KeyboardReaderUnitConfiguration ()
 Constructor.
 
virtual ~KeyboardReaderUnitConfiguration ()
 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.
 
std::string getPrefix () const
 
void setPrefix (const std::string &prefix)
 
std::string getSuffix () const
 
void setSuffix (const std::string &suffix)
 
bool getIsDecimalNumber () const
 
void setIsDecimalNumber (bool isDecimal)
 
std::string getKeyboardLayout () const
 
void setKeyboardLayout (const std::string &klayout)
 
- 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

std::string d_prefix
 
std::string d_suffix
 
bool d_isDecimalNumber
 
std::string d_klayout
 
- 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 Keyboard reader unit configuration base class.

Constructor & Destructor Documentation

◆ KeyboardReaderUnitConfiguration()

logicalaccess::KeyboardReaderUnitConfiguration::KeyboardReaderUnitConfiguration ( )

Constructor.

◆ ~KeyboardReaderUnitConfiguration()

logicalaccess::KeyboardReaderUnitConfiguration::~KeyboardReaderUnitConfiguration ( )
virtual

Destructor.

Member Function Documentation

◆ getDefaultXmlNodeName()

std::string logicalaccess::KeyboardReaderUnitConfiguration::getDefaultXmlNodeName ( ) const
overridevirtual

Get the default Xml Node name for this object.

Returns
The Xml node name.

Implements logicalaccess::XmlSerializable.

◆ getIsDecimalNumber()

bool logicalaccess::KeyboardReaderUnitConfiguration::getIsDecimalNumber ( ) const

◆ getKeyboardLayout()

std::string logicalaccess::KeyboardReaderUnitConfiguration::getKeyboardLayout ( ) const

◆ getPrefix()

std::string logicalaccess::KeyboardReaderUnitConfiguration::getPrefix ( ) const

◆ getSuffix()

std::string logicalaccess::KeyboardReaderUnitConfiguration::getSuffix ( ) const

◆ resetConfiguration()

void logicalaccess::KeyboardReaderUnitConfiguration::resetConfiguration ( )
overridevirtual

Reset the configuration to default values.

Implements logicalaccess::ReaderUnitConfiguration.

◆ serialize()

void logicalaccess::KeyboardReaderUnitConfiguration::serialize ( boost::property_tree::ptree &  parentNode)
overridevirtual

Serialize the current object to XML.

Parameters
parentNodeThe parent node.

Implements logicalaccess::XmlSerializable.

◆ setIsDecimalNumber()

void logicalaccess::KeyboardReaderUnitConfiguration::setIsDecimalNumber ( bool  isDecimal)

◆ setKeyboardLayout()

void logicalaccess::KeyboardReaderUnitConfiguration::setKeyboardLayout ( const std::string &  klayout)

◆ setPrefix()

void logicalaccess::KeyboardReaderUnitConfiguration::setPrefix ( const std::string &  prefix)

◆ setSuffix()

void logicalaccess::KeyboardReaderUnitConfiguration::setSuffix ( const std::string &  suffix)

◆ unSerialize()

void logicalaccess::KeyboardReaderUnitConfiguration::unSerialize ( boost::property_tree::ptree &  node)
overridevirtual

UnSerialize a XML node to the current object.

Parameters
nodeThe XML node.

Implements logicalaccess::XmlSerializable.

Member Data Documentation

◆ d_isDecimalNumber

bool logicalaccess::KeyboardReaderUnitConfiguration::d_isDecimalNumber
protected

◆ d_klayout

std::string logicalaccess::KeyboardReaderUnitConfiguration::d_klayout
protected

◆ d_prefix

std::string logicalaccess::KeyboardReaderUnitConfiguration::d_prefix
protected

◆ d_suffix

std::string logicalaccess::KeyboardReaderUnitConfiguration::d_suffix
protected

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