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

A reader memory key storage class. More...

#include <readermemorykeystorage.hpp>

Inheritance diagram for logicalaccess::ReaderMemoryKeyStorage:
logicalaccess::KeyStorage logicalaccess::XmlSerializable

Public Member Functions

 ReaderMemoryKeyStorage ()
 Constructor.
 
virtual ~ReaderMemoryKeyStorage ()=default
 
KeyStorageType getType () const override
 Get the key storage type.
 
void setKeySlot (unsigned char key_slot)
 Set the key slot.
 
unsigned char getKeySlot () const
 Get the key slot.
 
void setVolatile (bool vol)
 Set if the key is stored volatile.
 
bool getVolatile () const
 Set if the key is stored volatile.
 
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.
 
- Public Member Functions inherited from logicalaccess::KeyStorage
virtual ~KeyStorage ()=default
 
virtual KeyStorageType getType () const =0
 Get the key storage type.
 
void serialize (boost::property_tree::ptree &parentNode) override
 Serialize object to Xml Node.
 
void unSerialize (boost::property_tree::ptree &node) override
 UnSerialize object from a Xml Node.
 
std::string getMetadata (const std::string &key)
 
bool hasMetadata (const std::string &key) const
 
void addMetadata (const std::string &key, const std::string &value)
 
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.
 

Protected Attributes

unsigned char d_key_slot
 The key slot.
 
bool d_volatile
 True if the key is stored volatile, false otherwise.
 
- Protected Attributes inherited from logicalaccess::KeyStorage
std::map< std::string, std::string > metadata_
 

Additional Inherited Members

- Static Public Member Functions inherited from logicalaccess::KeyStorage
static std::shared_ptr< KeyStoragegetKeyStorageFromType (KeyStorageType kst)
 Get the key storage instance from a key storage type.
 
- 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

A reader memory key storage class.

Constructor & Destructor Documentation

◆ ReaderMemoryKeyStorage()

logicalaccess::ReaderMemoryKeyStorage::ReaderMemoryKeyStorage ( )

Constructor.

◆ ~ReaderMemoryKeyStorage()

virtual logicalaccess::ReaderMemoryKeyStorage::~ReaderMemoryKeyStorage ( )
virtualdefault

Member Function Documentation

◆ getDefaultXmlNodeName()

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

Get the default Xml Node name for this object.

Returns
The Xml node name.

Implements logicalaccess::XmlSerializable.

◆ getKeySlot()

unsigned char logicalaccess::ReaderMemoryKeyStorage::getKeySlot ( ) const

Get the key slot.

Returns
The key slot.

◆ getType()

KeyStorageType logicalaccess::ReaderMemoryKeyStorage::getType ( ) const
overridevirtual

Get the key storage type.

Returns
The key storage type.

Implements logicalaccess::KeyStorage.

◆ getVolatile()

bool logicalaccess::ReaderMemoryKeyStorage::getVolatile ( ) const

Set if the key is stored volatile.

Returns
True if the key is stored volatile, false otherwise.

◆ serialize()

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

Serialize the current object to XML.

Parameters
parentNodeThe parent node.
Returns
The XML string.

Reimplemented from logicalaccess::KeyStorage.

◆ setKeySlot()

void logicalaccess::ReaderMemoryKeyStorage::setKeySlot ( unsigned char  key_slot)

Set the key slot.

Parameters
key_slotThe key slot.

◆ setVolatile()

void logicalaccess::ReaderMemoryKeyStorage::setVolatile ( bool  vol)

Set if the key is stored volatile.

Parameters
volTrue if the key is stored volatile, false otherwise.

◆ unSerialize()

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

UnSerialize a XML node to the current object.

Parameters
nodeThe XML node.

Reimplemented from logicalaccess::KeyStorage.

Member Data Documentation

◆ d_key_slot

unsigned char logicalaccess::ReaderMemoryKeyStorage::d_key_slot
protected

The key slot.

◆ d_volatile

bool logicalaccess::ReaderMemoryKeyStorage::d_volatile
protected

True if the key is stored volatile, false otherwise.


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