KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Public Member Functions | Private Attributes | List of all members
ALLEGRO::BLOCK_BASE Class Reference

The base class for all blocks in the main body of an Allegro file. More...

#include <allegro_pcb_structs.h>

Inheritance diagram for ALLEGRO::BLOCK_BASE:
ALLEGRO::BLOCK< T >

Public Member Functions

 BLOCK_BASE (uint8_t aBlockType, size_t aOffset)
 
virtual ~BLOCK_BASE ()=default
 
uint8_t GetBlockType () const
 This is the actual type code as read from the file.
 
size_t GetOffset () const
 
uint32_t GetKey () const
 
uint32_t GetNext () const
 
void SetKey (uint32_t aKey)
 
void SetNext (uint32_t aNext)
 

Private Attributes

uint8_t m_blockType
 
size_t m_offset
 
uint32_t m_Key
 
uint32_t m_Next
 

Detailed Description

The base class for all blocks in the main body of an Allegro file.

This records metadata about the block, such as its type and offset in the file.

In the file format, blocks do not seem to know their own length, so it's very important that each block type gets this right, or the next block will not be read properly and everything will fall apart.

Definition at line 54 of file allegro_pcb_structs.h.

Constructor & Destructor Documentation

◆ BLOCK_BASE()

ALLEGRO::BLOCK_BASE::BLOCK_BASE ( uint8_t aBlockType,
size_t aOffset )
inline

Definition at line 57 of file allegro_pcb_structs.h.

References m_blockType, m_Key, m_Next, and m_offset.

Referenced by ALLEGRO::BLOCK< T >::BLOCK().

◆ ~BLOCK_BASE()

virtual ALLEGRO::BLOCK_BASE::~BLOCK_BASE ( )
virtualdefault

Member Function Documentation

◆ GetBlockType()

uint8_t ALLEGRO::BLOCK_BASE::GetBlockType ( ) const
inline

This is the actual type code as read from the file.

Some BLOCKs have multiple valid type codes (e.g. segments).

Definition at line 72 of file allegro_pcb_structs.h.

References m_blockType.

Referenced by ALLEGRO::BlockDataAs(), ALLEGRO::BOARD_BUILDER::buildGraphicItems(), ALLEGRO::BOARD_BUILDER::buildSegmentChain(), ALLEGRO::BOARD_BUILDER::buildZone(), ALLEGRO::BOARD_BUILDER::expectBlockByKey(), PadGetNextInFootprint(), ALLEGRO::BOARD_BUILDER::resolveConstraintSetNameFromField(), ALLEGRO::BOARD_BUILDER::resolveMatchGroupName(), ALLEGRO::BOARD_BUILDER::shapeToPolySet(), ALLEGRO::TYPED_LL_WALKER< T >::ITERATOR::skipMismatches(), TestBeagleBoneAI_PS_200C125D(), TestBeagleBoneBlack_0x0F_SlotG1(), TestBeagleBoneBlack_PS_120X040SLOT(), TestCutiePiV166_PS_C50H340M700N(), TestOlympus0x20(), TestOpenBreath_0x0F_SlotAM4096_G1(), TestParallellaV163_PS_28C128N(), TestParallellaV163_PS_56X55RT(), TestParallellaV163_PS_P65X1P7SLT(), ALLEGRO::BOARD_BUILDER::tryBuildZoneShape(), and tryLayerFromBlock().

◆ GetKey()

uint32_t ALLEGRO::BLOCK_BASE::GetKey ( ) const
inline

Definition at line 76 of file allegro_pcb_structs.h.

References m_Key.

Referenced by ALLEGRO::BOARD_BUILDER::buildZone(), and PadGetNextInFootprint().

◆ GetNext()

uint32_t ALLEGRO::BLOCK_BASE::GetNext ( ) const
inline

Definition at line 78 of file allegro_pcb_structs.h.

References m_Next.

Referenced by ALLEGRO::GetPrimaryNext().

◆ GetOffset()

size_t ALLEGRO::BLOCK_BASE::GetOffset ( ) const
inline

Definition at line 73 of file allegro_pcb_structs.h.

References m_offset.

Referenced by ALLEGRO::BOARD_BUILDER::createTracks(), ALLEGRO::BOARD_BUILDER::expectBlockByKey(), and PadGetNextInFootprint().

◆ SetKey()

void ALLEGRO::BLOCK_BASE::SetKey ( uint32_t aKey)
inline

Definition at line 80 of file allegro_pcb_structs.h.

References m_Key.

◆ SetNext()

void ALLEGRO::BLOCK_BASE::SetNext ( uint32_t aNext)
inline

Definition at line 81 of file allegro_pcb_structs.h.

References m_Next.

Member Data Documentation

◆ m_blockType

uint8_t ALLEGRO::BLOCK_BASE::m_blockType
private

Definition at line 84 of file allegro_pcb_structs.h.

Referenced by BLOCK_BASE(), and GetBlockType().

◆ m_Key

uint32_t ALLEGRO::BLOCK_BASE::m_Key
private

Definition at line 86 of file allegro_pcb_structs.h.

Referenced by BLOCK_BASE(), GetKey(), and SetKey().

◆ m_Next

uint32_t ALLEGRO::BLOCK_BASE::m_Next
private

Definition at line 87 of file allegro_pcb_structs.h.

Referenced by BLOCK_BASE(), GetNext(), and SetNext().

◆ m_offset

size_t ALLEGRO::BLOCK_BASE::m_offset
private

Definition at line 85 of file allegro_pcb_structs.h.

Referenced by BLOCK_BASE(), and GetOffset().

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