This class stores an integer within a variable context. More...

#include <Counter.h>

Inheritance diagram for madara::knowledge::containers::Counter:

Collaboration diagram for madara::knowledge::containers::Counter:

[legend]

Public Types
typedef knowledge::KnowledgeRecord::Integer	type
	trait that describes the value type More...

Public Member Functions
	Counter (const KnowledgeUpdateSettings &settings=KnowledgeUpdateSettings())
	Default constructor. More...

	Counter (const std::string &name, KnowledgeBase &knowledge, const KnowledgeUpdateSettings &settings=KnowledgeUpdateSettings())
	Constructor. More...

	Counter (const std::string &name, Variables &knowledge, const KnowledgeUpdateSettings &settings=KnowledgeUpdateSettings())
	Constructor. More...

	Counter (const std::string &name, KnowledgeBase &knowledge, int id, int counters, type value=0, const KnowledgeUpdateSettings &settings=KnowledgeUpdateSettings())
	Default constructor. More...

	Counter (const std::string &name, Variables &knowledge, int id, int counters, type value=0, const KnowledgeUpdateSettings &settings=KnowledgeUpdateSettings())
	Default constructor. More...

	Counter (const Counter &rhs)
	Copy constructor. More...

	~Counter ()
	Destructor. More...

virtual BaseContainer *	clone (void) const
	Clones this container. More...

int	get_counters (void) const
	Returns the number of counters in the counter ring. More...

std::string	get_debug_info (void)
	Returns the type of the container along with name and any other useful information. More...

int	get_id (void) const
	Returns the id of the counter in the counter ring. More...

std::string	get_name (void) const
	Returns the name of the container. More...

KnowledgeUpdateSettings	get_settings (void)
	Gets the update settings for the container. More...

bool	is_false (void) const
	Determines if the local count is zero. More...

bool	is_true (void) const
	Determines if the local count is not zero. More...

void	modify (void)
	Mark the value as modified. More...

virtual bool	modify_if_false (BaseContainer &conditional)
	Modifies the container if the argument is false. More...

virtual bool	modify_if_true (BaseContainer &conditional)
	Modifies the container if the argument is true. More...

bool	operator!= (const Counter &value) const
	Checks for inequality. More...

bool	operator!= (type value) const
	Checks for inequality. More...

type	operator* (void) const
	Returns the value of the variable. More...

void	operator++ (void)
	Increments the value of the variable and returns the result. More...

void	operator+= (type value)
	Increments by a value. More...

void	operator-- (void)
	Decrements the value of the variable and returns the result. More...

void	operator-= (type value)
	Decrements by a value. More...

bool	operator< (type value) const
	Checks for less than relationship. More...

bool	operator<= (type value) const
	Checks for less than or equal to relationship. More...

void	operator= (const Counter &rhs)
	Assignment operator. More...

type	operator= (type value)
	Sets the value of the variable. More...

bool	operator== (const Counter &value) const
	Checks for equality. More...

bool	operator== (type value) const
	Checks for equality. More...

bool	operator> (type value) const
	Checks for greater than relationship. More...

bool	operator>= (type value) const
	Checks for greater than or equal to relationship. More...

void	resize (int id=0, int counters=1)
	Resizes the counter, usually when number of counters change. More...

void	set_name (const std::string &var_name, KnowledgeBase &knowledge)
	Sets the variable name that this refers to. More...

void	set_name (const std::string &var_name, Variables &knowledge)
	Sets the variable name that this refers to. More...

void	set_quality (uint32_t quality, const KnowledgeReferenceSettings &settings=KnowledgeReferenceSettings(false))
	Sets the quality of writing to the counter variables. More...

void	set_settings (const KnowledgeUpdateSettings &settings)
	Sets the update settings for the container. More...

double	to_double (void) const
	Returns the value as a double. More...

knowledge::KnowledgeRecord::Integer	to_integer (void) const
	Returns the value as an integer (same as *) More...

knowledge::KnowledgeRecord	to_record (void) const
	Returns the value as a knowledge::KnowledgeRecord. More...

std::string	to_string (void) const
	Returns the value as a string. More...

Protected Attributes
MADARA_LOCK_TYPE	mutex_
	guard for access and changes More...

std::string	name_
	Prefix of variable. More...

KnowledgeUpdateSettings	settings_
	Settings for modifications. More...

Private Member Functions
void	build_aggregate_count (void)
	Builds the aggregate counter logic. More...

void	build_var (void)
	Builds the variable that is actually incremented. More...

type	get_count (void) const
	Counts all counter variables. More...

double	get_count_double (void) const
	Counts all counter variables. More...

knowledge::KnowledgeRecord	get_count_record (void) const
	Counts all counter variables. More...

std::string	get_count_string (void) const
	Counts all counter variables. More...

virtual std::string	get_debug_info_ (void)
	Returns the type of the container along with name and any other useful information. More...

void	init_noharm (void)
	Initialize the no harm eval settings. More...

virtual bool	is_false_ (void) const
	Polymorphic is false method which can be used to determine if at least one value in the container is false. More...

virtual bool	is_true_ (void) const
	Polymorphic is true method which can be used to determine if all values in the container are true. More...

virtual void	modify_ (void)
	Polymorphic modify method used by collection containers. More...

Private Attributes
CompiledExpression	aggregate_count_
	Expression for aggregating count in one atomic operation. More...

ThreadSafeContext *	context_
	Variable context that we are modifying. More...

int	counters_
	the number of counters in the counter ring More...

int	id_
	id of this counter in the counter ring More...

EvalSettings	no_harm
	Settings we'll use for all evaluations. More...

VariableReference	variable_
	Variable reference. More...

Detailed Description

This class stores an integer within a variable context.

Definition at line 33 of file Counter.h.

Member Typedef Documentation

typedef knowledge::KnowledgeRecord::Integer madara::knowledge::containers::Counter::type

trait that describes the value type

Definition at line 37 of file Counter.h.

Constructor & Destructor Documentation

madara::knowledge::containers::Counter::Counter ( const KnowledgeUpdateSettings & settings = KnowledgeUpdateSettings () )

Default constructor.

Definition at line 9 of file Counter.cpp.

madara::knowledge::containers::Counter::Counter	(	const std::string &	name,
		KnowledgeBase &	knowledge,
		const KnowledgeUpdateSettings &	settings = `KnowledgeUpdateSettings ()`
	)

Constructor.

Parameters

name	name of the integer in the knowledge base
knowledge	the knowledge base that will contain the vector
settings	settings for evaluating the vector

Definition at line 16 of file Counter.cpp.

madara::knowledge::containers::Counter::Counter	(	const std::string &	name,
		Variables &	knowledge,
		const KnowledgeUpdateSettings &	settings = `KnowledgeUpdateSettings ()`
	)

Constructor.

Parameters

name	the name of the map within the variable context
knowledge	the variable context
settings	settings to apply by default

Definition at line 28 of file Counter.cpp.

madara::knowledge::containers::Counter::Counter	(	const std::string &	name,
		KnowledgeBase &	knowledge,
		int	id,
		int	counters,
		type	value = `0`,
		const KnowledgeUpdateSettings &	settings = `KnowledgeUpdateSettings ()`
	)

Default constructor.

Parameters

name	name of the integer in the knowledge base
knowledge	the knowledge base that will contain the vector
id	the id of the counter in the counter ring
counters	the number of counters in the counter ring
value	new value of the variable in the knowledge base
settings	settings for evaluating the vector

Definition at line 40 of file Counter.cpp.

madara::knowledge::containers::Counter::Counter	(	const std::string &	name,
		Variables &	knowledge,
		int	id,
		int	counters,
		type	value = `0`,
		const KnowledgeUpdateSettings &	settings = `KnowledgeUpdateSettings ()`
	)

Default constructor.

Parameters

name	name of the integer in the knowledge base
knowledge	the knowledge base that will contain the vector
id	the id of the counter in the counter ring
counters	the number of counters in the counter ring
value	new value of the variable in the knowledge base
settings	settings for evaluating the vector

Definition at line 56 of file Counter.cpp.

madara::knowledge::containers::Counter::Counter ( const Counter & rhs )

Copy constructor.

Definition at line 73 of file Counter.cpp.

madara::knowledge::containers::Counter::~Counter ( )

Destructor.

Definition at line 84 of file Counter.cpp.

Member Function Documentation

void madara::knowledge::containers::Counter::build_aggregate_count ( void )

private

Builds the aggregate counter logic.

Definition at line 107 of file Counter.cpp.

void madara::knowledge::containers::Counter::build_var ( void )

private

Builds the variable that is actually incremented.

Definition at line 144 of file Counter.cpp.

madara::knowledge::containers::BaseContainer * madara::knowledge::containers::Counter::clone ( void ) const

virtual

Clones this container.

Returns: a deep copy of the container that must be managed by the user (i.e., you have to delete the return value)

Implements madara::knowledge::containers::BaseContainer.

Definition at line 223 of file Counter.cpp.

type madara::knowledge::containers::Counter::get_count ( void ) const

inlineprivate

Counts all counter variables.

Returns: total count

Definition at line 374 of file Counter.h.

double madara::knowledge::containers::Counter::get_count_double ( void ) const

inlineprivate

Counts all counter variables.

Returns: total count

Definition at line 392 of file Counter.h.

knowledge::KnowledgeRecord madara::knowledge::containers::Counter::get_count_record ( void ) const

inlineprivate

Counts all counter variables.

Returns: total count

Definition at line 401 of file Counter.h.

std::string madara::knowledge::containers::Counter::get_count_string ( void ) const

inlineprivate

Counts all counter variables.

Returns: total count

Definition at line 383 of file Counter.h.

int madara::knowledge::containers::Counter::get_counters ( void ) const

Returns the number of counters in the counter ring.

Returns: the number of counters counting

Definition at line 236 of file Counter.cpp.

std::string madara::knowledge::containers::Counter::get_debug_info ( void )

Returns the type of the container along with name and any other useful information.

The provided information should be useful for developers wishing to debug container operations, especially as it pertains to pending network operations (i.e., when used in conjunction with modify)

Returns: info in format {container}: {name}{ = value, if appropriate}

Definition at line 191 of file Counter.cpp.

std::string madara::knowledge::containers::Counter::get_debug_info_ ( void )

privatevirtual

Returns the type of the container along with name and any other useful information.

The provided information should be useful for developers wishing to debug container operations, especially as it pertains to pending network operations (i.e., when used in conjunction with modify)

Returns: info in format {container}: {name}{ = value, if appropriate}

Implements madara::knowledge::containers::BaseContainer.

Definition at line 217 of file Counter.cpp.

int madara::knowledge::containers::Counter::get_id ( void ) const

Returns the id of the counter in the counter ring.

Returns: the id of the counter

Definition at line 229 of file Counter.cpp.

std::string madara::knowledge::containers::BaseContainer::get_name ( void ) const

inlineinherited

Returns the name of the container.

Returns: name of the container

Definition at line 5 of file BaseContainer.inl.

madara::knowledge::KnowledgeUpdateSettings madara::knowledge::containers::BaseContainer::get_settings ( void )

inherited

Gets the update settings for the container.

Returns: the current settings

Definition at line 37 of file BaseContainer.cpp.

void madara::knowledge::containers::Counter::init_noharm ( void )

private

Initialize the no harm eval settings.

Definition at line 170 of file Counter.cpp.

bool madara::knowledge::containers::Counter::is_false ( void ) const

Determines if the local count is zero.

Returns: true if the local count is zero

Definition at line 566 of file Counter.cpp.

bool madara::knowledge::containers::Counter::is_false_ ( void ) const

privatevirtual

Polymorphic is false method which can be used to determine if at least one value in the container is false.

Implements madara::knowledge::containers::BaseContainer.

Definition at line 579 of file Counter.cpp.

bool madara::knowledge::containers::Counter::is_true ( void ) const

Determines if the local count is not zero.

Returns: true if the local count is not zero

Definition at line 545 of file Counter.cpp.

bool madara::knowledge::containers::Counter::is_true_ ( void ) const

privatevirtual

Polymorphic is true method which can be used to determine if all values in the container are true.

Implements madara::knowledge::containers::BaseContainer.

Definition at line 573 of file Counter.cpp.

void madara::knowledge::containers::Counter::modify ( void )

Mark the value as modified.

The Counter retains the same value but will resend its value as if it had been modified.

Definition at line 181 of file Counter.cpp.

void madara::knowledge::containers::Counter::modify_ ( void )

privatevirtual

Polymorphic modify method used by collection containers.

This method calls the modify method for this class. We separate the faster version (modify) from this version (modify_) to allow users the opportunity to have a fastery version that does not use polymorphic functions (generally virtual functions are half as efficient as normal function calls)

Implements madara::knowledge::containers::BaseContainer.

Definition at line 211 of file Counter.cpp.

bool madara::knowledge::containers::BaseContainer::modify_if_false ( BaseContainer & conditional )

virtualinherited

Modifies the container if the argument is false.

Parameters

conditional the container that must be false to modify

Returns: true if the container was modified

Definition at line 64 of file BaseContainer.cpp.

bool madara::knowledge::containers::BaseContainer::modify_if_true ( BaseContainer & conditional )

virtualinherited

Modifies the container if the argument is true.

Parameters

conditional the container that must be true to modify

Returns: true if the container was modified

Definition at line 44 of file BaseContainer.cpp.

bool madara::knowledge::containers::Counter::operator!= ( const Counter & value ) const

Checks for inequality.

Parameters

value the value to compare to

Returns: true if inequal, false otherwise

Definition at line 346 of file Counter.cpp.

bool madara::knowledge::containers::Counter::operator!= ( type value ) const

Checks for inequality.

Parameters

value the value to compare to

Returns: true if inequal, false otherwise

Definition at line 319 of file Counter.cpp.

madara::knowledge::containers::Counter::type madara::knowledge::containers::Counter::operator* ( void ) const

Returns the value of the variable.

Returns: the value of the variable

Definition at line 412 of file Counter.cpp.

void madara::knowledge::containers::Counter::operator++ ( void )

Increments the value of the variable and returns the result.

Returns: the new value of the variable

Definition at line 479 of file Counter.cpp.

void madara::knowledge::containers::Counter::operator+= ( type value )

Increments by a value.

Parameters

value the value to add

Returns: the new value

Definition at line 448 of file Counter.cpp.

void madara::knowledge::containers::Counter::operator-- ( void )

Decrements the value of the variable and returns the result.

Returns: the new value of the variable

Definition at line 490 of file Counter.cpp.

void madara::knowledge::containers::Counter::operator-= ( type value )

Decrements by a value.

Parameters

value the value to remove

Returns: the new value

Definition at line 464 of file Counter.cpp.

bool madara::knowledge::containers::Counter::operator< ( type value ) const

Checks for less than relationship.

Parameters

value the value to compare to

Returns: true if less than

Definition at line 360 of file Counter.cpp.

bool madara::knowledge::containers::Counter::operator<= ( type value ) const

Checks for less than or equal to relationship.

Parameters

value the value to compare to

Returns: true if less than or equal to

Definition at line 373 of file Counter.cpp.

void madara::knowledge::containers::Counter::operator= ( const Counter & rhs )

Assignment operator.

Parameters

rhs	value to copy

Definition at line 90 of file Counter.cpp.

madara::knowledge::containers::Counter::type madara::knowledge::containers::Counter::operator= ( type value )

Sets the value of the variable.

Parameters

value the new value of the variable

Returns: the updated value (should be same as value param)

Definition at line 293 of file Counter.cpp.

bool madara::knowledge::containers::Counter::operator== ( const Counter & value ) const

Checks for equality.

Parameters

value the value to compare to

Returns: true if equal, false otherwise

Definition at line 332 of file Counter.cpp.

bool madara::knowledge::containers::Counter::operator== ( type value ) const

Checks for equality.

Parameters

value the value to compare to

Returns: true if equal, false otherwise

Definition at line 306 of file Counter.cpp.

bool madara::knowledge::containers::Counter::operator> ( type value ) const

Checks for greater than relationship.

Parameters

value the value to compare to

Returns: true if greater than

Definition at line 386 of file Counter.cpp.

bool madara::knowledge::containers::Counter::operator>= ( type value ) const

Checks for greater than or equal to relationship.

Parameters

value the value to compare to

Returns: true if greater than or equal to

Definition at line 399 of file Counter.cpp.

void madara::knowledge::containers::Counter::resize	(	int	id = `0`,
		int	counters = `1`
	)

Resizes the counter, usually when number of counters change.

Parameters

id	the id of this counter in the counter ring
counters	the number of counters in counter ring

Definition at line 277 of file Counter.cpp.

void madara::knowledge::containers::Counter::set_name	(	const std::string &	var_name,
		KnowledgeBase &	knowledge
	)

Sets the variable name that this refers to.

Parameters

var_name	the name of the variable in the knowledge base
knowledge	the knowledge base the variable is housed in

Definition at line 243 of file Counter.cpp.

void madara::knowledge::containers::Counter::set_name	(	const std::string &	var_name,
		Variables &	knowledge
	)

Sets the variable name that this refers to.

Parameters

var_name	the name of the variable in the knowledge base
knowledge	the knowledge base the variable is housed in

Definition at line 260 of file Counter.cpp.

void madara::knowledge::containers::Counter::set_quality	(	uint32_t	quality,
		const KnowledgeReferenceSettings &	settings = `KnowledgeReferenceSettings (false)`
	)

Sets the quality of writing to the counter variables.

Parameters

quality	quality of writing to this location
settings	settings for referring to knowledge variables

Definition at line 531 of file Counter.cpp.

void madara::knowledge::containers::BaseContainer::set_settings ( const KnowledgeUpdateSettings & settings )

inherited

Sets the update settings for the container.

Parameters

settings the new settings to use

Definition at line 28 of file BaseContainer.cpp.

double madara::knowledge::containers::Counter::to_double ( void ) const

Returns the value as a double.

Returns: the value as a double

Definition at line 501 of file Counter.cpp.

madara::knowledge::KnowledgeRecord::Integer madara::knowledge::containers::Counter::to_integer ( void ) const

Returns the value as an integer (same as *)

Returns: the value as an integer

Definition at line 433 of file Counter.cpp.

madara::knowledge::KnowledgeRecord madara::knowledge::containers::Counter::to_record ( void ) const

Returns the value as a knowledge::KnowledgeRecord.

This is useful for referencing clock and other record info.

Returns: the value as a knowledge::KnowledgeRecord

Definition at line 418 of file Counter.cpp.

std::string madara::knowledge::containers::Counter::to_string ( void ) const

Returns the value as a string.

Returns: the value as a string

Definition at line 516 of file Counter.cpp.

Member Data Documentation

CompiledExpression madara::knowledge::containers::Counter::aggregate_count_

private

Expression for aggregating count in one atomic operation.

Definition at line 429 of file Counter.h.

ThreadSafeContext* madara::knowledge::containers::Counter::context_

mutableprivate

Variable context that we are modifying.

Definition at line 409 of file Counter.h.

int madara::knowledge::containers::Counter::counters_

private

the number of counters in the counter ring

Definition at line 424 of file Counter.h.

int madara::knowledge::containers::Counter::id_

private

id of this counter in the counter ring

Definition at line 419 of file Counter.h.

MADARA_LOCK_TYPE madara::knowledge::containers::BaseContainer::mutex_

mutableprotectedinherited

guard for access and changes

Mutex for local changes

Definition at line 141 of file BaseContainer.h.

std::string madara::knowledge::containers::BaseContainer::name_

protectedinherited

Prefix of variable.

Definition at line 151 of file BaseContainer.h.

EvalSettings madara::knowledge::containers::Counter::no_harm

private

Settings we'll use for all evaluations.

Definition at line 434 of file Counter.h.

KnowledgeUpdateSettings madara::knowledge::containers::BaseContainer::settings_

protectedinherited

Settings for modifications.

Definition at line 156 of file BaseContainer.h.

VariableReference madara::knowledge::containers::Counter::variable_

private

Variable reference.

Definition at line 414 of file Counter.h.

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

include/madara/knowledge/containers/Counter.h
include/madara/knowledge/containers/Counter.cpp

Public Types

Public Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation