#include <format.hpp>

Inheritance diagram for logicalaccess::Format:

Public Member Functions
	Format ()
	Constructor.

	Format (const Format &other)=delete
	Remove copy.

Format &	operator= (const Format &)=delete

virtual	~Format ()=default

virtual unsigned int	getDataLength () const =0
	Get data length in bits.

virtual std::string	getName () const =0
	Get the format name.

virtual ByteVector	getLinearData () const =0
	Get linear data.

virtual void	setLinearData (const ByteVector &data)=0
	Set linear data.

virtual size_t	getSkeletonLinearData (ByteVector &data) const =0
	Get skeleton linear data.

virtual void	setSkeletonLinearData (const ByteVector &data)=0
	Set skeleton linear data.

virtual FormatType	getType () const =0
	Get the format type.

virtual std::vector< std::string >	getValuesFieldList () const
	Get values field list.

virtual unsigned int	getFieldLength (const std::string &field) const
	Get the field length.

virtual bool	checkSkeleton (std::shared_ptr< Format > format) const =0
	Check the current format skeleton with another format.

virtual ByteVector	getIdentifier ()
	Get the identifier.

virtual std::vector< std::shared_ptr< DataField > >	getFieldList ()
	Get the format field list.

virtual void	setFieldList (std::vector< std::shared_ptr< DataField > > fields)
	Get the format field list.

std::shared_ptr< DataField >	getFieldFromName (std::string field) const
	Get the field object from name.

bool	isRepeatable () const

void	setRepeatable (bool v)

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.

Static Public Member Functions
static std::shared_ptr< Format >	getByFormatType (FormatType type)
	Get a new format instance from a format type.

static unsigned char	calculateParity (const BitsetStream &data, ParityType parityType, std::vector< unsigned int > positions)
	Calculate parity for a block of data.

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.

Protected Attributes
std::list< std::shared_ptr< DataField > >	d_fieldList
	The field list.

bool	is_repeatable_

Additional Inherited Members
Static Protected Member Functions inherited from logicalaccess::XmlSerializable
static unsigned long long	atoull (const std::string &str)

Detailed Description

A format.

Constructor & Destructor Documentation

◆ Format() [1/2]

logicalaccess::Format::Format ( )

Constructor.

Create a Format.

◆ Format() [2/2]

logicalaccess::Format::Format ( const Format & other )

delete

Remove copy.

◆ ~Format()

virtual logicalaccess::Format::~Format ( )

virtualdefault

Member Function Documentation

◆ calculateParity()

unsigned char logicalaccess::Format::calculateParity	(	const BitsetStream &	data,
		ParityType	parityType,
		std::vector< unsigned int >	positions
	)

static

Calculate parity for a block of data.

Parameters

data	Data block
dataLengthBytes	Length of data in bytes
parityType	Parity type
positions	List of positions to calculate parity
nbPositions	Number of parity in the list

Returns: The parity.

◆ checkSkeleton()

virtual bool logicalaccess::Format::checkSkeleton ( std::shared_ptr< Format > format ) const

pure virtual

Check the current format skeleton with another format.

Parameters

format The format to check.

Returns: True on success, false otherwise.

◆ getByFormatType()

std::shared_ptr< Format > logicalaccess::Format::getByFormatType ( FormatType type )

static

Get a new format instance from a format type.

Parameters

type	The format type.

Returns: The new format instance.

◆ getDataLength()

virtual unsigned int logicalaccess::Format::getDataLength ( ) const

pure virtual

Get data length in bits.

Returns: The data length in bits.

Implemented in logicalaccess::ASCIIFormat, logicalaccess::BariumFerritePCSCFormat, logicalaccess::CustomFormat, logicalaccess::DataClockFormat, logicalaccess::FASCN200BitFormat, logicalaccess::Getronik40BitFormat, logicalaccess::HIDHoneywell40BitFormat, logicalaccess::RawFormat, logicalaccess::Wiegand26Format, logicalaccess::Wiegand34Format, logicalaccess::Wiegand35Format, logicalaccess::Wiegand37Format, and logicalaccess::Wiegand37WithFacilityRightParity2Format.

◆ getFieldFromName()

std::shared_ptr< DataField > logicalaccess::Format::getFieldFromName ( std::string field ) const

Get the field object from name.

◆ getFieldLength()

unsigned int logicalaccess::Format::getFieldLength ( const std::string & field ) const

virtual

Get the field length.

Parameters

field The field.

Returns: The field length.

Reimplemented in logicalaccess::RawFormat.

◆ getFieldList()

std::vector< std::shared_ptr< DataField > > logicalaccess::Format::getFieldList ( )

virtual

Get the format field list.

Returns: The field list.

◆ getIdentifier()

ByteVector logicalaccess::Format::getIdentifier ( )

virtual

Get the identifier.

Returns: The identifier.

◆ getLinearData()

virtual ByteVector logicalaccess::Format::getLinearData ( ) const

pure virtual

Get linear data.

Parameters

data	Where to put data
dataLengthBytes	Length in byte of data

Implemented in logicalaccess::ASCIIFormat, logicalaccess::BariumFerritePCSCFormat, logicalaccess::CustomFormat, logicalaccess::DataClockFormat, logicalaccess::FASCN200BitFormat, logicalaccess::Getronik40BitFormat, logicalaccess::HIDHoneywell40BitFormat, logicalaccess::RawFormat, logicalaccess::Wiegand35Format, logicalaccess::Wiegand37WithFacilityRightParity2Format, and logicalaccess::WiegandFormat.

◆ getName()

virtual std::string logicalaccess::Format::getName ( ) const

pure virtual

Get the format name.

Returns: The format name.

◆ getSkeletonLinearData()

virtual size_t logicalaccess::Format::getSkeletonLinearData ( ByteVector & data ) const

pure virtual

Get skeleton linear data.

Parameters

data	Where to put data
dataLengthBytes	Length in byte of data

Implemented in logicalaccess::CustomFormat, and logicalaccess::StaticFormat.

◆ getType()

virtual FormatType logicalaccess::Format::getType ( ) const

pure virtual

Get the format type.

Returns: The format type.

◆ getValuesFieldList()

std::vector< std::string > logicalaccess::Format::getValuesFieldList ( ) const

virtual

Get values field list.

Returns: The values field list.

◆ isRepeatable()

bool logicalaccess::Format::isRepeatable ( ) const

◆ operator=()

Format & logicalaccess::Format::operator= ( const Format & )

delete

◆ setFieldList()

void logicalaccess::Format::setFieldList ( std::vector< std::shared_ptr< DataField > > fields )

virtual

Get the format field list.

Parameters

fields The field list.

◆ setLinearData()

virtual void logicalaccess::Format::setLinearData ( const ByteVector & data )

pure virtual

Set linear data.

Parameters

data	Where to get data
dataLengthBytes	Length of data in bytes

Implemented in logicalaccess::ASCIIFormat, logicalaccess::BariumFerritePCSCFormat, logicalaccess::CustomFormat, logicalaccess::DataClockFormat, logicalaccess::FASCN200BitFormat, logicalaccess::Getronik40BitFormat, logicalaccess::HIDHoneywell40BitFormat, logicalaccess::RawFormat, logicalaccess::Wiegand35Format, logicalaccess::Wiegand37WithFacilityRightParity2Format, and logicalaccess::WiegandFormat.

◆ setRepeatable()

void logicalaccess::Format::setRepeatable ( bool v )

◆ setSkeletonLinearData()

virtual void logicalaccess::Format::setSkeletonLinearData ( const ByteVector & data )

pure virtual

Set skeleton linear data.

Parameters

data	Where to get data
dataLengthBytes	Length in byte of data

Implemented in logicalaccess::CustomFormat, and logicalaccess::StaticFormat.

Member Data Documentation

◆ d_fieldList

std::list<std::shared_ptr<DataField> > logicalaccess::Format::d_fieldList

protected

The field list.

◆ is_repeatable_

bool logicalaccess::Format::is_repeatable_

protected

If true, we expect the format to be concatenated multiple time in a single Location.

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

C:/dev/lla/liblogicalaccess/include/logicalaccess/services/accesscontrol/formats/format.hpp
C:/dev/lla/liblogicalaccess/src/services/accesscontrol/formats/format.cpp

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Format() [1/2]

◆ Format() [2/2]

◆ ~Format()

Member Function Documentation

◆ calculateParity()

◆ checkSkeleton()

◆ getByFormatType()

◆ getDataLength()

◆ getFieldFromName()

◆ getFieldLength()

◆ getFieldList()

◆ getIdentifier()

◆ getLinearData()

◆ getName()

◆ getSkeletonLinearData()

◆ getType()

◆ getValuesFieldList()

◆ isRepeatable()

◆ operator=()

◆ setFieldList()

◆ setLinearData()

◆ setRepeatable()

◆ setSkeletonLinearData()

Member Data Documentation

◆ d_fieldList

◆ is_repeatable_