MADARA
3.4.1
|
This class stores a vector of doubles inside of KaRL. More...
#include <NativeIntegerVector.h>
Public Types | |
typedef knowledge::KnowledgeRecord::Integer | type |
trait that describes the value type More... | |
Public Member Functions | |
NativeIntegerVector (const KnowledgeUpdateSettings &settings=KnowledgeUpdateSettings()) | |
Default constructor. More... | |
NativeIntegerVector (const NativeIntegerVector &rhs) | |
Copy constructor. More... | |
NativeIntegerVector (const std::string &name, KnowledgeBase &knowledge, int size=-1, const KnowledgeUpdateSettings &settings=KnowledgeUpdateSettings()) | |
Constructor. More... | |
NativeIntegerVector (const std::string &name, Variables &knowledge, int size=-1, const KnowledgeUpdateSettings &settings=KnowledgeUpdateSettings()) | |
Constructor. More... | |
virtual | ~NativeIntegerVector () |
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 (NativeIntegerVector &other) |
Exchanges the vector at this location with the vector at another location. More... | |
bool | exists (void) const |
Checks to see if the variable 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_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 NativeIntegerVector &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 (size_t size) |
Resizes the vector. More... | |
int | set (const std::vector< type > &value) |
Reads values from a STL vector of doubles. More... | |
int | set (const std::vector< type > &value, const KnowledgeUpdateSettings &settings) |
Reads values from a STL vector of doubles. More... | |
int | set (size_t index, type value) |
Sets a knowledge variable to a specified value. More... | |
int | set (size_t index, type value, const KnowledgeUpdateSettings &settings) |
Sets a knowledge variable to a specified value. 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, ThreadSafeContext &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_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... | |
std::vector< KnowledgeRecord::Integer > | to_integers (void) const |
Retrieves the native integer array from inside the record. 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 (NativeIntegerVector &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... | |
VariableReference | vector_ |
Reference to the size field of the vector space. More... | |
This class stores a vector of doubles inside of KaRL.
Definition at line 31 of file NativeIntegerVector.h.
typedef knowledge::KnowledgeRecord::Integer madara::knowledge::containers::NativeIntegerVector::type |
trait that describes the value type
Definition at line 35 of file NativeIntegerVector.h.
madara::knowledge::containers::NativeIntegerVector::NativeIntegerVector | ( | const KnowledgeUpdateSettings & | settings = KnowledgeUpdateSettings() | ) |
Default constructor.
settings | settings for evaluating the vector |
Definition at line 4 of file NativeIntegerVector.cpp.
madara::knowledge::containers::NativeIntegerVector::NativeIntegerVector | ( | const std::string & | name, |
KnowledgeBase & | knowledge, | ||
int | size = -1 , |
||
const KnowledgeUpdateSettings & | settings = KnowledgeUpdateSettings() |
||
) |
Constructor.
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 10 of file NativeIntegerVector.cpp.
madara::knowledge::containers::NativeIntegerVector::NativeIntegerVector | ( | const std::string & | name, |
Variables & | knowledge, | ||
int | size = -1 , |
||
const KnowledgeUpdateSettings & | settings = KnowledgeUpdateSettings() |
||
) |
Constructor.
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 22 of file NativeIntegerVector.cpp.
madara::knowledge::containers::NativeIntegerVector::NativeIntegerVector | ( | const NativeIntegerVector & | rhs | ) |
Copy constructor.
Definition at line 34 of file NativeIntegerVector.cpp.
|
virtual |
Destructor.
Definition at line 40 of file NativeIntegerVector.cpp.
|
virtual |
Clones this container.
Implements madara::knowledge::containers::BaseContainer.
Definition at line 83 of file NativeIntegerVector.cpp.
void madara::knowledge::containers::NativeIntegerVector::copy_to | ( | KnowledgeVector & | target | ) | const |
Copies the vector elements to an STL vector of Knowledge Records.
target | record values at this instance |
Definition at line 251 of file NativeIntegerVector.cpp.
void madara::knowledge::containers::NativeIntegerVector::exchange | ( | NativeIntegerVector & | other | ) |
Exchanges the vector at this location with the vector at another location.
other | the other vector to exchange with |
Definition at line 195 of file NativeIntegerVector.cpp.
bool madara::knowledge::containers::NativeIntegerVector::exists | ( | void | ) | const |
Checks to see if the variable has ever been assigned a value.
Definition at line 359 of file NativeIntegerVector.cpp.
std::string madara::knowledge::containers::NativeIntegerVector::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)
Definition at line 51 of file NativeIntegerVector.cpp.
|
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)
Implements madara::knowledge::containers::BaseContainer.
Definition at line 76 of file NativeIntegerVector.cpp.
|
inlineinherited |
Returns the name of the container.
Definition at line 4 of file BaseContainer.inl.
|
inherited |
Gets the update settings for the container.
Definition at line 29 of file BaseContainer.cpp.
bool madara::knowledge::containers::NativeIntegerVector::is_false | ( | void | ) | const |
Determines if the value of the vector is false.
Definition at line 415 of file NativeIntegerVector.cpp.
|
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 425 of file NativeIntegerVector.cpp.
bool madara::knowledge::containers::NativeIntegerVector::is_true | ( | void | ) | const |
Determines if all values in the vector are true.
Definition at line 395 of file NativeIntegerVector.cpp.
|
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 420 of file NativeIntegerVector.cpp.
void madara::knowledge::containers::NativeIntegerVector::modify | ( | void | ) |
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 42 of file NativeIntegerVector.cpp.
|
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 71 of file NativeIntegerVector.cpp.
|
virtualinherited |
Modifies the container if the argument is false.
conditional | the container that must be false to modify |
Definition at line 56 of file BaseContainer.cpp.
|
virtualinherited |
Modifies the container if the argument is true.
conditional | the container that must be true to modify |
Definition at line 36 of file BaseContainer.cpp.
void madara::knowledge::containers::NativeIntegerVector::operator= | ( | const NativeIntegerVector & | rhs | ) |
Assignment operator.
rhs | value to copy |
Definition at line 88 of file NativeIntegerVector.cpp.
madara::knowledge::containers::NativeIntegerVector::type madara::knowledge::containers::NativeIntegerVector::operator[] | ( | size_t | index | ) | const |
Retrieves a copy of the record from the map.
index | the index of the variable entry |
Definition at line 269 of file NativeIntegerVector.cpp.
void madara::knowledge::containers::NativeIntegerVector::push_back | ( | type | value | ) |
Pushes the value to the end of the array after incrementing the array size.
value | the value to place at the end of the array |
Definition at line 102 of file NativeIntegerVector.cpp.
void madara::knowledge::containers::NativeIntegerVector::resize | ( | size_t | size | ) |
Resizes the vector.
size | maximum size of the vector |
Definition at line 115 of file NativeIntegerVector.cpp.
int madara::knowledge::containers::NativeIntegerVector::set | ( | const std::vector< type > & | value | ) |
Reads values from a STL vector of doubles.
value | array of doubles to set at the location |
Definition at line 317 of file NativeIntegerVector.cpp.
int madara::knowledge::containers::NativeIntegerVector::set | ( | const std::vector< type > & | value, |
const KnowledgeUpdateSettings & | settings | ||
) |
Reads values from a STL vector of doubles.
value | array of doubles to set at the location |
settings | settings for applying the update |
Definition at line 332 of file NativeIntegerVector.cpp.
int madara::knowledge::containers::NativeIntegerVector::set | ( | size_t | index, |
type | value | ||
) |
Sets a knowledge variable to a specified value.
index | index to set |
value | value to set at location |
Definition at line 287 of file NativeIntegerVector.cpp.
int madara::knowledge::containers::NativeIntegerVector::set | ( | size_t | index, |
type | value, | ||
const KnowledgeUpdateSettings & | settings | ||
) |
Sets a knowledge variable to a specified value.
index | index to set |
value | value to set at location |
settings | settings for applying the update |
Definition at line 302 of file NativeIntegerVector.cpp.
void madara::knowledge::containers::NativeIntegerVector::set_name | ( | const std::string & | var_name, |
KnowledgeBase & | knowledge, | ||
int | size = -1 |
||
) |
Sets the variable name that this refers to.
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 138 of file NativeIntegerVector.cpp.
void madara::knowledge::containers::NativeIntegerVector::set_name | ( | const std::string & | var_name, |
ThreadSafeContext & | knowledge, | ||
int | size = -1 |
||
) |
Sets the variable name that this refers to.
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 176 of file NativeIntegerVector.cpp.
void madara::knowledge::containers::NativeIntegerVector::set_name | ( | const std::string & | var_name, |
Variables & | knowledge, | ||
int | size = -1 |
||
) |
Sets the variable name that this refers to.
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 157 of file NativeIntegerVector.cpp.
void madara::knowledge::containers::NativeIntegerVector::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.
index | index to set |
quality | quality of writing to this location |
settings | settings for referring to knowledge variables |
Definition at line 347 of file NativeIntegerVector.cpp.
|
inherited |
Sets the update settings for the container.
settings | the new settings to use |
Definition at line 20 of file BaseContainer.cpp.
size_t madara::knowledge::containers::NativeIntegerVector::size | ( | void | ) | const |
Returns the size of the vector.
Definition at line 130 of file NativeIntegerVector.cpp.
std::vector< madara::knowledge::KnowledgeRecord::Integer > madara::knowledge::containers::NativeIntegerVector::to_integers | ( | void | ) | const |
Retrieves the native integer array from inside the record.
Definition at line 374 of file NativeIntegerVector.cpp.
madara::knowledge::KnowledgeRecord madara::knowledge::containers::NativeIntegerVector::to_record | ( | size_t | index | ) | const |
Retrieves a copy of the record from the vector.
index | the index of the variable entry |
Definition at line 380 of file NativeIntegerVector.cpp.
madara::knowledge::KnowledgeRecord madara::knowledge::containers::NativeIntegerVector::to_record | ( | void | ) | const |
Retrieves the entire vector as a native double array in a record.
Definition at line 390 of file NativeIntegerVector.cpp.
void madara::knowledge::containers::NativeIntegerVector::transfer_to | ( | NativeIntegerVector & | other | ) |
Transfers elements from this vector to another.
other | the other vector to transfer to |
Definition at line 214 of file NativeIntegerVector.cpp.
|
private |
Variable context that we are modifying.
Definition at line 307 of file NativeIntegerVector.h.
|
mutableprotectedinherited |
guard for access and changes
Mutex for local changes
Definition at line 136 of file BaseContainer.h.
|
protectedinherited |
Prefix of variable.
Definition at line 146 of file BaseContainer.h.
|
protectedinherited |
Settings for modifications.
Definition at line 151 of file BaseContainer.h.
|
private |
Reference to the size field of the vector space.
Definition at line 312 of file NativeIntegerVector.h.