A data clock format class. More...

#include <dataclockformat.hpp>

Inheritance diagram for logicalaccess::DataClockFormat:

Public Member Functions
	DataClockFormat ()
	Constructor.

virtual	~DataClockFormat ()
	Destructor.

unsigned int	getDataLength () const override
	Get the format length in bits.

std::string	getName () const override
	Get the format name.

ByteVector	getLinearData () const override
	Get linear data.

void	setLinearData (const ByteVector &data) override
	Set linear data.

size_t	getFormatLinearData (ByteVector &data) const override
	Get the format linear data in bytes.

void	setFormatLinearData (const ByteVector &data, size_t *indexByte) override
	Set the format linear data in bytes.

FormatType	getType () const override
	Get the format type.

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.

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

Public Member Functions inherited from logicalaccess::StaticFormat
	StaticFormat ()
	Constructor.

virtual	~StaticFormat ()=default

std::shared_ptr< DataRepresentation >	getDataRepresentation () const
	Get the Data Representation for the format.

void	setDataRepresentation (std::shared_ptr< DataRepresentation > &encoding)
	Set the Data Representation for the format.

std::shared_ptr< DataType >	getDataType () const
	Get the Data Type for the format.

void	setDataType (std::shared_ptr< DataType > &encoding)
	Set the Data Type for the format.

unsigned long long	getUid () const
	Get the UID number.

void	setUid (unsigned long long uid)
	Set the UID number.

virtual bool	needUserConfigurationToBeUse () const
	The format need user configuration to be use.

virtual void	convertField (BitsetStream &data, unsigned long long field, unsigned int fieldlen) const
	Convert a field into the configured DataRepresentation and DataType.

unsigned long long	revertField (BitsetStream &data, unsigned int *pos, unsigned int fieldlen) const
	Revert a field using the configured DataRepresentation and DataType.

size_t	getSkeletonLinearData (ByteVector &data) const override
	Get skeleton linear data.

void	setSkeletonLinearData (const ByteVector &data) override
	Set skeleton linear data.

Public Member Functions inherited from logicalaccess::Format
	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 unsigned char	getRightParity (const BitsetStream &data, ParityType type, std::vector< unsigned int > locations)
	Get the Data Clock right parity for a buffer and a location.

static unsigned char	getRightParity1 (const BitsetStream &data)
	Get the 1 Data Clock right parity for a buffer.

static unsigned char	getRightParity2 (const BitsetStream &data)
	Get the 2 Data Clock right parity for a buffer.

static unsigned char	getRightParity3 (const BitsetStream &data)
	Get the 3 Data Clock right parity for a buffer.

static unsigned char	getRightParity4 (const BitsetStream &data)
	Get the 4 Data Clock right parity for a buffer.

Static Public Member Functions inherited from logicalaccess::StaticFormat
static unsigned char	calculateParity (const BitsetStream &data, ParityType parityType, size_t start, size_t parityLengthBits)
	Calculate parity for a block of data.

Static Public Member Functions inherited from logicalaccess::Format
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.

Additional Inherited Members
Protected Member Functions inherited from logicalaccess::StaticFormat
virtual size_t	getFormatLinearData (ByteVector &data) const =0
	Get the format linear data in bytes.

virtual size_t	getEncodingLinearData (ByteVector &data) const
	Get the encoding linear data in bytes (Data Representation and Data Type).

virtual void	setFormatLinearData (const ByteVector &data, size_t *indexByte)=0
	Set the format linear data in bytes.

virtual void	setEncodingLinearData (const ByteVector &data, size_t *indexByte)
	Set the encoding linear data in bytes (Data Representation and Data Type).

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

Protected Attributes inherited from logicalaccess::StaticFormat
std::shared_ptr< DataRepresentation >	d_dataRepresentation
	The Data Representation.

std::shared_ptr< DataType >	d_dataType
	The Data Type.

unsigned long long	d_uid
	The UID number.

Protected Attributes inherited from logicalaccess::Format
std::list< std::shared_ptr< DataField > >	d_fieldList
	The field list.

bool	is_repeatable_

Detailed Description

A data clock format class.

Constructor & Destructor Documentation

◆ DataClockFormat()

logicalaccess::DataClockFormat::DataClockFormat ( )

Constructor.

Create a data clock Format.

◆ ~DataClockFormat()

logicalaccess::DataClockFormat::~DataClockFormat ( )

virtual

Destructor.

Release the data clock Format.

Member Function Documentation

◆ checkSkeleton()

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

overridevirtual

Check the current format skeleton with another format.

Parameters

format The format to check.

Returns: True on success, false otherwise.

Implements logicalaccess::Format.

◆ getDataLength()

unsigned int logicalaccess::DataClockFormat::getDataLength ( ) const

overridevirtual

Get the format length in bits.

Implements logicalaccess::Format.

◆ getDefaultXmlNodeName()

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

overridevirtual

Get the default Xml Node name for this object.

Returns: The Xml node name.

Implements logicalaccess::XmlSerializable.

◆ getFormatLinearData()

size_t logicalaccess::DataClockFormat::getFormatLinearData ( ByteVector & data ) const

overridevirtual

Get the format linear data in bytes.

Parameters

data	The data buffer
dataLengthBytes	The data buffer length

Returns: The format linear data length.

Implements logicalaccess::StaticFormat.

◆ getLinearData()

ByteVector logicalaccess::DataClockFormat::getLinearData ( ) const

overridevirtual

Get linear data.

Parameters

data	Where to put data
dataLengthBytes	Length in byte of data

Implements logicalaccess::Format.

◆ getName()

std::string logicalaccess::DataClockFormat::getName ( ) const

overridevirtual

Get the format name.

Returns: The format name

Implements logicalaccess::Format.

◆ getRightParity()

unsigned char logicalaccess::DataClockFormat::getRightParity	(	const BitsetStream &	data,
		ParityType	type,
		std::vector< unsigned int >	locations
	)

static

Get the Data Clock right parity for a buffer and a location.

Parameters

data	The buffer.
dataLengthBytes	The buffer length in bytes.
type	The parity type.
locations	The buffer containing all the parity mask location.
positionLength	Number of location contains in the locations buffer.

Returns: The parity.

◆ getRightParity1()

unsigned char logicalaccess::DataClockFormat::getRightParity1 ( const BitsetStream & data )

static

Get the 1 Data Clock right parity for a buffer.

Parameters

data	The buffer.
dataLengthBytes	The buffer length in bytes.

Returns: The parity.

◆ getRightParity2()

unsigned char logicalaccess::DataClockFormat::getRightParity2 ( const BitsetStream & data )

static

Get the 2 Data Clock right parity for a buffer.

Parameters

data	The buffer.
dataLengthBytes	The buffer length in bytes.

Returns: The parity.

◆ getRightParity3()

unsigned char logicalaccess::DataClockFormat::getRightParity3 ( const BitsetStream & data )

static

Get the 3 Data Clock right parity for a buffer.

Parameters

data	The buffer.
dataLengthBytes	The buffer length in bytes.

Returns: The parity.

◆ getRightParity4()

unsigned char logicalaccess::DataClockFormat::getRightParity4 ( const BitsetStream & data )

static

Get the 4 Data Clock right parity for a buffer.

Parameters

data	The buffer.
dataLengthBytes	The buffer length in bytes.

Returns: The parity.

◆ getType()

FormatType logicalaccess::DataClockFormat::getType ( ) const

overridevirtual

Get the format type.

Returns: The format type.

Implements logicalaccess::Format.

◆ serialize()

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

overridevirtual

Serialize the current object to XML.

Parameters

parentNode The parent node.

Implements logicalaccess::XmlSerializable.

◆ setFormatLinearData()

void logicalaccess::DataClockFormat::setFormatLinearData	(	const ByteVector &	data,
		size_t *	indexByte
	)

overridevirtual

Set the format linear data in bytes.

Parameters

data	The data buffer
indexByte	The data offset

Implements logicalaccess::StaticFormat.

◆ setLinearData()

void logicalaccess::DataClockFormat::setLinearData ( const ByteVector & data )

overridevirtual

Set linear data.

Parameters

data	Where to get data
dataLengthBytes	Length of data in bytes

Implements logicalaccess::Format.

◆ unSerialize()

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

overridevirtual

UnSerialize a XML node to the current object.

Parameters

node	The XML node.

Implements logicalaccess::XmlSerializable.

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

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

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DataClockFormat()

◆ ~DataClockFormat()

Member Function Documentation

◆ checkSkeleton()

◆ getDataLength()

◆ getDefaultXmlNodeName()

◆ getFormatLinearData()

◆ getLinearData()

◆ getName()

◆ getRightParity()

◆ getRightParity1()

◆ getRightParity2()

◆ getRightParity3()

◆ getRightParity4()

◆ getType()

◆ serialize()

◆ setFormatLinearData()

◆ setLinearData()

◆ unSerialize()