A reader configuration class. Contains the reader provider and selected reader unit. More...

#include <readerconfiguration.hpp>

Inheritance diagram for logicalaccess::ReaderConfiguration:

Public Member Functions
	ReaderConfiguration ()
	Constructor.

virtual	~ReaderConfiguration ()
	Destructor.

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< ReaderProvider >	getReaderProvider () const
	Get the reader provider.

std::shared_ptr< ReaderUnit >	getReaderUnit () const
	Get the reader unit.

void	setReaderProvider (std::shared_ptr< ReaderProvider > provider)

void	setReaderUnit (std::shared_ptr< ReaderUnit > unit)

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
std::shared_ptr< ReaderProvider >	d_readerProvider
	The reader provider.

std::shared_ptr< ReaderUnit >	d_ReaderUnit
	The reader unit.

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 configuration class. Contains the reader provider and selected reader unit.

Constructor & Destructor Documentation

◆ ReaderConfiguration()

logicalaccess::ReaderConfiguration::ReaderConfiguration ( )

Constructor.

◆ ~ReaderConfiguration()

logicalaccess::ReaderConfiguration::~ReaderConfiguration ( )

virtual

Destructor.

Member Function Documentation

◆ getDefaultXmlNodeName()

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

overridevirtual

Get the default Xml Node name for this object.

Returns: The Xml node name.

Implements logicalaccess::XmlSerializable.

◆ getReaderProvider()

std::shared_ptr< ReaderProvider > logicalaccess::ReaderConfiguration::getReaderProvider ( ) const

Get the reader provider.

Returns: The reader provider.

◆ getReaderUnit()

std::shared_ptr< ReaderUnit > logicalaccess::ReaderConfiguration::getReaderUnit ( ) const

Get the reader unit.

Returns: The reader unit.

◆ serialize() [1/3]

std::string logicalaccess::XmlSerializable::serialize ( )

virtual

Serialize object to Xml Node string.

Returns: The serialized object.

Reimplemented from logicalaccess::XmlSerializable.

◆ serialize() [2/3]

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

overridevirtual

Serialize the current object to XML.

Parameters

parentNode The parent node.

Implements logicalaccess::XmlSerializable.

◆ serialize() [3/3]

virtual void logicalaccess::XmlSerializable::serialize ( boost::property_tree::ptree & parentNode )

virtual

Serialize object to Xml Node.

Parameters

os	The XML stream.

Implements logicalaccess::XmlSerializable.

◆ setReaderProvider()

void logicalaccess::ReaderConfiguration::setReaderProvider ( std::shared_ptr< ReaderProvider > provider )

◆ setReaderUnit()

void logicalaccess::ReaderConfiguration::setReaderUnit ( std::shared_ptr< ReaderUnit > unit )

◆ unSerialize() [1/5]

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

overridevirtual

UnSerialize a XML node to the current object.

Parameters

node	The XML node.

Implements logicalaccess::XmlSerializable.

◆ unSerialize() [2/5]

virtual void logicalaccess::XmlSerializable::unSerialize ( boost::property_tree::ptree & node )

virtual

UnSerialize object from a Xml Node.

Parameters

node	The Xml node.

Implements logicalaccess::XmlSerializable.

◆ unSerialize() [3/5]

void logicalaccess::XmlSerializable::unSerialize	(	boost::property_tree::ptree &	node,
		const std::string &	rootNode
	)

virtual

UnSerialize object from a Xml node.

Parameters

node	The Xml node.
rootNode	The root node.

Returns: True on success, false otherwise.

Reimplemented from logicalaccess::XmlSerializable.

◆ unSerialize() [4/5]

void logicalaccess::XmlSerializable::unSerialize	(	const std::string &	xmlstring,
		const std::string &	rootNode
	)

virtual

UnSerialize object from a Xml Node string.

Parameters

xmlstring	The Xml Node string.
rootNode	The root node.

Returns: True on success, false otherwise.

Reimplemented from logicalaccess::XmlSerializable.

◆ unSerialize() [5/5]

void logicalaccess::XmlSerializable::unSerialize	(	std::istream &	is,
		const std::string &	rootNode
	)

virtual

UnSerialize object from a Xml node.

Parameters

is	The Xml stream.
rootNode	The root node.

Returns: True on success, false otherwise.

Reimplemented from logicalaccess::XmlSerializable.

Member Data Documentation

◆ d_readerProvider

std::shared_ptr<ReaderProvider> logicalaccess::ReaderConfiguration::d_readerProvider

protected

The reader provider.

◆ d_ReaderUnit

std::shared_ptr<ReaderUnit> logicalaccess::ReaderConfiguration::d_ReaderUnit

protected

The reader unit.

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

C:/dev/lla/liblogicalaccess/include/logicalaccess/readerproviders/readerconfiguration.hpp
C:/dev/lla/liblogicalaccess/src/readerproviders/readerconfiguration.cpp

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ReaderConfiguration()

◆ ~ReaderConfiguration()

Member Function Documentation

◆ getDefaultXmlNodeName()

◆ getReaderProvider()

◆ getReaderUnit()

◆ serialize() [1/3]

◆ serialize() [2/3]

◆ serialize() [3/3]

◆ setReaderProvider()

◆ setReaderUnit()

◆ unSerialize() [1/5]

◆ unSerialize() [2/5]

◆ unSerialize() [3/5]

◆ unSerialize() [4/5]

◆ unSerialize() [5/5]

Member Data Documentation

◆ d_readerProvider

◆ d_ReaderUnit