Speeduino
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
entity_t Struct Reference

#include <pages.h>

Inheritance diagram for entity_t:
Inheritance graph
[legend]
Collaboration diagram for entity_t:
Collaboration graph
[legend]

Public Member Functions

constexpr entity_t (void)
 
constexpr entity_t (EntityType theType, uint16_t theSize)
 
constexpr entity_t (table3d_t *table, TableType key, uint16_t theSize)
 
constexpr entity_t (config_page_t *entity, uint16_t theSize)
 
bool isEntityAddressWithin (uint16_t entityAddress) const
 

Public Attributes

EntityType type
 The entity type.
 
union { 
 
   table3d_t *   pTable 
 If the entity is a table, this points to the table. More...
 
   config_page_t *   pRaw 
 If the entity is a raw block, this points to it. More...
 
};  
 
TableType table_key = TableType::table_type_None
 If the entity is a table, this can be used to get the table type.
 
uint16_t size = 0U
 Size of the entity in bytes on the page
 

Constructor & Destructor Documentation

◆ entity_t() [1/4]

constexpr entity_t::entity_t ( void  )
inlineconstexpr

◆ entity_t() [2/4]

constexpr entity_t::entity_t ( EntityType  theType,
uint16_t  theSize 
)
inlineexplicitconstexpr

◆ entity_t() [3/4]

constexpr entity_t::entity_t ( table3d_t table,
TableType  key,
uint16_t  theSize 
)
inlineexplicitconstexpr

◆ entity_t() [4/4]

constexpr entity_t::entity_t ( config_page_t entity,
uint16_t  theSize 
)
inlineexplicitconstexpr

Member Function Documentation

◆ isEntityAddressWithin()

bool entity_t::isEntityAddressWithin ( uint16_t  entityAddress) const
inline
Here is the call graph for this function:
Here is the caller graph for this function:

Member Data Documentation

◆ [union]

union { ... } entity_t

◆ pRaw

config_page_t* entity_t::pRaw

If the entity is a raw block, this points to it.

◆ pTable

table3d_t* entity_t::pTable

If the entity is a table, this points to the table.

◆ size

uint16_t entity_t::size = 0U

Size of the entity in bytes on the page

◆ table_key

TableType entity_t::table_key = TableType::table_type_None

If the entity is a table, this can be used to get the table type.

◆ type

EntityType entity_t::type

The entity type.


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