REDAC HybridController
Firmware for LUCIDAC/REDAC Teensy
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
platform::REDACBackPanel Class Reference

#include <back_panel.h>

Inheritance diagram for platform::REDACBackPanel:
Inheritance graph
[legend]
Collaboration diagram for platform::REDACBackPanel:
Collaboration graph
[legend]

Public Member Functions

utils::status config_self_from_json (JsonObjectConst cfg) override
 Deserialize a new configuration for this entity from a JsonObject.
 
metadata::eui_t get_entity_eui () const override
 
Entity * get_child_entity (const std::string &child_id) override
 
std::vector< Entity * > get_child_entities () override
 
 REDACBackPanel (BackPanelHAL *hardware)
 
uint16_t read_backplane_and_slot_id () const
 
- 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
 
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.
 

Static Public Member Functions

static REDACBackPanel * from_entity_classifier (entities::EntityClassifier classifier, __attribute__((__unused__)) bus::addr_t block_address)
 

Static Public Attributes

static constexpr auto CLASS_ = entities::EntityClass::BACK_PANEL
 

Additional Inherited Members

- 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.
 
- Protected Attributes inherited from entities::Entity
std::string entity_id
 
EntityClassifier classifier
 

Detailed Description

Definition at line 47 of file back_panel.h.

Constructor & Destructor Documentation

◆ REDACBackPanel()

FLASHMEM platform::REDACBackPanel::REDACBackPanel ( platform::BackPanelHAL * hardware)
explicit

Definition at line 37 of file back_panel.cpp.

References CLASS_, and entities::Entity::classifier.

Member Function Documentation

◆ config_self_from_json()

utils::status platform::REDACBackPanel::config_self_from_json ( JsonObjectConst cfg)
inlineoverridevirtual

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 55 of file back_panel.h.

References utils::status::success().

◆ from_entity_classifier()

FLASHMEM platform::REDACBackPanel * platform::REDACBackPanel::from_entity_classifier ( entities::EntityClassifier classifier,
__attribute__((__unused__)) bus::addr_t block_address )
static

Definition at line 16 of file back_panel.cpp.

◆ get_child_entities()

std::vector< Entity * > platform::REDACBackPanel::get_child_entities ( )
inlineoverridevirtual

Implements entities::Entity.

Definition at line 61 of file back_panel.h.

◆ get_child_entity()

Entity * platform::REDACBackPanel::get_child_entity ( const std::string & child_id)
inlineoverridevirtual

Implements entities::Entity.

Definition at line 59 of file back_panel.h.

◆ get_entity_eui()

FLASHMEM metadata::eui_t platform::REDACBackPanel::get_entity_eui ( ) const
overridevirtual

Implements entities::Entity.

Definition at line 27 of file back_panel.cpp.

◆ read_backplane_and_slot_id()

FLASHMEM uint16_t platform::REDACBackPanel::read_backplane_and_slot_id ( ) const

Definition at line 32 of file back_panel.cpp.

Member Data Documentation

◆ CLASS_

auto platform::REDACBackPanel::CLASS_ = entities::EntityClass::BACK_PANEL
staticconstexpr

Definition at line 50 of file back_panel.h.

Referenced by REDACBackPanel().

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