A location node description. This describe a location on a hierachical view. More...

#include <locationnode.hpp>

Public Member Functions
	LocationNode ()
	Constructor.

virtual	~LocationNode ()
	Destructor.

void	setName (const std::string &name)
	Set the node name.

std::string	getName () const
	Get the node name.

std::vector< std::shared_ptr< LocationNode > > &	getChildrens ()
	Get the childrens node.

void	setParent (std::weak_ptr< LocationNode > parent)
	Set the parent node.

std::shared_ptr< LocationNode >	getParent () const
	Get the parent node.

void	setNeedAuthentication (bool needed)
	Set if authentication is needed.

bool	getNeedAuthentication () const
	Get if authentication is needed.

void	setHasProperties (bool hasProperties)
	Set if the node has properties.

bool	getHasProperties () const
	Get if the node has properties.

void	setLength (size_t length)
	Set the node length.

size_t	getLength () const
	Get the node length.

void	setLocation (std::shared_ptr< Location > location)
	Set the associated location.

std::shared_ptr< Location >	getLocation () const
	Get the associated location.

void	setUnit (size_t unit)
	Set the byte unit.

size_t	getUnit () const
	Get the byte unit.

void	setCanRead (bool can)
	Set if read is possible.

bool	getCanRead () const
	Get if read is possible.

void	setCanWrite (bool can)
	Set if write is possible.

bool	getCanWrite () const
	Get if write is possible.

Protected Attributes
std::vector< std::shared_ptr< LocationNode > >	d_childrens
	The childrens node.

std::weak_ptr< LocationNode >	d_parent
	The parent node.

bool	d_needAuthentication
	Need authentication to access the node data.

bool	d_hasProperties
	The node has properties or not.

size_t	d_length
	The data node length.

std::string	d_name
	The current location node name.

std::shared_ptr< Location >	d_location
	The associated location.

size_t	d_unit
	The byte unit.

bool	d_can_read
	Read capability.

bool	d_can_write
	Write capability.

Detailed Description

A location node description. This describe a location on a hierachical view.

Constructor & Destructor Documentation

◆ LocationNode()

logicalaccess::LocationNode::LocationNode ( )

Constructor.

◆ ~LocationNode()

logicalaccess::LocationNode::~LocationNode ( )

virtual

Destructor.

Member Function Documentation

◆ getCanRead()

bool logicalaccess::LocationNode::getCanRead ( ) const

Get if read is possible.

Returns: True if read is possible, false otherwise.

◆ getCanWrite()

bool logicalaccess::LocationNode::getCanWrite ( ) const

Get if write is possible.

Returns: True if write is possible, false otherwise.

◆ getChildrens()

std::vector< std::shared_ptr< LocationNode > > & logicalaccess::LocationNode::getChildrens ( )

Get the childrens node.

Returns: The childrens node.

◆ getHasProperties()

bool logicalaccess::LocationNode::getHasProperties ( ) const

Get if the node has properties.

Returns: True if the node has properties, false otherwise.

◆ getLength()

size_t logicalaccess::LocationNode::getLength ( ) const

Get the node length.

Returns: The node length.

◆ getLocation()

std::shared_ptr< Location > logicalaccess::LocationNode::getLocation ( ) const

Get the associated location.

Returns: The associated location.

◆ getName()

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

Get the node name.

Returns: The node name.

◆ getNeedAuthentication()

bool logicalaccess::LocationNode::getNeedAuthentication ( ) const

Get if authentication is needed.

Returns: True if authentication is needed, false otherwise.

◆ getParent()

std::shared_ptr< LocationNode > logicalaccess::LocationNode::getParent ( ) const

Get the parent node.

Returns: The parent node.

◆ getUnit()

size_t logicalaccess::LocationNode::getUnit ( ) const

Get the byte unit.

Returns: The byte unit.

◆ setCanRead()

void logicalaccess::LocationNode::setCanRead ( bool can )

Set if read is possible.

Parameters

can	True if read is possible, false otherwise.

◆ setCanWrite()

void logicalaccess::LocationNode::setCanWrite ( bool can )

Set if write is possible.

Parameters

can	True if write is possible, false otherwise.

◆ setHasProperties()

void logicalaccess::LocationNode::setHasProperties ( bool hasProperties )

Set if the node has properties.

Parameters

hasProperties The node has properties or not.

◆ setLength()

void logicalaccess::LocationNode::setLength ( size_t length )

Set the node length.

Parameters

length The node length.

◆ setLocation()

void logicalaccess::LocationNode::setLocation ( std::shared_ptr< Location > location )

Set the associated location.

Parameters

location The associated location.

◆ setName()

void logicalaccess::LocationNode::setName ( const std::string & name )

Set the node name.

Parameters

name	The node name.

◆ setNeedAuthentication()

void logicalaccess::LocationNode::setNeedAuthentication ( bool needed )

Set if authentication is needed.

Parameters

needed Authentication needed.

◆ setParent()

void logicalaccess::LocationNode::setParent ( std::weak_ptr< LocationNode > parent )

Set the parent node.

Parameters

parent The parent node.

◆ setUnit()

void logicalaccess::LocationNode::setUnit ( size_t unit )

Set the byte unit.

Parameters

unit	The byte unit.

Member Data Documentation

◆ d_can_read

bool logicalaccess::LocationNode::d_can_read

protected

Read capability.

◆ d_can_write

bool logicalaccess::LocationNode::d_can_write

protected

Write capability.

◆ d_childrens

std::vector<std::shared_ptr<LocationNode> > logicalaccess::LocationNode::d_childrens

protected

The childrens node.

◆ d_hasProperties

bool logicalaccess::LocationNode::d_hasProperties

protected

The node has properties or not.

◆ d_length

size_t logicalaccess::LocationNode::d_length

protected

The data node length.

◆ d_location

std::shared_ptr<Location> logicalaccess::LocationNode::d_location

protected

The associated location.

◆ d_name

std::string logicalaccess::LocationNode::d_name

protected

The current location node name.

◆ d_needAuthentication

bool logicalaccess::LocationNode::d_needAuthentication

protected

Need authentication to access the node data.

◆ d_parent

std::weak_ptr<LocationNode> logicalaccess::LocationNode::d_parent

protected

The parent node.

◆ d_unit

size_t logicalaccess::LocationNode::d_unit

protected

The byte unit.

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

C:/dev/lla/liblogicalaccess/include/logicalaccess/cards/locationnode.hpp
C:/dev/lla/liblogicalaccess/src/cards/locationnode.cpp

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ LocationNode()

◆ ~LocationNode()

Member Function Documentation

◆ getCanRead()

◆ getCanWrite()

◆ getChildrens()

◆ getHasProperties()

◆ getLength()

◆ getLocation()

◆ getName()

◆ getNeedAuthentication()

◆ getParent()

◆ getUnit()

◆ setCanRead()

◆ setCanWrite()

◆ setHasProperties()

◆ setLength()

◆ setLocation()

◆ setName()

◆ setNeedAuthentication()

◆ setParent()

◆ setUnit()

Member Data Documentation

◆ d_can_read

◆ d_can_write

◆ d_childrens

◆ d_hasProperties

◆ d_length

◆ d_location

◆ d_name

◆ d_needAuthentication

◆ d_parent

◆ d_unit