This class stores a vector of integers inside of KaRL. More...

#include <IntegerVector.h>

Inheritance diagram for madara::knowledge::containers::IntegerVector:

Collaboration diagram for madara::knowledge::containers::IntegerVector:

[legend]

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

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

	IntegerVector (const std::string &name, KnowledgeBase &knowledge, int size=-1, bool delete_vars=true, const KnowledgeUpdateSettings &settings=KnowledgeUpdateSettings(), const std::string &delimiter=".")
	Constructor. More...

	IntegerVector (const std::string &name, Variables &knowledge, int size=-1, bool delete_vars=true, const KnowledgeUpdateSettings &settings=KnowledgeUpdateSettings(), const std::string &delimiter=".")
	Constructor. More...

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

virtual	~IntegerVector ()
	Destructor. More...

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

void	copy_to (KnowledgeVector &target) const
	Copies the vector elements to an STL vector of Knowledge Records. More...

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

void	exchange (IntegerVector &other, bool refresh_keys=true, bool delete_keys=true)
	Exchanges the vector at this location with the vector at another location. More...

bool	exists (size_t 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 field of the current name. More...

type	inc (size_t index)
	Increments an index by a specified value. 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 (size_t 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 IntegerVector &rhs)
	Assignment operator. More...

type	operator[] (size_t index) const
	Retrieves a copy of the record from the map. More...

void	push_back (type value)
	Pushes the value to the end of the array after incrementing the array size. More...

void	resize (int size=-1, bool delete_vars=true)
	Resizes the vector. More...

int	set (size_t index, const type &value=madara::knowledge::KnowledgeRecord::MODIFIED)
	Sets a knowledge variable to a specified value. More...

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

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

int	set (const std::vector< type > &value, const KnowledgeUpdateSettings &settings)
	Reads values from a STL vector of integers. 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, int size=-1)
	Sets the variable name that this refers to. More...

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

void	set_name (const std::string &var_name, ThreadSafeContext &knowledge, int size=-1)
	Sets the variable name that this refers to. More...

void	set_quality (size_t 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...

size_t	size (void) const
	Returns the size of the local vector. More...

knowledge::KnowledgeRecord	to_record (size_t index) const
	Retrieves a copy of the record from the vector. More...

knowledge::KnowledgeRecord	to_record (void) const
	Retrieves the entire vector as a native double array in a record. More...

void	transfer_to (IntegerVector &other)
	Transfers elements from this vector to another. 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 field of the vector space. More...

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

Detailed Description

This class stores a vector of integers inside of KaRL.

Definition at line 31 of file IntegerVector.h.

Member Typedef Documentation

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

trait that describes the value type

Definition at line 35 of file IntegerVector.h.

Constructor & Destructor Documentation

madara::knowledge::containers::IntegerVector::IntegerVector	(	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 IntegerVector.cpp.

madara::knowledge::containers::IntegerVector::IntegerVector	(	const std::string &	name,
		KnowledgeBase &	knowledge,
		int	size = `-1`,
		bool	delete_vars = `true`,
		const KnowledgeUpdateSettings &	settings = `KnowledgeUpdateSettings ()`,
		const std::string &	delimiter = `"."`
	)

Constructor.

Parameters

name	name of the vector in the knowledge base
size	size of the vector. -1 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 IntegerVector.cpp.

madara::knowledge::containers::IntegerVector::IntegerVector	(	const std::string &	name,
		Variables &	knowledge,
		int	size = `-1`,
		bool	delete_vars = `true`,
		const KnowledgeUpdateSettings &	settings = `KnowledgeUpdateSettings ()`,
		const std::string &	delimiter = `"."`
	)

Constructor.

Parameters

name	name of the vector in the knowledge base
size	size of the vector. -1 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 IntegerVector.cpp.

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

Copy constructor.

Definition at line 40 of file IntegerVector.cpp.

madara::knowledge::containers::IntegerVector::~IntegerVector ( )

virtual

Destructor.

Definition at line 51 of file IntegerVector.cpp.

Member Function Documentation

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

void madara::knowledge::containers::IntegerVector::copy_to ( KnowledgeVector & target ) const

Copies the vector elements to an STL vector of Knowledge Records.

Parameters

target record values at this instance

Definition at line 481 of file IntegerVector.cpp.

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

Copies the vector elements to an STL vector.

Parameters

target the target of the copy operation

Definition at line 499 of file IntegerVector.cpp.

void madara::knowledge::containers::IntegerVector::exchange	(	IntegerVector &	other,
		bool	refresh_keys = `true`,
		bool	delete_keys = `true`
	)

Exchanges the vector at this location with the vector at another location.

Parameters

other	the other vector to exchange with
refresh_keys	force a refresh of the keys in both maps to ensure all keys are swapped
delete_keys	delete any unused keys

Definition at line 368 of file IntegerVector.cpp.

bool madara::knowledge::containers::IntegerVector::exists ( size_t 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 517 of file IntegerVector.cpp.

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

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

std::string madara::knowledge::containers::IntegerVector::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 362 of file IntegerVector.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::IntegerVector::get_size_ref ( void )

Returns a reference to the size field of the current name.

Returns: reference to the size field

Definition at line 167 of file IntegerVector.cpp.

madara::knowledge::containers::IntegerVector::type madara::knowledge::containers::IntegerVector::inc ( size_t index )

Increments an index by a specified value.

Parameters

index index to set

Returns: new value

Definition at line 609 of file IntegerVector.cpp.

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

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

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

Determines if all values in the vector are true.

Returns: true if all values are true

Definition at line 707 of file IntegerVector.cpp.

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

void madara::knowledge::containers::IntegerVector::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 57 of file IntegerVector.cpp.

void madara::knowledge::containers::IntegerVector::modify ( size_t 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 121 of file IntegerVector.cpp.

void madara::knowledge::containers::IntegerVector::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 103 of file IntegerVector.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::IntegerVector::operator= ( const IntegerVector & rhs )

Assignment operator.

Parameters

rhs	value to copy

Definition at line 131 of file IntegerVector.cpp.

madara::knowledge::containers::IntegerVector::type madara::knowledge::containers::IntegerVector::operator[] ( size_t index ) const

Retrieves a copy of the record from the map.

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 533 of file IntegerVector.cpp.

void madara::knowledge::containers::IntegerVector::push_back ( type value )

Pushes the value to the end of the array after incrementing the array size.

Parameters

value the value to place at the end of the array

Definition at line 148 of file IntegerVector.cpp.

void madara::knowledge::containers::IntegerVector::resize	(	int	size = `-1`,
		bool	delete_vars = `true`
	)

Resizes the vector.

Parameters

size	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 190 of file IntegerVector.cpp.

int madara::knowledge::containers::IntegerVector::set	(	size_t	index,
		const type &	value = `madara::knowledge::KnowledgeRecord::MODIFIED`
	)

Sets a knowledge variable to a specified value.

Parameters

index	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 592 of file IntegerVector.cpp.

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

Sets a knowledge variable to a specified value.

Parameters

index	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 625 of file IntegerVector.cpp.

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

Reads values from a STL vector of integers.

Parameters

value array of integers to set at the location

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

Definition at line 643 of file IntegerVector.cpp.

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

Reads values from a STL vector of integers.

Parameters

value	array of integers to set at the 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 667 of file IntegerVector.cpp.

void madara::knowledge::containers::IntegerVector::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 346 of file IntegerVector.cpp.

void madara::knowledge::containers::IntegerVector::set_name	(	const std::string &	var_name,
		KnowledgeBase &	knowledge,
		int	size = `-1`
	)

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
size	size of the new vector (-1 to not change size)

Definition at line 286 of file IntegerVector.cpp.

void madara::knowledge::containers::IntegerVector::set_name	(	const std::string &	var_name,
		Variables &	knowledge,
		int	size = `-1`
	)

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
size	size of the new vector (-1 to not change size)

Definition at line 308 of file IntegerVector.cpp.

void madara::knowledge::containers::IntegerVector::set_name	(	const std::string &	var_name,
		ThreadSafeContext &	knowledge,
		int	size = `-1`
	)

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
size	size of the new vector (-1 to not change size)

Definition at line 327 of file IntegerVector.cpp.

void madara::knowledge::containers::IntegerVector::set_quality	(	size_t	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 692 of file IntegerVector.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.

size_t madara::knowledge::containers::IntegerVector::size ( void ) const

Returns the size of the local vector.

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

Returns: size of the vector

Definition at line 279 of file IntegerVector.cpp.

madara::knowledge::KnowledgeRecord madara::knowledge::containers::IntegerVector::to_record ( size_t index ) const

Retrieves a copy of the record from the vector.

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 550 of file IntegerVector.cpp.

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

Retrieves the entire vector as a native double array in a record.

Returns: the vector in native double array format

Definition at line 567 of file IntegerVector.cpp.

void madara::knowledge::containers::IntegerVector::transfer_to ( IntegerVector & other )

Transfers elements from this vector to another.

Parameters

other the other vector to transfer to

Definition at line 456 of file IntegerVector.cpp.

Member Data Documentation

ThreadSafeContext* madara::knowledge::containers::IntegerVector::context_

private

Variable context that we are modifying.

Definition at line 375 of file IntegerVector.h.

std::string madara::knowledge::containers::IntegerVector::delimiter_

private

Delimiter for the prefix to subvars.

Definition at line 390 of file IntegerVector.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::IntegerVector::size_

private

Reference to the size field of the vector space.

Definition at line 385 of file IntegerVector.h.

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

private

Values of the array.

Definition at line 380 of file IntegerVector.h.

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

include/madara/knowledge/containers/IntegerVector.h
include/madara/knowledge/containers/IntegerVector.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