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

#include <NativeDoubleVectorStaged.h>

Inheritance diagram for madara::knowledge::containers::NativeDoubleVectorStaged:

Collaboration diagram for madara::knowledge::containers::NativeDoubleVectorStaged:

[legend]

Public Types
typedef double	type
	trait that describes the value type More...

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

	NativeDoubleVectorStaged (const std::string &name, KnowledgeBase &knowledge, int size=-1, const KnowledgeUpdateSettings &settings=KnowledgeUpdateSettings())
	Constructor. More...

	NativeDoubleVectorStaged (const std::string &name, Variables &knowledge, int size=-1, const KnowledgeUpdateSettings &settings=KnowledgeUpdateSettings())
	Constructor. More...

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

virtual	~NativeDoubleVectorStaged ()
	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	exchange (NativeDoubleVectorStaged &other)
	Exchanges the vector at this location with the vector at another location. 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_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 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 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 NativeDoubleVectorStaged &rhs)
	Assignment operator. More...

void	operator= (const std::vector< type > &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	read (void)
	Reads the value from the knowledge base. More...

void	resize (size_t size)
	Resizes the vector. More...

void	set (size_t index, type value)
	Sets a knowledge variable to a specified value. More...

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

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

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

void	set_name (const std::string &var_name, ThreadSafeContext &knowledge, int size=-1, bool sync=true)
	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 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 (NativeDoubleVectorStaged &other)
	Transfers elements from this vector to another. More...

void	write (void)
	Writes the value to the knowledge base. 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...

bool	has_changed_
	Tracks if value_ has changed since last read. More...

KnowledgeRecord	value_
	The staged value of the vector. More...

VariableReference	vector_
	Reference to the size field of the vector space. More...

Detailed Description

This class stores a vector of doubles inside of KaRL.

This container is highly optimized for using a staged value (an intermediate value between the user application and the knowledge base) for common operations and then writing that staged value to the knowledge base after operations are complete with the write method. The value is only updated from the knowledge base on construction and when read is called.

Definition at line 38 of file NativeDoubleVectorStaged.h.

Member Typedef Documentation

typedef double madara::knowledge::containers::NativeDoubleVectorStaged::type

trait that describes the value type

Definition at line 42 of file NativeDoubleVectorStaged.h.

Constructor & Destructor Documentation

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

Default constructor.

Parameters

settings settings for evaluating the vector

Definition at line 5 of file NativeDoubleVectorStaged.cpp.

madara::knowledge::containers::NativeDoubleVectorStaged::NativeDoubleVectorStaged	(	const std::string &	name,
		KnowledgeBase &	knowledge,
		int	size = `-1`,
		const KnowledgeUpdateSettings &	settings = `KnowledgeUpdateSettings ()`
	)

Constructor.

Parameters

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

Definition at line 14 of file NativeDoubleVectorStaged.cpp.

madara::knowledge::containers::NativeDoubleVectorStaged::NativeDoubleVectorStaged	(	const std::string &	name,
		Variables &	knowledge,
		int	size = `-1`,
		const KnowledgeUpdateSettings &	settings = `KnowledgeUpdateSettings ()`
	)

Constructor.

Parameters

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

Definition at line 34 of file NativeDoubleVectorStaged.cpp.

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

Copy constructor.

Definition at line 53 of file NativeDoubleVectorStaged.cpp.

madara::knowledge::containers::NativeDoubleVectorStaged::~NativeDoubleVectorStaged ( )

virtual

Destructor.

Definition at line 65 of file NativeDoubleVectorStaged.cpp.

Member Function Documentation

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

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

inline

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

Parameters

target record values at this instance

Definition at line 270 of file NativeDoubleVectorStaged.inl.

void madara::knowledge::containers::NativeDoubleVectorStaged::exchange ( NativeDoubleVectorStaged & other )

inline

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

Parameters

other the other vector to exchange with

Definition at line 221 of file NativeDoubleVectorStaged.inl.

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

inline

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 30 of file NativeDoubleVectorStaged.inl.

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

inlineprivatevirtual

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 51 of file NativeDoubleVectorStaged.inl.

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.

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

inline

Determines if the value of the vector is false.

Returns: true if at least one value is false

Definition at line 367 of file NativeDoubleVectorStaged.inl.

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

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

inline

Determines if all values in the vector are true.

Returns: true if all values are true

Definition at line 350 of file NativeDoubleVectorStaged.inl.

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

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

inline

Mark the value as modified.

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

Definition at line 11 of file NativeDoubleVectorStaged.inl.

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

inline

Assignment operator.

Parameters

rhs	value to copy

Definition at line 58 of file NativeDoubleVectorStaged.inl.

void madara::knowledge::containers::NativeDoubleVectorStaged::operator= ( const std::vector< type > & rhs )

inline

Assignment operator.

Parameters

rhs	value to copy

Definition at line 81 of file NativeDoubleVectorStaged.inl.

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

inline

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 282 of file NativeDoubleVectorStaged.inl.

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

inline

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 91 of file NativeDoubleVectorStaged.inl.

void madara::knowledge::containers::NativeDoubleVectorStaged::read ( void )

inline

Reads the value from the knowledge base.

Definition at line 373 of file NativeDoubleVectorStaged.inl.

void madara::knowledge::containers::NativeDoubleVectorStaged::resize ( size_t size )

inline

Resizes the vector.

Parameters

size	maximum size of the vector

Definition at line 103 of file NativeDoubleVectorStaged.inl.

void madara::knowledge::containers::NativeDoubleVectorStaged::set	(	size_t	index,
		type	value
	)

inline

Sets a knowledge variable to a specified value.

Parameters

index	index to set
value	value to set at location

Definition at line 293 of file NativeDoubleVectorStaged.inl.

void madara::knowledge::containers::NativeDoubleVectorStaged::set ( const std::vector< type > & value )

inline

Reads values from a STL vector of doubles.

Parameters

value array of doubles to set at the location

Definition at line 304 of file NativeDoubleVectorStaged.inl.

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

inline

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)
sync	synchronize the container to the knowledge base

Definition at line 119 of file NativeDoubleVectorStaged.inl.

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

inline

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)
sync	synchronize the container to the knowledge base

Definition at line 153 of file NativeDoubleVectorStaged.inl.

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

inline

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)
sync	synchronize the container to the knowledge base

Definition at line 187 of file NativeDoubleVectorStaged.inl.

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

inline

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 314 of file NativeDoubleVectorStaged.inl.

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::NativeDoubleVectorStaged::size ( void ) const

inline

Returns the size of the vector.

Returns: size of the vector

Definition at line 113 of file NativeDoubleVectorStaged.inl.

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

inline

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 334 of file NativeDoubleVectorStaged.inl.

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

inline

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

Returns: the vector in native double array format

Definition at line 343 of file NativeDoubleVectorStaged.inl.

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

inline

Transfers elements from this vector to another.

Parameters

other the other vector to transfer to

Definition at line 237 of file NativeDoubleVectorStaged.inl.

void madara::knowledge::containers::NativeDoubleVectorStaged::write ( void )

inline

Writes the value to the knowledge base.

Definition at line 380 of file NativeDoubleVectorStaged.inl.

Member Data Documentation

ThreadSafeContext* madara::knowledge::containers::NativeDoubleVectorStaged::context_

private

Variable context that we are modifying.

Definition at line 304 of file NativeDoubleVectorStaged.h.

bool madara::knowledge::containers::NativeDoubleVectorStaged::has_changed_

private

Tracks if value_ has changed since last read.

Definition at line 319 of file NativeDoubleVectorStaged.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.

KnowledgeRecord madara::knowledge::containers::NativeDoubleVectorStaged::value_

private

The staged value of the vector.

Definition at line 314 of file NativeDoubleVectorStaged.h.

VariableReference madara::knowledge::containers::NativeDoubleVectorStaged::vector_

private

Reference to the size field of the vector space.

Definition at line 309 of file NativeDoubleVectorStaged.h.

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

include/madara/knowledge/containers/NativeDoubleVectorStaged.h
include/madara/knowledge/containers/NativeDoubleVectorStaged.cpp
include/madara/knowledge/containers/NativeDoubleVectorStaged.inl

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