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:

Public Member Functions
	BLOCK_BASE (uint8_t aBlockType, size_t aOffset)
virtual	~BLOCK_BASE ()=default
uint8_t	GetBlockType () const
size_t	GetOffset () const
uint32_t	GetKey () const

Private Attributes
uint8_t	m_blockType
size_t	m_offset

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

References m_blockType, 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

Definition at line 62 of file allegro_pcb_structs.h.

References m_blockType.

Referenced by ALLEGRO::BOARD_BUILDER::applyZoneFills(), ALLEGRO::BOARD_BUILDER::buildSegmentChain(), ALLEGRO::BRD_DB::OBJ_FACTORY::CreateObject(), ALLEGRO::BOARD_BUILDER::expectBlockByKey(), GetBlockKey(), GetPrimaryNext(), PadGetNextInFootprint(), ALLEGRO::BOARD_BUILDER::resolveConstraintSetNameFromField(), ALLEGRO::BOARD_BUILDER::resolveMatchGroupName(), and TestOlympus0x20().

GetKey()

uint32_t BLOCK_BASE::GetKey

(

)

const

Definition at line 101 of file allegro_db.cpp.

References GetBlockKey().

Referenced by PadGetNextInFootprint().

GetOffset()

size_t ALLEGRO::BLOCK_BASE::GetOffset ( ) const

inline

Definition at line 63 of file allegro_pcb_structs.h.

References m_offset.

Referenced by ALLEGRO::BRD_DB::OBJ_FACTORY::CreateObject(), ALLEGRO::BOARD_BUILDER::expectBlockByKey(), and PadGetNextInFootprint().

Member Data Documentation

m_blockType

uint8_t ALLEGRO::BLOCK_BASE::m_blockType

private

Definition at line 69 of file allegro_pcb_structs.h.

Referenced by BLOCK_BASE(), and GetBlockType().

m_offset

size_t ALLEGRO::BLOCK_BASE::m_offset

private

Definition at line 70 of file allegro_pcb_structs.h.

Referenced by BLOCK_BASE(), and GetOffset().

---

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

• allegro_pcb_structs.h
• allegro_db.cpp