Motorcortex Core  version: 2.7.6
Public Member Functions | Friends | List of all members
mcx::parameter_server::Parameter Class Reference
Inheritance diagram for mcx::parameter_server::Parameter:
Inheritance graph
[legend]
Collaboration diagram for mcx::parameter_server::Parameter:
Collaboration graph
[legend]

Public Member Functions

 Parameter (unsigned int size)
 
Parameter & operator= (const Parameter &)=delete
 
Parameter * create (const char *name, Parameter *parent, UserGroup user_group=default_group, uint32_t permissions=default_permissions)
 
Parameter * create (const char *name, size_t length, Parameter *parent, UserGroup user_group=default_group, uint32_t permissions=default_permissions)
 
void destroy ()
 
void print ()
 
bool hasChildren ()
 
Parameter * createPath (const char *name, UserGroup user_group=default_group, uint32_t permissions=default_permissions)
 
Parameter * createPath (const char *name, size_t length, UserGroup user_group=default_group, uint32_t permissions=default_permissions)
 
ParamHandle addParameter (const char *name, ParameterType param_type, uint32_t data_type_id, int data_type_size, Unit unit, void *origin_ptr, uint32_t origin_length=1, uint32_t input_buffer_length=DEFAULT_INPUT_BUFFER_LENGTH)
 
ParamHandle addParameter (Parameter *update_node, const char *name, ParameterType param_type, uint32_t data_type_id, int data_type_size, Unit unit, void *origin_ptr, uint32_t origin_length=1, uint32_t input_buffer_length=DEFAULT_INPUT_BUFFER_LENGTH)
 
SubHandle subscribe (const char *path, bool is_relative)
 
ReqHandle request (const char *path, bool is_relative)
 
PubHandle publish (const char *path, bool is_relative)
 
LinkHandle link (ParameterPath source, ParameterPath destination)
 
LinkHandle link (ParameterPath source, ParameterPath destination, double gain)
 
LinkHandle link (ParameterPath source, ParameterPath destination, double gain, double offset)
 
LinkHandle link (ParameterPath source, ParameterPath destination, double gain, double offset, bool inv_bool)
 
LinkHandle link (ParameterPath source, ParameterPath destination, double gain, double offset, bool inv_bool, bool clamp)
 
OverwriteHandle overwrite (const char *path, bool is_relative)
 
void setForceFlag (bool overwrite_active) override
 
void setUserGroup (UserGroup user_group, bool recursive) override
 
void setPermissions (Permission permission, bool recursive) override
 
bool addLink (Parameter *source_param, uint32_t src_el_offset, uint32_t src_el_count, uint32_t dst_el_offset, double gain, double offset, bool inv_bool, bool clamp, bool activate_now)
 
void activateLink (bool flag) override
 
bool checkPermissions (UserGroup user_group, uint32_t permissions)
 
Parameter * getParameter (const char *path, bool is_relative)
 
Parameter * getParameter (const char *path, int length, bool is_relative)
 
void force (const void *in_data, uint32_t size) override
 
void write (const void *in_data, uint32_t size) override
 
void force (const void *in_data, uint32_t offset, uint32_t size)
 
void write (const void *in_data, uint32_t offset, uint32_t size)
 
uint32_t read (void *out_data, uint32_t size, struct timespec *update_time) override
 
uint32_t read (DataContainer *data)
 
template<typename T , int number_of_param = 1>
bool setParameterValue (const char *relative_path, const T &in_data)
 
template<typename T >
bool setParameterValue (const char *relative_path, std::initializer_list< T > in_data)
 
const ParameterInfo & getInfo () const override
 
size_t getSize () const override
 
size_t getMaxSize () const override
 
uint32_t getTotalNumberOfNodes ()
 
uint32_t getTotalNumberOfParams ()
 
param_map_t * getChildren ()
 
Parameter * getParent ()
 
void updateLink ()
 
void updateInput ()
 
void overwriteInput ()
 
void overwriteOutput ()
 
void updateOutput (const struct timespec &app_time)
 
void processActions ()
 
uint32_t addRequest () override
 
uint32_t getReplyId () override
 
void startPublisher ()
 
void stopPublisher ()
 
bool hasActions ()
 
bool isInputUpdated ()
 
bool isLinkUpdated ()
 
bool isOverwriteOutputUpdated ()
 
bool isOverwriteInputUpdated ()
 
bool isOutputUpdated ()
 
bool compareAndSwapUpdateCounter (uint32_t &last_update_counter) override
 
uint32_t getOutputCounter ()
 
void setUpdateOutputFlag (bool newval) override
 
void setUpdateOutputOnceFlag (uint32_t length) override
 
void setUpdateOutputOnInputFlag (bool newval) override
 

Friends

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