mcx::parameter_server::Parameter

mcx::parameter_server::Parameter

Inherits from mcx::parameter_server::ParameterBase

Public Functions

Name
Parameter()
Parameter(unsigned int size)
virtual ~Parameter()
Parameter & operator=(const Parameter & ) =delete
Parameter * create(const char * name, Parameter * parent, UserGroup user_group =default_group, uint32_t permissions =default_permissions) =default
Parameter * create(const char * name, size_t length, Parameter * parent, UserGroup user_group =default_group, uint32_t permissions =default_permissions) =default
void destroy()
void print()
bool hasChildren()
Parameter * createPath(const char * name, UserGroup user_group =default_group, uint32_t permissions =default_permissions) =default
Parameter * createPath(const char * name, size_t length, UserGroup user_group =default_group, uint32_t permissions =default_permissions) =default
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)
virtual void setForceFlag(bool overwrite_active) override
virtual void setUserGroup(UserGroup user_group, bool recursive) override
virtual 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)
virtual 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)
virtual void force(const void * in_data, uint32_t size) override
virtual 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)
virtual 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)
virtual const ParameterInfo & getInfo() const override
virtual size_t getSize() const override
virtual 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()
virtual uint32_t addRequest() override
virtual uint32_t getReplyId() override
void startPublisher()
void stopPublisher()
bool hasActions()
bool isInputUpdated()
bool isLinkUpdated()
bool isOverwriteOutputUpdated()
bool isOverwriteInputUpdated()
bool isOutputUpdated()
virtual bool compareAndSwapUpdateCounter(uint32_t & last_update_counter) override
uint32_t getOutputCounter()
virtual void setUpdateOutputFlag(bool newval) override
virtual void setUpdateOutputOnceFlag(uint32_t length) override
virtual void setUpdateOutputOnInputFlag(bool newval) override

Friends

Name
class RingBufferManager

Public Functions Documentation

function Parameter

Parameter()

function Parameter

explicit Parameter(
    unsigned int size
)

function ~Parameter

virtual ~Parameter()

function operator=

Parameter & operator=(
    const Parameter & 
) =delete

function create

Parameter * create(
    const char * name,
    Parameter * parent,
    UserGroup user_group =default_group,
    uint32_t permissions =default_permissions
) =default

function create

Parameter * create(
    const char * name,
    size_t length,
    Parameter * parent,
    UserGroup user_group =default_group,
    uint32_t permissions =default_permissions
) =default

function destroy

void destroy()

function print

void print()

function hasChildren

bool hasChildren()

function createPath

Parameter * createPath(
    const char * name,
    UserGroup user_group =default_group,
    uint32_t permissions =default_permissions
) =default

function createPath

Parameter * createPath(
    const char * name,
    size_t length,
    UserGroup user_group =default_group,
    uint32_t permissions =default_permissions
) =default

function addParameter

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
)

function addParameter

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
)

function subscribe

SubHandle subscribe(
    const char * path,
    bool is_relative
)

function request

ReqHandle request(
    const char * path,
    bool is_relative
)

function publish

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
)

function overwrite

OverwriteHandle overwrite(
    const char * path,
    bool is_relative
)

function setForceFlag

virtual void setForceFlag(
    bool overwrite_active
) override

Reimplements: mcx::parameter_server::ParameterBase::setForceFlag

function setUserGroup

virtual void setUserGroup(
    UserGroup user_group,
    bool recursive
) override

Reimplements: mcx::parameter_server::ParameterBase::setUserGroup

function setPermissions

virtual void setPermissions(
    Permission permission,
    bool recursive
) override

Reimplements: mcx::parameter_server::ParameterBase::setPermissions

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
)
virtual void activateLink(
    bool flag
) override

Reimplements: mcx::parameter_server::ParameterBase::activateLink

function checkPermissions

bool checkPermissions(
    UserGroup user_group,
    uint32_t permissions
)

function getParameter

Parameter * getParameter(
    const char * path,
    bool is_relative
)

function getParameter

Parameter * getParameter(
    const char * path,
    int length,
    bool is_relative
)

function force

virtual void force(
    const void * in_data,
    uint32_t size
) override

Reimplements: mcx::parameter_server::ParameterBase::force

function write

virtual void write(
    const void * in_data,
    uint32_t size
) override

Reimplements: mcx::parameter_server::ParameterBase::write

function force

void force(
    const void * in_data,
    uint32_t offset,
    uint32_t size
)

function write

void write(
    const void * in_data,
    uint32_t offset,
    uint32_t size
)

function read

virtual uint32_t read(
    void * out_data,
    uint32_t size,
    struct timespec * update_time
) override

Reimplements: mcx::parameter_server::ParameterBase::read

function read

uint32_t read(
    DataContainer * data
)

function setParameterValue

template <typename T ,
int number_of_param =1>
bool setParameterValue(
    const char * relative_path,
    const T & in_data
)

function setParameterValue

template <typename T >
bool setParameterValue(
    const char * relative_path,
    std::initializer_list< T > in_data
)

function getInfo

inline virtual const ParameterInfo & getInfo() const override

Reimplements: mcx::parameter_server::ParameterBase::getInfo

function getSize

virtual size_t getSize() const override

Reimplements: mcx::parameter_server::ParameterBase::getSize

function getMaxSize

virtual size_t getMaxSize() const override

Reimplements: mcx::parameter_server::ParameterBase::getMaxSize

function getTotalNumberOfNodes

uint32_t getTotalNumberOfNodes()

function getTotalNumberOfParams

uint32_t getTotalNumberOfParams()

function getChildren

param_map_t * getChildren()

function getParent

Parameter * getParent()
void updateLink()

function updateInput

void updateInput()

function overwriteInput

void overwriteInput()

function overwriteOutput

void overwriteOutput()

function updateOutput

void updateOutput(
    const struct timespec & app_time
)

function processActions

void processActions()

function addRequest

virtual uint32_t addRequest() override

Reimplements: mcx::parameter_server::ParameterBase::addRequest

function getReplyId

virtual uint32_t getReplyId() override

Reimplements: mcx::parameter_server::ParameterBase::getReplyId

function startPublisher

void startPublisher()

function stopPublisher

void stopPublisher()

function hasActions

bool hasActions()

function isInputUpdated

bool isInputUpdated()

function isLinkUpdated

bool isLinkUpdated()

function isOverwriteOutputUpdated

bool isOverwriteOutputUpdated()

function isOverwriteInputUpdated

bool isOverwriteInputUpdated()

function isOutputUpdated

bool isOutputUpdated()

function compareAndSwapUpdateCounter

virtual bool compareAndSwapUpdateCounter(
    uint32_t & last_update_counter
) override

Reimplements: mcx::parameter_server::ParameterBase::compareAndSwapUpdateCounter

function getOutputCounter

uint32_t getOutputCounter()

function setUpdateOutputFlag

virtual void setUpdateOutputFlag(
    bool newval
) override

Reimplements: mcx::parameter_server::ParameterBase::setUpdateOutputFlag

function setUpdateOutputOnceFlag

virtual void setUpdateOutputOnceFlag(
    uint32_t length
) override

Reimplements: mcx::parameter_server::ParameterBase::setUpdateOutputOnceFlag

function setUpdateOutputOnInputFlag

virtual void setUpdateOutputOnInputFlag(
    bool newval
) override

Reimplements: mcx::parameter_server::ParameterBase::setUpdateOutputOnInputFlag

Friends

friend RingBufferManager

friend class RingBufferManager(
    RingBufferManager 
);

Updated on 2022-04-05 at 16:21:27 +0200