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

A reader format composite class. This is a card format composite associated to a specific reader configuration. More...

#include <readerformatcomposite.hpp>

Inheritance diagram for logicalaccess::ReaderFormatComposite:
logicalaccess::XmlSerializable

Public Member Functions

 ReaderFormatComposite ()
 Constructor.
 
virtual ~ReaderFormatComposite ()
 Destructor.
 
std::shared_ptr< FormatreadFormat () const
 Read format from a card.
 
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::shared_ptr< ReaderConfigurationgetReaderConfiguration () const
 Get the reader configuration.
 
void setReaderConfiguration (std::shared_ptr< ReaderConfiguration > readerConfig)
 
std::shared_ptr< CardsFormatCompositegetCardsFormatComposite () const
 Get the cards format composite.
 
void setCardsFormatComposite (std::shared_ptr< CardsFormatComposite > composite)
 
- 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::shared_ptr< CardsFormatComposited_cardsFormatComposite
 The cards foramt composite.
 
std::shared_ptr< ReaderConfigurationd_readerConfiguration
 The reader 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

A reader format composite class. This is a card format composite associated to a specific reader configuration.

Constructor & Destructor Documentation

◆ ReaderFormatComposite()

logicalaccess::ReaderFormatComposite::ReaderFormatComposite ( )

Constructor.

◆ ~ReaderFormatComposite()

logicalaccess::ReaderFormatComposite::~ReaderFormatComposite ( )
virtual

Destructor.

Member Function Documentation

◆ getCardsFormatComposite()

std::shared_ptr< CardsFormatComposite > logicalaccess::ReaderFormatComposite::getCardsFormatComposite ( ) const

Get the cards format composite.

Returns
The cards foramt composite.

◆ getDefaultXmlNodeName()

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

Get the default Xml Node name for this object.

Returns
The Xml node name.

Implements logicalaccess::XmlSerializable.

◆ getReaderConfiguration()

std::shared_ptr< ReaderConfiguration > logicalaccess::ReaderFormatComposite::getReaderConfiguration ( ) const

Get the reader configuration.

Returns
The reader configuration.

◆ readFormat()

std::shared_ptr< Format > logicalaccess::ReaderFormatComposite::readFormat ( ) const

Read format from a card.

Returns
The format.

◆ serialize()

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

Serialize the current object to XML.

Parameters
parentNodeThe parent node.

Implements logicalaccess::XmlSerializable.

◆ setCardsFormatComposite()

void logicalaccess::ReaderFormatComposite::setCardsFormatComposite ( std::shared_ptr< CardsFormatComposite composite)

◆ setReaderConfiguration()

void logicalaccess::ReaderFormatComposite::setReaderConfiguration ( std::shared_ptr< ReaderConfiguration readerConfig)

◆ unSerialize()

void logicalaccess::ReaderFormatComposite::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_cardsFormatComposite

std::shared_ptr<CardsFormatComposite> logicalaccess::ReaderFormatComposite::d_cardsFormatComposite
protected

The cards foramt composite.

◆ d_readerConfiguration

std::shared_ptr<ReaderConfiguration> logicalaccess::ReaderFormatComposite::d_readerConfiguration
protected

The reader configuration.


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