Manages a 2D array of integers as a virtual overlay in the KnowledgeBase. More...

#include <IntegerVector2D.h>

Inheritance diagram for madara::knowledge::containers::IntegerVector2D:

Collaboration diagram for madara::knowledge::containers::IntegerVector2D:

[legend]

Classes
struct	Indices
	two dimensional indexing More...

Public Types
typedef Indices	Dimensions
	convenience typedef for size More...

typedef KnowledgeRecord::Integer	type
	convenience typedef for element type More...

Public Member Functions
	IntegerVector2D (const KnowledgeUpdateSettings &settings=KnowledgeUpdateSettings(), const std::string &delimiter=".")
	Default constructor. More...

	IntegerVector2D (const std::string &name, KnowledgeBase &knowledge, const Dimensions &dimensions={0, 0}, bool delete_vars=true, const KnowledgeUpdateSettings &settings=KnowledgeUpdateSettings(), const std::string &delimiter=".")
	Constructor. More...

	IntegerVector2D (const std::string &name, Variables &knowledge, const Dimensions &dimensions={0, 0}, bool delete_vars=true, const KnowledgeUpdateSettings &settings=KnowledgeUpdateSettings(), const std::string &delimiter=".")
	Constructor. More...

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

virtual	~IntegerVector2D ()
	Destructor. More...

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

void	copy_to (std::vector< std::vector< type > > &target) const
	Copies the vector elements to an STL vector. More...

bool	exists (const Indices &index) const
	Checks to see if the index has ever been assigned a value. More...

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

std::string	get_delimiter (void)
	Gets the delimiter for adding and detecting subvariables. 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...

VariableReference	get_size_ref (void)
	Returns a reference to the size of vector. More...

bool	is_false (void) const
	Determines if the value of the vector is false. More...

bool	is_true (void) const
	Determines if all values in the vector are true. More...

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

void	modify (const Indices &index)
	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...

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

type	operator[] (const Indices &index) const
	Retrieves an index from the multi-dimensional array. More...

void	resize (const Dimensions &dimensions, bool delete_vars=true)
	Resizes the vector. More...

int	set (const Indices &index, type value)
	Sets a knowledge variable to a specified value. More...

int	set (const std::vector< std::vector< type > > &value)
	Reads values from a STL vector of KnowledgeRecord::Integers. More...

int	set (const Indices &index, type value, const KnowledgeUpdateSettings &settings)
	Sets a knowledge variable to a specified value. More...

int	set (const std::vector< std::vector< type > > &value, const KnowledgeUpdateSettings &settings)
	Reads values from a STL vector. More...

void	set_delimiter (const std::string &delimiter)
	Sets the delimiter for adding and detecting subvariables. More...

void	set_name (const std::string &var_name, KnowledgeBase &knowledge, const Dimensions &dimensions={0, 0})
	Sets the variable name that this refers to. More...

void	set_name (const std::string &var_name, Variables &knowledge, const Dimensions &dimensions={0, 0})
	Sets the variable name that this refers to. More...

void	set_name (const std::string &var_name, ThreadSafeContext &knowledge, const Dimensions &dimensions={0, 0})
	Sets the variable name that this refers to. More...

void	set_quality (const Indices &index, uint32_t quality, const KnowledgeReferenceSettings &settings=KnowledgeReferenceSettings(false))
	Sets the quality of writing to a certain variable from this entity. More...

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

Dimensions	size (void) const
	Returns the size of the local vector. 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
virtual std::string	get_debug_info_ (void)
	Returns the type of the container along with name and any other useful information. 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
ThreadSafeContext *	context_
	Variable context that we are modifying. More...

std::string	delimiter_
	Delimiter for the prefix to subvars. More...

VariableReference	size_
	Reference to the size of 2D array. More...

std::vector< std::vector< VariableReference > >	vector_
	Values of the array. More...

Detailed Description

Manages a 2D array of integers as a virtual overlay in the KnowledgeBase.

Definition at line 32 of file IntegerVector2D.h.

Member Typedef Documentation

typedef Indices madara::knowledge::containers::IntegerVector2D::Dimensions

convenience typedef for size

Definition at line 42 of file IntegerVector2D.h.

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

convenience typedef for element type

Definition at line 45 of file IntegerVector2D.h.

Constructor & Destructor Documentation

madara::knowledge::containers::IntegerVector2D::IntegerVector2D	(	const KnowledgeUpdateSettings &	settings = `KnowledgeUpdateSettings ()`,
		const std::string &	delimiter = `"."`
	)

Default constructor.

Parameters

settings	settings for evaluating the vector
delimiter	the delimiter for variables in the vector

Definition at line 5 of file IntegerVector2D.cpp.

madara::knowledge::containers::IntegerVector2D::IntegerVector2D	(	const std::string &	name,
		KnowledgeBase &	knowledge,
		const Dimensions &	dimensions = `{0,0}`,
		bool	delete_vars = `true`,
		const KnowledgeUpdateSettings &	settings = `KnowledgeUpdateSettings ()`,
		const std::string &	delimiter = `"."`
	)

Constructor.

Parameters

name	name of the vector in the knowledge base
dimensions	size of the vector. {0,0} to check for size.
knowledge	the knowledge base that will contain the vector
delete_vars	delete indices outside of the specified range
settings	settings for evaluating the vector
delimiter	the delimiter for variables in the vector

Definition at line 12 of file IntegerVector2D.cpp.

madara::knowledge::containers::IntegerVector2D::IntegerVector2D	(	const std::string &	name,
		Variables &	knowledge,
		const Dimensions &	dimensions = `{0,0}`,
		bool	delete_vars = `true`,
		const KnowledgeUpdateSettings &	settings = `KnowledgeUpdateSettings ()`,
		const std::string &	delimiter = `"."`
	)

Constructor.

Parameters

name	name of the vector in the knowledge base
dimensions	size of the vector. {0,0} to check for size.
knowledge	the knowledge base that will contain the vector
delete_vars	delete indices outside of the specified range
settings	settings for evaluating the vector
delimiter	the delimiter for variables in the vector

Definition at line 26 of file IntegerVector2D.cpp.

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

Copy constructor.

Definition at line 40 of file IntegerVector2D.cpp.

madara::knowledge::containers::IntegerVector2D::~IntegerVector2D ( )

virtual

Destructor.

Definition at line 50 of file IntegerVector2D.cpp.

Member Function Documentation

madara::knowledge::containers::BaseContainer * madara::knowledge::containers::IntegerVector2D::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 129 of file IntegerVector2D.cpp.

void madara::knowledge::containers::IntegerVector2D::copy_to ( std::vector< std::vector< type > > & target ) const

Copies the vector elements to an STL vector.

Parameters

target the target of the copy operation

Definition at line 419 of file IntegerVector2D.cpp.

bool madara::knowledge::containers::IntegerVector2D::exists ( const Indices & index ) const

Checks to see if the index has ever been assigned a value.

Parameters

index the index of the variable entry

Returns: true if the record has been set to a value. False is uninitialized

Definition at line 466 of file IntegerVector2D.cpp.

std::string madara::knowledge::containers::IntegerVector2D::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 80 of file IntegerVector2D.cpp.

std::string madara::knowledge::containers::IntegerVector2D::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 123 of file IntegerVector2D.cpp.

std::string madara::knowledge::containers::IntegerVector2D::get_delimiter ( void )

Gets the delimiter for adding and detecting subvariables.

By default, MADARA uses a '.' delimiter for names like "com.madara.Var1". Other conventions can include '/' for ROS-like topic directory structures, e.g., com/madara/Var1.

Returns: the delimiter to use for variable demarcation

Definition at line 413 of file IntegerVector2D.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.

madara::knowledge::VariableReference madara::knowledge::containers::IntegerVector2D::get_size_ref ( void )

Returns a reference to the size of vector.

Returns: reference to the size field

Definition at line 163 of file IntegerVector2D.cpp.

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

Determines if the value of the vector is false.

Returns: true if at least one value is false

Definition at line 636 of file IntegerVector2D.cpp.

bool madara::knowledge::containers::IntegerVector2D::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 649 of file IntegerVector2D.cpp.

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

Determines if all values in the vector are true.

Returns: true if all values are true

Definition at line 589 of file IntegerVector2D.cpp.

bool madara::knowledge::containers::IntegerVector2D::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 643 of file IntegerVector2D.cpp.

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

Mark the vector as modified.

The vector retains the same values but will resend values as if they had been modified.

Definition at line 56 of file IntegerVector2D.cpp.

void madara::knowledge::containers::IntegerVector2D::modify ( const Indices & index )

Mark the value as modified.

The vector element retains its value but will resend its value as if it had been modified.

Parameters

index the index to modify

Definition at line 135 of file IntegerVector2D.cpp.

void madara::knowledge::containers::IntegerVector2D::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 117 of file IntegerVector2D.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.

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

Assignment operator.

Parameters

rhs	value to copy

Definition at line 146 of file IntegerVector2D.cpp.

madara::knowledge::containers::IntegerVector2D::type madara::knowledge::containers::IntegerVector2D::operator[] ( const Indices & index ) const

Retrieves an index from the multi-dimensional array.

Parameters

index the index of the variable entry

Returns: the value of the entry. Modifications to this will not be reflected in the context. This is a local copy.

Definition at line 444 of file IntegerVector2D.cpp.

void madara::knowledge::containers::IntegerVector2D::resize	(	const Dimensions &	dimensions,
		bool	delete_vars = `true`
	)

Resizes the vector.

Parameters

dimensions	maximum size of the vector. Can be -1 to check the knowledge base for size information)
delete_vars	delete indices outside of the specified range

Definition at line 185 of file IntegerVector2D.cpp.

int madara::knowledge::containers::IntegerVector2D::set	(	const Indices &	index,
		type	value
	)

Sets a knowledge variable to a specified value.

Parameters

index	location index to set
value	value to set at location

Returns: 0 if successful, -1 if key is null, and -2 if quality isn't high enough

Definition at line 485 of file IntegerVector2D.cpp.

int madara::knowledge::containers::IntegerVector2D::set ( const std::vector< std::vector< type > > & value )

Reads values from a STL vector of KnowledgeRecord::Integers.

Parameters

value array to set at the location

Returns: always returns 0

Definition at line 506 of file IntegerVector2D.cpp.

int madara::knowledge::containers::IntegerVector2D::set	(	const Indices &	index,
		type	value,
		const KnowledgeUpdateSettings &	settings
	)

Sets a knowledge variable to a specified value.

Parameters

index	location index to set
value	value to set at location
settings	settings for applying the update

Returns: 0 if successful, -1 if key is null, and -2 if quality isn't high enough

Definition at line 528 of file IntegerVector2D.cpp.

int madara::knowledge::containers::IntegerVector2D::set	(	const std::vector< std::vector< type > > &	value,
		const KnowledgeUpdateSettings &	settings
	)

Reads values from a STL vector.

Parameters

value	array of values to set at the location
settings	settings for applying the update

Returns: always returns 0

Definition at line 550 of file IntegerVector2D.cpp.

void madara::knowledge::containers::IntegerVector2D::set_delimiter ( const std::string & delimiter )

Sets the delimiter for adding and detecting subvariables.

By default, MADARA uses a '.' delimiter for names like "com.madara.Var1". Other conventions can include '/' for ROS-like topic directory structures, e.g., com/madara/Var1.

Parameters

delimiter the delimiter to use for variable demarcation

Definition at line 398 of file IntegerVector2D.cpp.

void madara::knowledge::containers::IntegerVector2D::set_name	(	const std::string &	var_name,
		KnowledgeBase &	knowledge,
		const Dimensions &	dimensions = `{0,0}`
	)

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
dimensions	size of the new vector ({0,0} to not change size)

Definition at line 341 of file IntegerVector2D.cpp.

void madara::knowledge::containers::IntegerVector2D::set_name	(	const std::string &	var_name,
		Variables &	knowledge,
		const Dimensions &	dimensions = `{0,0}`
	)

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
dimensions	size of the new vector ({0,0} to not change size)

Definition at line 362 of file IntegerVector2D.cpp.

void madara::knowledge::containers::IntegerVector2D::set_name	(	const std::string &	var_name,
		ThreadSafeContext &	knowledge,
		const Dimensions &	dimensions = `{0,0}`
	)

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
dimensions	size of the new vector ({0,0} to not change size)

Definition at line 380 of file IntegerVector2D.cpp.

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

Sets the quality of writing to a certain variable from this entity.

Parameters

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

Definition at line 573 of file IntegerVector2D.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.

madara::knowledge::containers::IntegerVector2D::Indices madara::knowledge::containers::IntegerVector2D::size ( void ) const

Returns the size of the local vector.

Call resize() first without arguments to ensure local vector matches data in KnowledgeBase.

Returns: MxN size of the vector

Definition at line 318 of file IntegerVector2D.cpp.

Member Data Documentation

ThreadSafeContext* madara::knowledge::containers::IntegerVector2D::context_

private

Variable context that we are modifying.

Definition at line 329 of file IntegerVector2D.h.

std::string madara::knowledge::containers::IntegerVector2D::delimiter_

private

Delimiter for the prefix to subvars.

Definition at line 344 of file IntegerVector2D.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.

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

protectedinherited

Settings for modifications.

Definition at line 156 of file BaseContainer.h.

VariableReference madara::knowledge::containers::IntegerVector2D::size_

private

Reference to the size of 2D array.

Definition at line 339 of file IntegerVector2D.h.

std::vector<std::vector <VariableReference> > madara::knowledge::containers::IntegerVector2D::vector_

private

Values of the array.

Definition at line 334 of file IntegerVector2D.h.

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

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

Classes

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