A function block represents one module in a cluster, such as an M-Block, C-Block, I-Block or U-Block. More...

#include <base.h>

Inheritance diagram for blocks::FunctionBlock:

Collaboration diagram for blocks::FunctionBlock:

Public Member Functions
	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)

virtual utils::status	write_to_hardware ()
	returns true in case of success

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.

Additional Inherited Members
Protected Member Functions inherited from entities::Entity
virtual utils::status	config_self_from_json (JsonObjectConst cfg)=0
	Deserialize a new configuration for this entity from a JsonObject.

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.

Protected Attributes inherited from entities::Entity
std::string	entity_id

EntityClassifier	classifier

Detailed Description

A function block represents one module in a cluster, such as an M-Block, C-Block, I-Block or U-Block.

This class (or its children) typically holds the in-RAM representation of the configuration space of the particular hardware and serves as the primary programming interface.

Definition at line 29 of file base.h.

Constructor & Destructor Documentation

◆ FunctionBlock()

blocks::FunctionBlock::FunctionBlock ( std::string entity_id )

inline

Definition at line 31 of file base.h.

Member Function Documentation

◆ get_child_entities()

std::vector< Entity * > blocks::FunctionBlock::get_child_entities ( )

inlineoverridevirtual

Implements entities::Entity.

Definition at line 33 of file base.h.

◆ get_child_entity()

Entity * blocks::FunctionBlock::get_child_entity ( const std::string & child_id )

inlineoverridevirtual

Implements entities::Entity.

Definition at line 41 of file base.h.

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

lib/platform-lucidac/src/block/base.h