MADARA
3.2.3
|
This class stores a vector of doubles inside of KaRL. More...
#include <NativeIntegerVectorStaged.h>
Public Types | |
typedef knowledge::KnowledgeRecord::Integer | type |
trait that describes the value type More... | |
Public Member Functions | |
NativeIntegerVectorStaged (const KnowledgeUpdateSettings &settings=KnowledgeUpdateSettings()) | |
Default constructor. More... | |
NativeIntegerVectorStaged (const std::string &name, KnowledgeBase &knowledge, int size=-1, const KnowledgeUpdateSettings &settings=KnowledgeUpdateSettings()) | |
Constructor. More... | |
NativeIntegerVectorStaged (const std::string &name, Variables &knowledge, int size=-1, const KnowledgeUpdateSettings &settings=KnowledgeUpdateSettings()) | |
Constructor. More... | |
NativeIntegerVectorStaged (const NativeIntegerVectorStaged &rhs) | |
Copy constructor. More... | |
virtual | ~NativeIntegerVectorStaged () |
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 (NativeIntegerVectorStaged &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 NativeIntegerVectorStaged &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 (NativeIntegerVectorStaged &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... | |
This class stores a vector of doubles inside of KaRL.
Definition at line 31 of file NativeIntegerVectorStaged.h.
typedef knowledge::KnowledgeRecord::Integer madara::knowledge::containers::NativeIntegerVectorStaged::type |
trait that describes the value type
Definition at line 35 of file NativeIntegerVectorStaged.h.
madara::knowledge::containers::NativeIntegerVectorStaged::NativeIntegerVectorStaged | ( | const KnowledgeUpdateSettings & | settings = KnowledgeUpdateSettings () | ) |
Default constructor.
settings | settings for evaluating the vector |
Definition at line 4 of file NativeIntegerVectorStaged.cpp.
madara::knowledge::containers::NativeIntegerVectorStaged::NativeIntegerVectorStaged | ( | 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 13 of file NativeIntegerVectorStaged.cpp.
madara::knowledge::containers::NativeIntegerVectorStaged::NativeIntegerVectorStaged | ( | 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 33 of file NativeIntegerVectorStaged.cpp.
madara::knowledge::containers::NativeIntegerVectorStaged::NativeIntegerVectorStaged | ( | const NativeIntegerVectorStaged & | rhs | ) |
Copy constructor.
Definition at line 53 of file NativeIntegerVectorStaged.cpp.
|
virtual |
Destructor.
Definition at line 64 of file NativeIntegerVectorStaged.cpp.
|
virtual |
Clones this container.
Implements madara::knowledge::containers::BaseContainer.
Definition at line 75 of file NativeIntegerVectorStaged.cpp.
|
inline |
Copies the vector elements to an STL vector of Knowledge Records.
target | record values at this instance |
Definition at line 231 of file NativeIntegerVectorStaged.inl.
|
inline |
Exchanges the vector at this location with the vector at another location.
other | the other vector to exchange with |
Definition at line 186 of file NativeIntegerVectorStaged.inl.
|
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)
Definition at line 19 of file NativeIntegerVectorStaged.inl.
|
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)
Implements madara::knowledge::containers::BaseContainer.
Definition at line 37 of file NativeIntegerVectorStaged.inl.
|
inlineinherited |
Returns the name of the container.
Definition at line 5 of file BaseContainer.inl.
|
inherited |
Gets the update settings for the container.
Definition at line 37 of file BaseContainer.cpp.
|
inline |
Determines if the value of the vector is false.
Definition at line 322 of file NativeIntegerVectorStaged.inl.
|
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 81 of file NativeIntegerVectorStaged.cpp.
|
inline |
Determines if all values in the vector are true.
Definition at line 305 of file NativeIntegerVectorStaged.inl.
|
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 87 of file NativeIntegerVectorStaged.cpp.
|
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 9 of file NativeIntegerVectorStaged.inl.
|
inlineprivatevirtual |
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 93 of file NativeIntegerVectorStaged.cpp.
|
virtualinherited |
Modifies the container if the argument is false.
conditional | the container that must be false to modify |
Definition at line 64 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 44 of file BaseContainer.cpp.
|
inline |
Assignment operator.
rhs | value to copy |
Definition at line 44 of file NativeIntegerVectorStaged.inl.
|
inline |
Assignment operator.
rhs | value to copy |
Definition at line 61 of file NativeIntegerVectorStaged.inl.
|
inline |
Retrieves a copy of the record from the map.
index | the index of the variable entry |
Definition at line 243 of file NativeIntegerVectorStaged.inl.
|
inline |
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 71 of file NativeIntegerVectorStaged.inl.
|
inline |
Reads the value from the knowledge base.
Definition at line 328 of file NativeIntegerVectorStaged.inl.
|
inline |
Resizes the vector.
size | maximum size of the vector |
Definition at line 83 of file NativeIntegerVectorStaged.inl.
|
inline |
Sets a knowledge variable to a specified value.
index | index to set |
value | value to set at location |
Definition at line 254 of file NativeIntegerVectorStaged.inl.
|
inline |
Reads values from a STL vector of doubles.
value | array of doubles to set at the location |
Definition at line 265 of file NativeIntegerVectorStaged.inl.
|
inline |
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) |
sync | synchronize the value from the underlying knowledge |
Definition at line 99 of file NativeIntegerVectorStaged.inl.
|
inline |
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) |
sync | synchronize the value from the underlying knowledge |
Definition at line 128 of file NativeIntegerVectorStaged.inl.
|
inline |
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) |
sync | synchronize the value from the underlying knowledge |
Definition at line 157 of file NativeIntegerVectorStaged.inl.
|
inline |
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 275 of file NativeIntegerVectorStaged.inl.
|
inherited |
Sets the update settings for the container.
settings | the new settings to use |
Definition at line 28 of file BaseContainer.cpp.
|
inline |
Returns the size of the vector.
Definition at line 93 of file NativeIntegerVectorStaged.inl.
|
inline |
Retrieves a copy of the record from the vector.
index | the index of the variable entry |
Definition at line 289 of file NativeIntegerVectorStaged.inl.
|
inline |
Retrieves the entire vector as a native double array in a record.
Definition at line 298 of file NativeIntegerVectorStaged.inl.
|
inline |
Transfers elements from this vector to another.
other | the other vector to transfer to |
Definition at line 202 of file NativeIntegerVectorStaged.inl.
|
inline |
Writes the value to the knowledge base.
Definition at line 335 of file NativeIntegerVectorStaged.inl.
|
private |
Variable context that we are modifying.
Definition at line 297 of file NativeIntegerVectorStaged.h.
|
private |
Tracks if value_ has changed since last read.
Definition at line 312 of file NativeIntegerVectorStaged.h.
|
mutableprotectedinherited |
guard for access and changes
Mutex for local changes
Definition at line 141 of file BaseContainer.h.
|
protectedinherited |
Prefix of variable.
Definition at line 151 of file BaseContainer.h.
|
protectedinherited |
Settings for modifications.
Definition at line 156 of file BaseContainer.h.
|
private |
The staged value of the vector.
Definition at line 307 of file NativeIntegerVectorStaged.h.
|
private |
Reference to the size field of the vector space.
Definition at line 302 of file NativeIntegerVectorStaged.h.