horizon::Board Class Reference

Inheritance diagram for horizon::Board:

Classes
class	StackupLayer
class	UserLayer
struct	Outline

Public Types
enum class	OutputFormat { GERBER , ODB }
enum class	UserLayerOrder : int { ABOVE = 1 , BELOW = -1 }
enum	ExpandFlags {   EXPAND_NONE = 0 , EXPAND_ALL = 0xff , EXPAND_PROPAGATE_NETS = (1 << 0) , EXPAND_AIRWIRES = (1 << 1) ,   EXPAND_PACKAGES = (1 << 2) , EXPAND_VIAS = (1 << 3) , EXPAND_ALL_AIRWIRES = (1 << 4) }
Public Types inherited from horizon::LayerProvider
enum class	LayerSortOrder { TOP_TO_BOTTOM , BOTTOM_TO_TOP }

Public Member Functions
	Board (const UUID &uu, const json &, Block &block, IPool &pool, const std::string &board_directory)
	Board (const UUID &uu, Block &block)
void	expand ()
void	expand_some ()
	Board (const Board &brd)
	Board (shallow_copy_t sh, const Board &brd)
void	operator= (const Board &brd)=delete
void	update_refs ()
void	update_junction_connections ()
void	update_airwires (bool fast, const std::set< UUID > &nets)
void	disconnect_package (BoardPackage *pkg)
void	smash_package (BoardPackage *pkg)
void	unsmash_package (BoardPackage *pkg)
void	smash_package_silkscreen_graphics (BoardPackage *pkg)
void	smash_package_outline (BoardPackage &pkg)
void	smash_panel_outline (BoardPanel &panel)
Junction *	get_junction (const UUID &uu) override
Polygon *	get_polygon (const UUID &uu) override
const std::map< int, Layer > &	get_layers () const override
void	set_n_inner_layers (unsigned int n)
unsigned int	get_n_inner_layers () const
void	update_plane (Plane *plane, const class CanvasPatch *ca=nullptr, const class CanvasPads *ca_pads=nullptr, plane_update_status_cb_t status_cb=nullptr, const std::atomic_bool &cancel=std::atomic_bool(false))
void	update_planes (plane_update_status_cb_t status_cb=nullptr, const std::atomic_bool &cancel=std::atomic_bool(false))
std::vector< KeepoutContour >	get_keepout_contours () const
std::pair< Coordi, Coordi >	get_bbox () const
void	update_pdf_export_settings (PDFExportSettings &settings)
std::map< const BoardPackage *, PnPRow >	get_PnP (const PnPExportSettings &settings) const
const std::map< int, UserLayer > &	get_user_layers () const
int	add_user_layer (int other_layer, UserLayerOrder pos)
void	delete_user_layer (int user_layer)
unsigned int	count_available_user_layers () const
void	move_user_layer (int user_layer, int other_layer, UserLayerOrder pos)
void	set_user_layer_name (int user_layer, const std::string &name)
void	set_user_layer_type (int user_layer, UserLayer::Type type)
void	set_user_layer_color (int user_layer, int layer_color)
json	serialize () const
json	serialize_planes () const
void	load_planes (const json &j)
void	load_planes_from_file (const std::string &filename)
void	save_planes (const std::string &filename)
void	save_pictures (const std::string &dir) const
void	load_pictures (const std::string &dir)
ItemSet	get_pool_items_used () const
void	flip_package_layer (int &layer) const
int	get_package_layer (bool flip, int layer) const
ParameterSet	get_parameters () const
Outline	get_outline () const
Outline	get_outline_and_errors () const
std::set< LayerRange >	get_drill_spans () const
Public Member Functions inherited from horizon::LayerProvider
std::vector< Layer >	get_layers_sorted (LayerSortOrder order) const
std::string	get_layer_name (const class LayerRange &layer) const
std::set< int >	get_layers_for_range (const class LayerRange &layer) const
int	get_adjacent_layer (int layer, int dir) const
int	get_color_layer (int layer) const
double	get_layer_position (int layer) const

Static Public Member Functions
static Board	new_from_file (const std::string &filename, Block &block, IPool &pool)
static unsigned int	get_app_version ()

Public Attributes
UUID	uuid
Block *	block
std::string	name
std::map< UUID, Polygon >	polygons
std::map< UUID, BoardHole >	holes
std::map< UUID, BoardPackage >	packages
std::map< UUID, BoardJunction >	junctions
std::map< UUID, Track >	tracks
std::map< UUID, Via >	vias
std::map< UUID, Text >	texts
std::map< UUID, Line >	lines
std::map< UUID, Arc >	arcs
std::map< UUID, Plane >	planes
std::map< UUID, Keepout >	keepouts
std::map< UUID, Dimension >	dimensions
std::map< UUID, ConnectionLine >	connection_lines
std::map< UUID, IncludedBoard >	included_boards
std::map< UUID, BoardPanel >	board_panels
std::map< UUID, Picture >	pictures
std::map< UUID, BoardDecal >	decals
std::map< UUID, BoardNetTie >	net_ties
std::vector< Warning >	warnings
OutputFormat	output_format = OutputFormat::GERBER
BoardRules	rules
GerberOutputSettings	gerber_output_settings
ODBOutputSettings	odb_output_settings
GridSettings	grid_settings
std::map< UUID, std::list< Airwire > >	airwires
std::map< int, StackupLayer >	stackup
BoardColors	colors
PDFExportSettings	pdf_export_settings
STEPExportSettings	step_export_settings
PnPExportSettings	pnp_export_settings
FileVersion	version
ExpandFlags	expand_flags = EXPAND_ALL
std::set< UUID >	airwires_expand
std::string	board_directory

Static Public Attributes
static const LutEnumStr< OutputFormat >	output_format_lut

Member Function Documentation

get_junction()

Junction * horizon::Board::get_junction ( const UUID & uu )

overridevirtual

Reimplemented from horizon::ObjectProvider.

get_layers()

const std::map< int, Layer > & horizon::Board::get_layers ( ) const

overridevirtual

Reimplemented from horizon::LayerProvider.

get_polygon()

Polygon * horizon::Board::get_polygon ( const UUID & uu )

overridevirtual

Reimplemented from horizon::ObjectProvider.

Member Data Documentation

output_format_lut

const LutEnumStr< Board::OutputFormat > horizon::Board::output_format_lut

static

Initial value:

= {
        {"gerber", Board::OutputFormat::GERBER},
        {"odb", Board::OutputFormat::ODB},
}

---

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

• src/board/board.hpp
• src/board/airwires.cpp
• src/board/board.cpp
• src/board/plane_update.cpp