Kryptostack: SOS Class Reference

Semantic Object String. More...

#include <socomp.h>

Inheritance diagram for SOS:

Collaboration diagram for SOS:

Public Member Functions
	SOS (const std::string &p_str)
	Ctor.

std::string	getString () const
	Getter for the string value.

void	setch (size_t p_index, int p_char)
	Sets a single character within the string. More...

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

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

std::string	opequal () const override
	For operators '=', 'cvs' and 'stack'. 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...

bool	gt (const SO *p_other) const override
	Greater than. More...

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

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

void	erase0 ()
	Erases the fist character of the String.

void	replace (size_t p_pos, const std::string &p_src)
	Replaces characters at position p_pos. More...

Public Member Functions inherited from SOcomp
std::string	opequal () const override
	For operators '=', 'cvs' and 'stack'. 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< std::string >	str_
	The string value.

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

static int	getAliveCounter ()
	Static getter for objects alive.

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

Detailed Description

Semantic Object String.

Invariant: shared pointer is not null.

Member Function Documentation

◆ clone()

SOS * SOS::clone ( ) const

inlineoverridevirtual

Creates a new instance as copy with deep cloning.

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

Reimplemented from SO.

◆ dup()

SOS * SOS::dup ( ) const

inlineoverridevirtual

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

Implements SO.

◆ equal()

bool SOS::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.

◆ ge()

bool SOS::ge ( const SO * ) const

inlineoverridevirtual

Greater or equal.

Will be overwritten for SOI, SOR and SOS. The redundancy between equal(), gt() and ge() ist a matter of performance.

Reimplemented from SO.

◆ getSize()

size_t SOS::getSize ( ) const

inlineoverridevirtual

Getter for the number of characters or number of objects.

Reimplemented from SO.

◆ gt()

bool SOS::gt ( const SO * ) const

inlineoverridevirtual

Greater than.

Will be overwritten for SOI, SOR and SOS. The redundancy between equal(), gt() and ge() ist a matter of performance.

Reimplemented from SO.

◆ invariant()

bool SOS::invariant ( ) const

inlineoverrideprotectedvirtualnoexcept

Checks class invariants.

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

Reimplemented from DbC.

◆ opequal()

std::string SOS::opequal ( ) const

inlineoverridevirtual

For operators '=', 'cvs' and 'stack'.

Reimplemented from SOcomp.

◆ opequalequal()

std::string SOS::opequalequal ( ) const

inlineoverridevirtual

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 SOS::ot ( ) const

inlineoverridevirtual

Returns an OTCode.

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

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

Implements SO.

◆ replace()

void SOS::replace	(	size_t	p_pos,
		const std::string &	p_src
	)

inline

Replaces characters at position p_pos.

Precondition: p_pos+p_src.size() <= this->size()

◆ setch()

void SOS::setch	(	size_t	p_index,
		int	p_char
	)

Sets a single character within the string.

Precondition: p_index < stringsize

◆ type()

std::string SOS::type ( ) const

inlineoverridevirtual

Returns a type name.

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

Implements SO.

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

Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ clone()

◆ dup()

◆ equal()

◆ ge()

◆ getSize()

◆ gt()

◆ invariant()

◆ opequal()

◆ opequalequal()

◆ ot()

◆ replace()

◆ setch()

◆ type()