Leonardus: SOD Class Reference

Semantic Object Dictionary. More...

#include <sod.h>

Inheritance diagram for SOD:

Collaboration diagram for SOD:

Classes
struct	SODMap
	Semantic Object Dictionary - map member class. More...

Public Member Functions
	SOD ()
	Ctor.

SOD *	dup () const override
	Creates a new instance as copy following the red book definition. More...

SOD *	clone () const override
	Creates a new instance as copy with deep cloning. More...

std::string	opequalequal () const override
	For operators '==' and 'pstack'. More...

OTCode	ot () const override
	Returns an OTCode. More...

std::string	type () const override
	Returns a type name. More...

bool	equal (const SO *p_other) const override
	Equality. More...

size_t	getSize () const override
	Getter for the number of characters or number of objects. More...

size_t	treeheight (size_t p_myheight) const override
	Tree Height. More...

auto	begin ()
	Returns an iterator to the begin of the map of two SOps.

auto	end ()
	Returns an iterator to the marker at end of the map of two SOps.

void	insert (SOp p_key, SOp p_value, bool p_forcebegin=false)
	Insert with the red book definition of equal. More...

SOp	find (const SO *p_key) const
	Searches for p_key in the dictionary. More...

auto	any_pop ()
	Returns a pair from the dictionary. More...

void	undef (const SO *p_key)
	Removes both p_key and its value from the dictionary. More...

Public Member Functions inherited from SOcomposite
std::string	opequal () const override
	For operators '=', 'cvs' and 'stack'. More...

virtual size_t	treeheight (size_t p_myheigth) const
	Tree Height. More...

	SO (bool p_exec=false)
	Ctor.

Public Member Functions inherited from SO
	SO (bool p_exec=false)
	Ctor.

virtual	~SO ()=default
	Virtual dtor. More...

bool	getExec () const
	Getter for exec_.

void	setExec (bool p_exec)
	Setter for exec_.

virtual size_t	getSize () const
	Getter for the number of characters or number of objects. More...

virtual SO *	dup () const =0
	Creates a new instance as copy following the red book definition. More...

virtual SO *	clone () const
	Creates a new instance as copy with deep cloning. More...

virtual std::string	opequal () const =0
	For operators '=', 'cvs' and 'stack'. More...

virtual std::string	opequalequal () const
	For operators '==' and 'pstack'. More...

virtual OTCode	ot () const =0
	Returns an OTCode. More...

virtual std::string	type () const =0
	Returns a type name. More...

virtual bool	equal (const SO *) const =0
	Equality. More...

virtual bool	gt (const SO *) const
	Greater than. More...

virtual bool	ge (const SO *) const
	Greater or equal. More...

Public Member Functions inherited from Counter< SO >
	Counter (Counter< SO > &&)=delete

Counter< SO > &	operator= (const Counter< SO > &)=delete

Counter< SO > &	operator= (Counter< SO > &&)=delete

Protected Member Functions
bool	invariant () const noexcept override
	Checks class invariants. More...

Protected Member Functions inherited from Counter< SO >
	Counter ()
	Ctor.

	Counter (const Counter< SO > &)
	Copy ctor.

	~Counter ()
	Dtor.

virtual bool	invariant () const noexcept
	Checks the invariants of the class in which it is defined. More...

Private Attributes
std::shared_ptr< SODMap >	map_
	The shared dictionary.

Additional Inherited Members
Static Public Member Functions inherited from Counter< SO >
static size_t	getTotalCounter ()
	Static getter for totaly created objects.

static size_t	getAliveCounter ()
	Static getter for objects alive.

static size_t	getWatermarkCounter ()
	Static getter for the object counter watermark.

Detailed Description

Semantic Object Dictionary.

Invariant: map_ never is null.; map_.stlmap_ elements are never null

Member Function Documentation

◆ any_pop()

auto SOD::any_pop ( )

inline

Returns a pair from the dictionary.

Precondition: getSize() > 0

◆ clone()

SOD * SOD::clone ( ) const

overridevirtual

Creates a new instance as copy with deep cloning.

Postcondition: return value != nullptr; return value maintains invariants

Reimplemented from SO.

◆ dup()

SOD * SOD::dup ( ) const

inlineoverridevirtual

Creates a new instance as copy following the red book definition.

Implements SO.

◆ equal()

bool SOD::equal ( const SO * ) const

inlineoverridevirtual

Equality.

Equality means: SOL und SOM are always equal.
For SOD and SOK, share_ptr<> points to the same object.
For SOA, share_ptr<> points to the same object, but empty arrays are equal nonetheless.
For SOO and SOo the function pointer must be the same.
Otherwise the value must be the same, even for SOS with shared_ptr<>.

Returns: bool ... true if the SO's are of the same type and equal

See also: Will be used directly and unchanged as operator eq

Implements SO.

◆ find()

SOp SOD::find ( const SO * p_key ) const

Searches for p_key in the dictionary.

Equality is defined by SO::equal().

Returns: SOp ... a SOp to the value, the ownership stays within the dictionary; a nullptr if not found

Precondition: p_key != nullptr

◆ getSize()

size_t SOD::getSize ( ) const

inlineoverridevirtual

Getter for the number of characters or number of objects.

Reimplemented from SO.

◆ insert()

void SOD::insert	(	SOp	p_key,
		SOp	p_value,
		bool	p_forcebegin = `false`
	)

Insert with the red book definition of equal.

The SOD takes ownership. If the key is found in the dictionary, then this existing key and the corresponding value will be deleted.

Parameters

[in]	p_key	Key.
[in]	p_value	Value.
[in]	p_forcebegin	This parameter forces the insertion of the key-value pair at the beginning of the dictionary.

Precondition: p_key != nullptr and p_value != nullptr

◆ invariant()

bool SOD::invariant ( ) const

inlineoverrideprotectedvirtualnoexcept

Checks class invariants.

Returns: bool ... Indicates whether the class invariants are maintained.

Reimplemented from DbC.

◆ opequalequal()

string SOD::opequalequal ( ) const

overridevirtual

For operators '==' and 'pstack'.

This function attempts to produce a result that resembles the red book syntax for creating the object.

Reimplemented from SO.

◆ ot()

OTCode SOD::ot ( ) const

inlineoverridevirtual

Returns an OTCode.

A "manual" implementation of polymorphism, where C++-polymorphisms fail

Returns: OTCode ... The OTCode of the instance.

Implements SO.

◆ treeheight()

size_t SOD::treeheight ( size_t p_myheigth ) const

overridevirtual

Tree Height.

The composite semantic objects can contain other composite semantic objects.
This creates a tree of objects. treeheigth() calculates the height of this tree
starting at this.

Loops will be dedected by an heuristics. We stop the recursion if the heigth exceeds
maxtreeheight.

Parameters

[in] p_myheigth ... Call with value 0. Used internally for recursion.

Returns: size_t ... The maximum height of the tree of SOcomposite -or- maxtreeheight if there is a loop.

Reimplemented from SOcomposite.

◆ type()

std::string SOD::type ( ) const

inlineoverridevirtual

Returns a type name.

Returns: std::string ... The type name of the instance.

Implements SO.

◆ undef()

void SOD::undef ( const SO * p_key )

Removes both p_key and its value from the dictionary.

Equality is defined by SO::equal(). Doesn't generate a error if p_key can not be found.

Precondition: p_key != nullptr

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

Classes

Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ any_pop()

◆ clone()

◆ dup()

◆ equal()

◆ find()

◆ getSize()

◆ insert()

◆ invariant()

◆ opequalequal()

◆ ot()

◆ treeheight()

◆ type()

◆ undef()