blocks::EmptyMBlock Class Reference

#include <mblock.h>

Inheritance diagram for blocks::EmptyMBlock:

Collaboration diagram for blocks::EmptyMBlock:

Public Member Functions
utils::status	write_to_hardware () override
	returns true in case of success
	MBlock (SLOT slot, MBlockHAL *hardware)
Public Member Functions inherited from blocks::MBlock
bool	is_entity_type (TYPES type_)
	MBlock (SLOT slot, MBlockHAL *hardware)
uint8_t	slot_to_global_io_index (uint8_t local) const
virtual bool	calibrate (platform::Cluster *cluster, carrier::Carrier *carrier)
void	overload_flags_to_json (JsonArray msg_out) const
Public Member Functions inherited from blocks::FunctionBlock
	FunctionBlock (std::string entity_id)
std::vector< Entity * >	get_child_entities () override
Entity *	get_child_entity (const std::string &child_id) override
Public Member Functions inherited from entities::Entity
	Entity ()=default
	Entity (std::string entityId)
const std::string &	get_entity_id () const
void	rename_entity (const std::string entityId)
EntityClassifier	get_entity_classifier () const
EntityClass	get_entity_class () const
uint8_t	get_entity_type () const
Version	get_entity_version () const
uint8_t	get_entity_variant () const
virtual metadata::eui_t	get_entity_eui () const =0
bool	is_entity_class (EntityClass class_) const
bool	is_entity_type (uint8_t type_) const
bool	is_entity_version (Version version_) const
bool	is_entity_variant (uint8_t variant_) const
Entity *	resolve_child_entity (std::string paths[], size_t len)
Entity *	resolve_child_entity (JsonArrayConstIterator begin, JsonArrayConstIterator end)
Entity *	resolve_child_entity (JsonArrayConst path)
virtual bool	init ()
	returns true in case of success
virtual void	reset (ResetAction action)
utils::status	config_from_json (JsonObjectConst cfg)
	Deserialize a new configuration for this entity and all its children from a JsonObject.
void	config_to_json (JsonObject &cfg, bool recursive=true)
	Serialize the configuration for this entity to a JsonObject.
utils::status	user_set_config (JsonObjectConst msg_in, JsonObject &msg_out)
utils::status	user_get_config (JsonObjectConst msg_in, JsonObject &msg_out)
utils::status	user_reset_config (JsonObjectConst msg_in, JsonObject &msg_out)
void	classifier_to_json (JsonObject &out)
	Provide recursive entity information in a tree.

Protected Member Functions
utils::status	config_self_from_json (JsonObjectConst cfg) override
	Deserialize a new configuration for this entity from a JsonObject.
Protected Member Functions inherited from entities::Entity
utils::status	config_children_from_json (JsonObjectConst &cfg)
	Deserialize a new configuration for all child entities from a JsonObject.
virtual void	config_self_to_json (JsonObject &cfg)
	Serialize the configuration of this entity to a JsonObject.
void	config_children_to_json (JsonObject &cfg)
	Serialize the configuration of the child entities of this entity to a JsonObject.

Additional Inherited Members
Public Types inherited from blocks::MBlock
enum class	TYPES : uint8_t { UNKNOWN = 0 , M_INT8_BLOCK = 1 , M_MUL4_BLOCK = 2 }
enum class	SLOT : uint8_t { M0 = 0 , M1 = 1 }
Static Public Member Functions inherited from blocks::MBlock
static MBlock *	from_entity_classifier (entities::EntityClassifier classifier, bus::addr_t block_address)
static constexpr std::array< uint8_t, 8 >	SLOT_INPUT_IDX_RANGE ()
static constexpr std::array< uint8_t, 8 >	SLOT_OUTPUT_IDX_RANGE ()
template<int n>
static constexpr uint8_t	M0_INPUT ()
	M0 input signal specifier for hard-coded usage, like MBlock::M0_INPUT<3>().
static constexpr uint8_t	M0_INPUT (uint8_t idx)
	M0 input signal specifier for dynamic usage, like MBlock::M0_INPUT(variable).
template<int n>
static constexpr uint8_t	M0_OUTPUT ()
	M0 output signal specifier for hard-coded usage, like MBlock::M0_OUTPUT<3>().
static constexpr uint8_t	M0_OUTPUT (uint8_t idx)
	M0 output signal specifier for dynamic usage, like MBlock::M0_OUTPUT(variable).
template<int n>
static constexpr uint8_t	M1_INPUT ()
	M1 input signal specifier for hard-coded usage, like MBlock::M1_INPUT<3>().
static constexpr uint8_t	M1_INPUT (uint8_t idx)
	M1 input signal specifier for dynamic usage, like MBlock::M1_INPUT(variable).
template<int n>
static constexpr uint8_t	M1_OUTPUT ()
	M1 output signal specifier for hard-coded usage, like MBlock::M1_OUTPUT<3>().
static constexpr uint8_t	M1_OUTPUT (uint8_t idx)
	M1 output signal specifier for dynamic usage, like MBlock::M1_OUTPUT(variable).
Public Attributes inherited from blocks::MBlock
const SLOT	slot
MBlockHAL *	hardware
Static Public Attributes inherited from blocks::MBlock
static constexpr auto	CLASS_ = entities::EntityClass::M_BLOCK
static constexpr uint8_t	M0_IDX = bus::M0_BLOCK_IDX
static constexpr uint8_t	M1_IDX = bus::M1_BLOCK_IDX
Protected Attributes inherited from entities::Entity
std::string	entity_id
EntityClassifier	classifier

Detailed Description

Definition at line 116 of file mblock.h.

Member Function Documentation

config_self_from_json()

FLASHMEM utils::status blocks::EmptyMBlock::config_self_from_json ( JsonObjectConst cfg )

overrideprotectedvirtual

Deserialize a new configuration for this entity from a JsonObject.

Implementations shall not traverse to children,

See also

config_children_from_json() instead.

Returns

true in case of success, else false

Implements entities::Entity.

Definition at line 71 of file mblock.cpp.

References utils::status::success().

MBlock()

FLASHMEM blocks::MBlock::MBlock ( SLOT slot, MBlockHAL * hardware )

explicit

Definition at line 105 of file mblock.cpp.

write_to_hardware()

FLASHMEM utils::status blocks::EmptyMBlock::write_to_hardware ( )

overridevirtual

returns true in case of success

Reimplemented from entities::Entity.

Definition at line 69 of file mblock.cpp.

References utils::status::success().

---

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

• lib/platform-lucidac/src/block/mblock.h
• lib/platform-lucidac/src/block/mblock.cpp