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

#include <dummydatatransport.hpp>

Inheritance diagram for logicalaccess::DummyDataTransport:
logicalaccess::DataTransport logicalaccess::XmlSerializable

Public Member Functions

std::string getTransportType () const override
 Get the transport type of this instance.
 
bool connect () override
 Connect to the transport layer.
 
void disconnect () override
 Disconnect from the transport layer.
 
bool isConnected () override
 
std::string getName () const override
 Get the data transport endpoint name.
 
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 getDefaultXmlNodeName () const override
 Get the default Xml Node name for this object.
 
- Public Member Functions inherited from logicalaccess::DataTransport
virtual ~DataTransport ()=default
 
virtual std::shared_ptr< ReaderUnitgetReaderUnit () const
 Get the reader unit.
 
virtual void setReaderUnit (std::weak_ptr< ReaderUnit > unit)
 Set the reader unit.
 
virtual std::string getTransportType () const =0
 Get the transport type of this instance.
 
virtual bool connect ()=0
 Connect to the transport layer.
 
virtual void disconnect ()=0
 Disconnect from the transport layer.
 
virtual bool isConnected ()=0
 
virtual std::string getName () const =0
 Get the data transport endpoint name.
 
virtual ByteVector sendCommand (const ByteVector &command, long int timeout=-1)
 Send a command to the reader.
 
virtual ByteVector getLastCommand ()
 Get the last command.
 
virtual ByteVector getLastResult ()
 Get the last command result.
 
- 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 Member Functions

void send (const ByteVector &data) override
 
ByteVector receive (long int timeout) override
 
virtual void send (const ByteVector &data)=0
 
virtual ByteVector receive (long int timeout)=0
 

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)
 
- Protected Attributes inherited from logicalaccess::DataTransport
std::weak_ptr< ReaderUnitd_ReaderUnit
 The reader unit.
 
ByteVector d_lastResult
 The last result.
 
ByteVector d_lastCommand
 The last command.
 

Detailed Description

A dummy DataTransport whose whole point is to allow extension from C#.

See DummyReaderUnit.

Member Function Documentation

◆ connect()

bool logicalaccess::DummyDataTransport::connect ( )
overridevirtual

Connect to the transport layer.

Returns
True on success, false otherwise.

Implements logicalaccess::DataTransport.

◆ disconnect()

void logicalaccess::DummyDataTransport::disconnect ( )
overridevirtual

Disconnect from the transport layer.

Implements logicalaccess::DataTransport.

◆ getDefaultXmlNodeName()

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

Get the default Xml Node name for this object.

Returns
The Xml node name.

Implements logicalaccess::XmlSerializable.

◆ getName()

std::string logicalaccess::DummyDataTransport::getName ( ) const
overridevirtual

Get the data transport endpoint name.

Returns
The data transport endpoint name.

Implements logicalaccess::DataTransport.

◆ getTransportType()

std::string logicalaccess::DummyDataTransport::getTransportType ( ) const
overridevirtual

Get the transport type of this instance.

Returns
The transport type.

Implements logicalaccess::DataTransport.

◆ isConnected()

bool logicalaccess::DummyDataTransport::isConnected ( )
overridevirtual

\briaf Get if connected to the transport layer.

Returns
True if connected, false otherwise.

Implements logicalaccess::DataTransport.

◆ receive()

ByteVector logicalaccess::DummyDataTransport::receive ( long int  timeout)
overrideprotectedvirtual

◆ send()

void logicalaccess::DummyDataTransport::send ( const ByteVector data)
overrideprotectedvirtual

◆ serialize()

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

Serialize object to Xml Node.

Parameters
osThe XML stream.

Implements logicalaccess::XmlSerializable.

◆ unSerialize()

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

UnSerialize object from a Xml Node.

Parameters
nodeThe Xml node.

Implements logicalaccess::XmlSerializable.


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