Class BOARD_DESIGN_SETTINGS contains design settings for a BOARD object. More...

#include <board_design_settings.h>

Public Member Functions
	BOARD_DESIGN_SETTINGS ()

NETCLASSPTR	GetDefault () const
	Function GetDefault. More...

const wxString &	GetCurrentNetClassName () const
	Function GetCurrentNetClassName. More...

bool	UseNetClassTrack () const
	Function UseNetClassTrack returns true if netclass values should be used to obtain appropriate track width. More...

bool	UseNetClassVia () const
	Function UseNetClassVia returns true if netclass values should be used to obtain appropriate via size. More...

bool	SetCurrentNetClass (const wxString &aNetClassName)
	Function SetCurrentNetClass Must be called after a netclass selection (or after a netclass parameter change Initialize vias and tracks values displayed in comb boxes of the auxiliary toolbar and some others parameters (netclass name ....) More...

int	GetBiggestClearanceValue ()
	Function GetBiggestClearanceValue. More...

int	GetSmallestClearanceValue ()
	Function GetSmallestClearanceValue. More...

int	GetCurrentMicroViaSize ()
	Function GetCurrentMicroViaSize. More...

int	GetCurrentMicroViaDrill ()
	Function GetCurrentMicroViaDrill. More...

unsigned	GetTrackWidthIndex () const
	Function GetTrackWidthIndex. More...

void	SetTrackWidthIndex (unsigned aIndex)
	Function SetTrackWidthIndex sets the current track width list index to aIndex. More...

int	GetCurrentTrackWidth () const
	Function GetCurrentTrackWidth. More...

void	SetCustomTrackWidth (int aWidth)
	Function SetCustomTrackWidth Sets custom width for track (i.e. More...

int	GetCustomTrackWidth () const
	Function GetCustomTrackWidth. More...

unsigned	GetViaSizeIndex () const
	Function GetViaSizeIndex. More...

void	SetViaSizeIndex (unsigned aIndex)
	Function SetViaSizeIndex sets the current via size list index to aIndex. More...

int	GetCurrentViaSize () const
	Function GetCurrentViaSize. More...

void	SetCustomViaSize (int aSize)
	Function SetCustomViaSize Sets custom size for via diameter (i.e. More...

int	GetCustomViaSize () const
	Function GetCustomViaSize. More...

int	GetCurrentViaDrill () const
	Function GetCurrentViaDrill. More...

void	SetCustomViaDrill (int aDrill)
	Function SetCustomViaDrill Sets custom size for via drill (i.e. More...

int	GetCustomViaDrill () const
	Function GetCustomViaDrill. More...

void	UseCustomTrackViaSize (bool aEnabled)
	Function UseCustomTrackViaSize Enables/disables custom track/via size settings. More...

bool	UseCustomTrackViaSize () const
	Function UseCustomTrackViaSize. More...

LSET	GetVisibleLayers () const
	Function GetVisibleLayers returns a bit-mask of all the layers that are visible. More...

void	SetVisibleAlls ()
	Function SetVisibleAlls Set the bit-mask of all visible elements categories, including enabled layers. More...

void	SetVisibleLayers (LSET aMask)
	Function SetVisibleLayers changes the bit-mask of visible layers. More...

bool	IsLayerVisible (PCB_LAYER_ID aLayerId) const
	Function IsLayerVisible tests whether a given layer is visible. More...

void	SetLayerVisibility (PCB_LAYER_ID aLayerId, bool aNewState)
	Function SetLayerVisibility changes the visibility of a given layer. More...

int	GetVisibleElements () const
	Function GetVisibleElements returns a bit-mask of all the element categories that are visible. More...

void	SetVisibleElements (int aMask)
	Function SetVisibleElements changes the bit-mask of visible element categories. More...

bool	IsElementVisible (GAL_LAYER_ID aElementCategory) const
	Function IsElementVisible tests whether a given element category is visible. More...

void	SetElementVisibility (GAL_LAYER_ID aElementCategory, bool aNewState)
	Function SetElementVisibility changes the visibility of an element category. More...

LSET	GetEnabledLayers () const
	Function GetEnabledLayers returns a bit-mask of all the layers that are enabled. More...

void	SetEnabledLayers (LSET aMask)
	Function SetEnabledLayers changes the bit-mask of enabled layers. More...

bool	IsLayerEnabled (PCB_LAYER_ID aLayerId) const
	Function IsLayerEnabled tests whether a given layer is enabled. More...

int	GetCopperLayerCount () const
	Function GetCopperLayerCount. More...

void	SetCopperLayerCount (int aNewLayerCount)
	Function SetCopperLayerCount do what its name says... More...

void	AppendConfigs (PARAM_CFG_ARRAY *aResult)
	Function AppendConfigs appends to aResult the configuration setting accessors which will later allow reading or writing of configuration file information directly into this object. More...

int	GetBoardThickness () const

void	SetBoardThickness (int aThickness)

Public Attributes
std::vector< VIA_DIMENSION >	m_ViasDimensionsList
	Vias size and drill list. More...

std::vector< int >	m_TrackWidthList
	Track width list. More...

NETCLASSES	m_NetClasses
	List of current netclasses. There is always the default netclass. More...

bool	m_MicroViasAllowed
	true to allow micro vias More...

bool	m_BlindBuriedViaAllowed
	true to allow blind/buried vias More...

VIATYPE_T	m_CurrentViaType
	via type (VIA_BLIND_BURIED, VIA_THROUGH VIA_MICROVIA) More...

bool	m_UseConnectedTrackWidth
	if true, when creating a new track starting on an existing track, use this track width More...

int	m_DrawSegmentWidth
	current graphic line width (not EDGE layer) More...

int	m_EdgeSegmentWidth
	current graphic line width (EDGE layer only) More...

int	m_PcbTextWidth
	current Pcb (not module) Text width More...

wxSize	m_PcbTextSize
	current Pcb (not module) Text size More...

int	m_TrackMinWidth
	track min value for width ((min copper size value More...

int	m_ViasMinSize
	vias (not micro vias) min diameter More...

int	m_ViasMinDrill
	vias (not micro vias) min drill diameter More...

int	m_MicroViasMinSize
	micro vias (not vias) min diameter More...

int	m_MicroViasMinDrill
	micro vias (not vias) min drill diameter More...

int	m_SolderMaskMargin
	Solder mask margin. More...

int	m_SolderMaskMinWidth
	Solder mask min width. More...

int	m_SolderPasteMargin
	Solder paste margin absolute value. More...

double	m_SolderPasteMarginRatio
	Solder pask margin ratio value of pad size The final margin is the sum of these 2 values. More...

int	m_ModuleSegmentWidth
	Default width for all graphic lines. More...

wxSize	m_ModuleTextSize
	Default footprint texts size. More...

int	m_ModuleTextWidth
	Default footprint texts thickness. More...

wxString	m_RefDefaultText
	Default ref text on fp creation. More...

bool	m_RefDefaultVisibility
	Default ref text visibility on fp creation. More...

int	m_RefDefaultlayer
	Default ref text layer on fp creation. More...

wxString	m_ValueDefaultText
	Default value text on fp creation. More...

bool	m_ValueDefaultVisibility
	Default value text visibility on fp creation. More...

int	m_ValueDefaultlayer
	Default value text layer on fp creation. More...

wxPoint	m_AuxOrigin
	origin for plot exports More...

wxPoint	m_GridOrigin
	origin for grid offsets More...

D_PAD	m_Pad_Master
	A dummy pad to store all default parameters. More...

Private Member Functions
void	formatNetClass (NETCLASS aNetClass, OUTPUTFORMATTER aFormatter, int aNestLevel, int aControlBits) const

Private Attributes
unsigned	m_viaSizeIndex
	Index for m_ViasDimensionsList to select the current via size. More...

unsigned	m_trackWidthIndex
	0 is the index selection of the default value Netclass More...

bool	m_useCustomTrackVia
	Use custom values for track/via sizes (not specified in net class nor in the size lists). More...

int	m_customTrackWidth
	Custom track width (used after UseCustomTrackViaSize( true ) was called). More...

VIA_DIMENSION	m_customViaSize
	Custom via size (used after UseCustomTrackViaSize( true ) was called). More...

int	m_copperLayerCount
	Number of copper layers for this design. More...

LSET	m_enabledLayers
	Bit-mask for layer enabling. More...

LSET	m_visibleLayers
	Bit-mask for layer visibility. More...

int	m_visibleElements
	Bit-mask for element category visibility. More...

int	m_boardThickness
	Board thickness for 3D viewer. More...

wxString	m_currentNetClassName
	Current net class name used to display netclass info. More...

Detailed Description

Class BOARD_DESIGN_SETTINGS contains design settings for a BOARD object.

Definition at line 97 of file board_design_settings.h.

Constructor & Destructor Documentation

BOARD_DESIGN_SETTINGS::BOARD_DESIGN_SETTINGS ( )

Definition at line 40 of file board_design_settings.cpp.

References DEFAULT_BOARD_THICKNESS_MM, DEFAULT_CUSTOMTRACKWIDTH, DEFAULT_GR_MODULE_THICKNESS, DEFAULT_GRAPHIC_THICKNESS, DEFAULT_MICROVIASMINDRILL, DEFAULT_MICROVIASMINSIZE, DEFAULT_PCB_EDGE_THICKNESS, DEFAULT_SOLDERMASK_CLEARANCE, DEFAULT_SOLDERMASK_MIN_WIDTH, DEFAULT_TEXT_MODULE_SIZE, DEFAULT_TEXT_PCB_SIZE, DEFAULT_TEXT_PCB_THICKNESS, DEFAULT_TRACKMINWIDTH, DEFAULT_VIASMINDRILL, DEFAULT_VIASMINSIZE, F_Fab, F_SilkS, GAL_LAYER_INDEX, LAYER_MOD_TEXT_INVISIBLE, m_BlindBuriedViaAllowed, m_boardThickness, m_CurrentViaType, m_customTrackWidth, m_customViaSize, VIA_DIMENSION::m_Diameter, m_DrawSegmentWidth, VIA_DIMENSION::m_Drill, m_EdgeSegmentWidth, m_enabledLayers, m_MicroViasAllowed, m_MicroViasMinDrill, m_MicroViasMinSize, m_ModuleSegmentWidth, m_ModuleTextSize, m_ModuleTextWidth, m_PcbTextSize, m_PcbTextWidth, m_RefDefaultlayer, m_RefDefaultText, m_RefDefaultVisibility, m_SolderMaskMargin, m_SolderMaskMinWidth, m_SolderPasteMargin, m_SolderPasteMarginRatio, m_TrackMinWidth, m_trackWidthIndex, m_UseConnectedTrackWidth, m_useCustomTrackVia, m_ValueDefaultlayer, m_ValueDefaultText, m_ValueDefaultVisibility, m_viaSizeIndex, m_ViasMinDrill, m_ViasMinSize, m_visibleElements, SetCopperLayerCount(), SetVisibleLayers(), and VIA_THROUGH.

                                              :
     m_Pad_Master( NULL )
 {
     LSET    all_set = LSET().set();
 
     m_enabledLayers = all_set;              // All layers enabled at first.
                                             // SetCopperLayerCount() will adjust this.
     SetVisibleLayers( all_set );
 
     // set all but hidden text as visible.
     m_visibleElements = ~( 1 << GAL_LAYER_INDEX( LAYER_MOD_TEXT_INVISIBLE ) );
 
     SetCopperLayerCount( 2 );               // Default design is a double sided board
 
     // via type (VIA_BLIND_BURIED, VIA_THROUGH VIA_MICROVIA).
     m_CurrentViaType = VIA_THROUGH;
 
     // if true, when creating a new track starting on an existing track, use this track width
     m_UseConnectedTrackWidth = false;
 
     m_BlindBuriedViaAllowed = false;            // true to allow blind/buried vias
     m_MicroViasAllowed = false;                 // true to allow micro vias
 
     m_DrawSegmentWidth = Millimeter2iu( DEFAULT_GRAPHIC_THICKNESS );     // current graphic line width (not EDGE layer)
 
     m_EdgeSegmentWidth = Millimeter2iu( DEFAULT_PCB_EDGE_THICKNESS );    // current graphic line width (EDGE layer only)
     m_PcbTextWidth     = Millimeter2iu( DEFAULT_TEXT_PCB_THICKNESS );    // current Pcb (not module) Text width
 
     m_PcbTextSize       = wxSize( Millimeter2iu( DEFAULT_TEXT_PCB_SIZE  ),
                                   Millimeter2iu( DEFAULT_TEXT_PCB_SIZE  ) );  // current Pcb (not module) Text size
 
     m_useCustomTrackVia = false;
     m_customTrackWidth  = Millimeter2iu( DEFAULT_CUSTOMTRACKWIDTH );
     m_customViaSize.m_Diameter = Millimeter2iu( DEFAULT_VIASMINSIZE );
     m_customViaSize.m_Drill = Millimeter2iu( DEFAULT_VIASMINDRILL );
 
     m_TrackMinWidth     = Millimeter2iu( DEFAULT_TRACKMINWIDTH );   // track min width
     m_ViasMinSize       = Millimeter2iu( DEFAULT_VIASMINSIZE );     // via (not uvia) min diam
     m_ViasMinDrill      = Millimeter2iu( DEFAULT_VIASMINDRILL );    // via (not uvia) min drill diam
     m_MicroViasMinSize  = Millimeter2iu( DEFAULT_MICROVIASMINSIZE );// uvia (not via) min diam
     m_MicroViasMinDrill = Millimeter2iu( DEFAULT_MICROVIASMINDRILL );// uvia (not via) min drill diam
 
     // Global mask margins:
     m_SolderMaskMargin  = Millimeter2iu( DEFAULT_SOLDERMASK_CLEARANCE ); // Solder mask margin
     m_SolderMaskMinWidth = Millimeter2iu( DEFAULT_SOLDERMASK_MIN_WIDTH );   // Solder mask min width
     m_SolderPasteMargin = 0;                    // Solder paste margin absolute value
     m_SolderPasteMarginRatio = 0.0;             // Solder pask margin ratio value of pad size
                                                 // The final margin is the sum of these 2 values
                                                 // Usually < 0 because the mask is smaller than pad
 
     // Layer thickness for 3D viewer
     m_boardThickness = Millimeter2iu( DEFAULT_BOARD_THICKNESS_MM );
 
     m_viaSizeIndex = 0;
     m_trackWidthIndex = 0;
 
     // Default values for the footprint editor and fp creation
     // (also covers footprints created on the fly by micor-waves tools)
     m_ModuleTextSize = wxSize( Millimeter2iu( DEFAULT_TEXT_MODULE_SIZE ),
                                Millimeter2iu( DEFAULT_TEXT_MODULE_SIZE ) );
     m_ModuleTextWidth = Millimeter2iu( DEFAULT_GR_MODULE_THICKNESS );
     m_ModuleSegmentWidth = Millimeter2iu( DEFAULT_GR_MODULE_THICKNESS );
 
     // These values will be overriden by config values after reading the config
     // Default ref text on fp creation. if empty, use footprint name as default
     m_RefDefaultText = wxT( "REF**" );
     m_RefDefaultVisibility = true;          // Default ref text visibility on fp creation
     m_RefDefaultlayer = int( F_SilkS );     // Default ref text layer on fp creation
     // Default value text on fp creation. if empty, use footprint name as default
     m_ValueDefaultText = wxEmptyString;
     m_ValueDefaultVisibility = true;
     m_ValueDefaultlayer = int( F_Fab );
 }

Member Function Documentation

void BOARD_DESIGN_SETTINGS::AppendConfigs ( PARAM_CFG_ARRAY * aResult )

Function AppendConfigs appends to aResult the configuration setting accessors which will later allow reading or writing of configuration file information directly into this object.

Definition at line 116 of file board_design_settings.cpp.

References D_PAD::AppendConfigs(), DEFAULT_GR_MODULE_THICKNESS, DEFAULT_GRAPHIC_THICKNESS, DEFAULT_PCB_EDGE_THICKNESS, DEFAULT_SOLDERMASK_CLEARANCE, DEFAULT_SOLDERMASK_MIN_WIDTH, DEFAULT_TEXT_MODULE_SIZE, DEFAULT_TEXT_PCB_SIZE, DEFAULT_TEXT_PCB_THICKNESS, m_DrawSegmentWidth, m_EdgeSegmentWidth, m_ModuleSegmentWidth, m_ModuleTextSize, m_ModuleTextWidth, m_Pad_Master, m_PcbTextSize, m_PcbTextWidth, m_SolderMaskMargin, m_SolderMaskMinWidth, TEXTS_MAX_SIZE, TEXTS_MAX_WIDTH, and TEXTS_MIN_SIZE.

Referenced by PCB_EDIT_FRAME::GetProjectFileParameters().

 {
     m_Pad_Master.AppendConfigs( aResult );
 
     aResult->push_back( new PARAM_CFG_INT_WITH_SCALE( wxT( "PcbTextSizeV" ),
                     &m_PcbTextSize.y,
                     Millimeter2iu( DEFAULT_TEXT_PCB_SIZE  ), TEXTS_MIN_SIZE, TEXTS_MAX_SIZE,
                     NULL, MM_PER_IU ) );
 
     aResult->push_back( new PARAM_CFG_INT_WITH_SCALE( wxT( "PcbTextSizeH" ),
                     &m_PcbTextSize.x,
                     Millimeter2iu( DEFAULT_TEXT_PCB_SIZE  ), TEXTS_MIN_SIZE, TEXTS_MAX_SIZE,
                     NULL, MM_PER_IU ) );
 
     aResult->push_back( new PARAM_CFG_INT_WITH_SCALE( wxT( "PcbTextThickness" ),
                     &m_PcbTextWidth,
                     Millimeter2iu(DEFAULT_TEXT_PCB_THICKNESS ),
                     Millimeter2iu( 0.01 ), Millimeter2iu( 5.0 ),
                     NULL, MM_PER_IU ) );
 
     aResult->push_back( new PARAM_CFG_INT_WITH_SCALE( wxT( "ModuleTextSizeV" ),
                     &m_ModuleTextSize.y,
                     DEFAULT_TEXT_MODULE_SIZE, TEXTS_MIN_SIZE, TEXTS_MAX_SIZE,
                     NULL, MM_PER_IU ) );
 
     aResult->push_back( new PARAM_CFG_INT_WITH_SCALE( wxT( "ModuleTextSizeH" ),
                     &m_ModuleTextSize.x,
                     DEFAULT_TEXT_MODULE_SIZE, TEXTS_MIN_SIZE, TEXTS_MAX_SIZE,
                     NULL, MM_PER_IU ) );
 
     aResult->push_back( new PARAM_CFG_INT_WITH_SCALE( wxT( "ModuleTextSizeThickness" ),
                     &m_ModuleTextWidth,
                     Millimeter2iu( DEFAULT_GR_MODULE_THICKNESS ), 1, TEXTS_MAX_WIDTH,
                     NULL, MM_PER_IU ) );
 
     aResult->push_back( new PARAM_CFG_INT_WITH_SCALE( wxT( "SolderMaskClearance" ),
                     &m_SolderMaskMargin,
                     Millimeter2iu( DEFAULT_SOLDERMASK_CLEARANCE ), 0, Millimeter2iu( 1.0 ),
                     NULL, MM_PER_IU ) );
 
     aResult->push_back( new PARAM_CFG_INT_WITH_SCALE( wxT( "SolderMaskMinWidth" ),
                     &m_SolderMaskMinWidth,
                     Millimeter2iu( DEFAULT_SOLDERMASK_MIN_WIDTH ), 0, Millimeter2iu( 0.5 ),
                     NULL, MM_PER_IU ) );
 
     aResult->push_back( new PARAM_CFG_INT_WITH_SCALE( wxT( "DrawSegmentWidth" ),
                     &m_DrawSegmentWidth,
                     Millimeter2iu( DEFAULT_GRAPHIC_THICKNESS ),
                     Millimeter2iu( 0.01 ), Millimeter2iu( 5.0 ),
                     NULL, MM_PER_IU ) );
 
     aResult->push_back( new PARAM_CFG_INT_WITH_SCALE( wxT( "BoardOutlineThickness" ),
                     &m_EdgeSegmentWidth,
                     Millimeter2iu( DEFAULT_PCB_EDGE_THICKNESS ),
                     Millimeter2iu( 0.01 ), Millimeter2iu( 5.0 ),
                     NULL, MM_PER_IU ) );
 
     aResult->push_back( new PARAM_CFG_INT_WITH_SCALE( wxT( "ModuleOutlineThickness" ),
                     &m_ModuleSegmentWidth,
                     Millimeter2iu( DEFAULT_GR_MODULE_THICKNESS ),
                     Millimeter2iu( 0.01 ), Millimeter2iu( 5.0 ),
                     NULL, MM_PER_IU ) );
 }

void BOARD_DESIGN_SETTINGS::formatNetClass	(	NETCLASS *	aNetClass,
		OUTPUTFORMATTER *	aFormatter,
		int	aNestLevel,
		int	aControlBits
	)		const

private

int BOARD_DESIGN_SETTINGS::GetBiggestClearanceValue ( )

Function GetBiggestClearanceValue.

Returns: the biggest clearance value found in NetClasses list

Definition at line 237 of file board_design_settings.cpp.

References NETCLASSES::begin(), NETCLASSES::end(), NETCLASSES::GetDefault(), m_NetClasses, and max.

Referenced by ZONE_FILLER::buildUnconnectedThermalStubsPolygonList(), ZONE_FILLER::buildZoneFeatureHoleList(), MODULE::GetBoundingPoly(), PNS_KICAD_IFACE::SyncWorld(), and MODULE::ViewBBox().

 {
     int clearance = m_NetClasses.GetDefault()->GetClearance();
 
     //Read list of Net Classes
     for( NETCLASSES::const_iterator nc = m_NetClasses.begin(); nc != m_NetClasses.end(); ++nc )
     {
         NETCLASSPTR netclass = nc->second;
         clearance = std::max( clearance, netclass->GetClearance() );
     }
 
     return clearance;
 }

int BOARD_DESIGN_SETTINGS::GetBoardThickness ( ) const

inline

Definition at line 557 of file board_design_settings.h.

Referenced by GERBER_JOBFILE_WRITER::addJSONGeneralSpecs(), compute_layer_Zs(), PCB_EDIT_FRAME::Export_IDF3(), PCB_IO::formatGeneral(), CINFO3D_VISU::InitSettings(), and DIALOG_LAYERS_SETUP::TransferDataToWindow().

557 { return m_boardThickness; }

BOARD_DESIGN_SETTINGS::m_boardThickness

int m_boardThickness

Board thickness for 3D viewer.

Definition: board_design_settings.h:187

int BOARD_DESIGN_SETTINGS::GetCopperLayerCount ( ) const

inline

Function GetCopperLayerCount.

Returns: int - the number of neabled copper layers

Definition at line 537 of file board_design_settings.h.

Referenced by DRC::doTrackDrc(), BOARD::GetCopperLayerCount(), and ROUTER_TOOL::onViaCommand().

     {
         return m_copperLayerCount;
     }

int BOARD_DESIGN_SETTINGS::GetCurrentMicroViaDrill ( )

Function GetCurrentMicroViaDrill.

Returns: the current micro via drill, that is the current netclass value

Definition at line 275 of file board_design_settings.cpp.

References NETCLASSES::Find(), m_currentNetClassName, and m_NetClasses.

Referenced by ROUTER_TOOL::onViaCommand().

 {
     NETCLASSPTR netclass = m_NetClasses.Find( m_currentNetClassName );
 
     return netclass->GetuViaDrill();
 }

int BOARD_DESIGN_SETTINGS::GetCurrentMicroViaSize ( )

Function GetCurrentMicroViaSize.

Returns: the current micro via size, that is the current netclass value

Definition at line 267 of file board_design_settings.cpp.

References NETCLASSES::Find(), m_currentNetClassName, and m_NetClasses.

Referenced by ROUTER_TOOL::onViaCommand().

 {
     NETCLASSPTR netclass = m_NetClasses.Find( m_currentNetClassName );
 
     return netclass->GetuViaDiameter();
 }

const wxString& BOARD_DESIGN_SETTINGS::GetCurrentNetClassName ( ) const

inline

Function GetCurrentNetClassName.

Returns: the current net class name.

Definition at line 209 of file board_design_settings.h.

     {
         return m_currentNetClassName;
     }

int BOARD_DESIGN_SETTINGS::GetCurrentTrackWidth ( ) const

inline

Function GetCurrentTrackWidth.

Returns: the current track width, according to the selected options ( using the default netclass value or a preset/custom value ) the default netclass is always in m_TrackWidthList[0]

Definition at line 288 of file board_design_settings.h.

Referenced by AddNewTrace(), Autoroute_One_Track(), PCB_EDIT_FRAME::Begin_Self(), BOARD::BOARD(), EDIT_TOOL::changeTrackWidthOnClick(), PCB_EDIT_FRAME::Create_MuWaveComponent(), MICROWAVE_TOOL::createInductorBetween(), PCB_EDIT_FRAME::CreateMuWaveBaseFootprint(), PCB_EDIT_FRAME::Edit_Gap(), PCB_IO::formatSetup(), PNS::SIZES_SETTINGS::ImportCurrent(), PNS::SIZES_SETTINGS::Init(), OrCell_Trace(), PCB_EDIT_FRAME::SetTrackSegmentWidth(), ShowNewTrackWhenMovingCursor(), and DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::updateNetInfo().

     {
         return m_useCustomTrackVia ? m_customTrackWidth : m_TrackWidthList[m_trackWidthIndex];
     }

int BOARD_DESIGN_SETTINGS::GetCurrentViaDrill ( ) const

Function GetCurrentViaDrill.

Returns: the current via size, according to the selected options ( using the default netclass value or a preset/custom value ) the default netclass is always in m_TrackWidthList[0]

Definition at line 294 of file board_design_settings.cpp.

References m_customViaSize, VIA_DIMENSION::m_Drill, m_useCustomTrackVia, m_ViasDimensionsList, and m_viaSizeIndex.

Referenced by BOARD::BOARD(), EDIT_TOOL::changeTrackWidthOnClick(), PNS::SIZES_SETTINGS::ImportCurrent(), PNS::SIZES_SETTINGS::Init(), ROUTER_TOOL::onViaCommand(), PCB_EDIT_FRAME::SetTrackSegmentWidth(), and DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::updateNetInfo().

 {
     int drill;
 
     if( m_useCustomTrackVia )
         drill = m_customViaSize.m_Drill;
     else
         drill = m_ViasDimensionsList[m_viaSizeIndex].m_Drill;
 
     return drill > 0 ? drill : -1;
 }

int BOARD_DESIGN_SETTINGS::GetCurrentViaSize ( ) const

inline

Function GetCurrentViaSize.

Returns: the current via size, according to the selected options ( using the default netclass value or a preset/custom value ) the default netclass is always in m_TrackWidthList[0]

Definition at line 337 of file board_design_settings.h.

References VIA_DIMENSION::m_Diameter.

Referenced by AddNewTrace(), BOARD::BOARD(), EDIT_TOOL::changeTrackWidthOnClick(), PNS::SIZES_SETTINGS::ImportCurrent(), PNS::SIZES_SETTINGS::Init(), ROUTER_TOOL::onViaCommand(), OrCell_Trace(), PCB_EDIT_FRAME::SetTrackSegmentWidth(), ShowNewTrackWhenMovingCursor(), and DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::updateNetInfo().

     {
         if( m_useCustomTrackVia )
             return m_customViaSize.m_Diameter;
         else
             return m_ViasDimensionsList[m_viaSizeIndex].m_Diameter;
     }

int BOARD_DESIGN_SETTINGS::GetCustomTrackWidth ( ) const

inline

Function GetCustomTrackWidth.

Returns: Current custom width for a track.

Definition at line 309 of file board_design_settings.h.

Referenced by DIALOG_TRACK_VIA_SIZE::TransferDataToWindow().

     {
         return m_customTrackWidth;
     }

int BOARD_DESIGN_SETTINGS::GetCustomViaDrill ( ) const

inline

Function GetCustomViaDrill.

Returns: Current custom size for the via drill.

Definition at line 390 of file board_design_settings.h.

References VIA_DIMENSION::m_Drill.

Referenced by DIALOG_TRACK_VIA_SIZE::TransferDataToWindow().

     {
         return m_customViaSize.m_Drill;
     }

int BOARD_DESIGN_SETTINGS::GetCustomViaSize ( ) const

inline

Function GetCustomViaSize.

Returns: Current custom size for the via diameter.

Definition at line 361 of file board_design_settings.h.

References VIA_DIMENSION::m_Diameter.

Referenced by DIALOG_TRACK_VIA_SIZE::TransferDataToWindow().

     {
         return m_customViaSize.m_Diameter;
     }

NETCLASSPTR BOARD_DESIGN_SETTINGS::GetDefault ( ) const

inline

Function GetDefault.

Returns: the default netclass.

Definition at line 200 of file board_design_settings.h.

References NETCLASSES::GetDefault().

Referenced by GERBER_JOBFILE_WRITER::addJSONDesignRules(), BOARD::BOARD(), EVT_TOOL(), FOOTPRINT_EDIT_FRAME::FOOTPRINT_EDIT_FRAME(), PCB_IO::formatNetInformation(), PCB_IO::formatSetup(), DSN::SPECCTRA_DB::FromBOARD(), BOARD_CONNECTED_ITEM::GetNetClass(), ROUTER_TOOL::getNetclassDimensions(), PNS::SIZES_SETTINGS::Init(), EAGLE_PLUGIN::Load(), LEGACY_PLUGIN::loadSETUP(), and PlaceCells().

     {
         return m_NetClasses.GetDefault();
     }

LSET BOARD_DESIGN_SETTINGS::GetEnabledLayers ( ) const

inline

Function GetEnabledLayers returns a bit-mask of all the layers that are enabled.

Returns: int - the enabled layers in bit-mapped form.

Definition at line 510 of file board_design_settings.h.

Referenced by CreatePadsShapesSection(), CreateRoutesSection(), and BOARD::GetEnabledLayers().

     {
         return m_enabledLayers;
     }

int BOARD_DESIGN_SETTINGS::GetSmallestClearanceValue ( )

Function GetSmallestClearanceValue.

Returns: the smallest clearance value found in NetClasses list

Definition at line 252 of file board_design_settings.cpp.

References NETCLASSES::begin(), NETCLASSES::end(), NETCLASSES::GetDefault(), m_NetClasses, and min.

Referenced by DIALOG_PLOT::init_Dialog().

 {
     int clearance = m_NetClasses.GetDefault()->GetClearance();
 
     //Read list of Net Classes
     for( NETCLASSES::const_iterator nc = m_NetClasses.begin(); nc != m_NetClasses.end(); ++nc )
     {
         NETCLASSPTR netclass = nc->second;
         clearance = std::min( clearance, netclass->GetClearance() );
     }
 
     return clearance;
 }

unsigned BOARD_DESIGN_SETTINGS::GetTrackWidthIndex ( ) const

inline

Function GetTrackWidthIndex.

Returns: the current track width list index.

Definition at line 272 of file board_design_settings.h.

Referenced by Append_Track_Width_List(), PCB_EDIT_FRAME::OnUpdateSelectTrackWidth(), SetCurrentNetClass(), PCB_EDITOR_CONTROL::TrackWidthDec(), PCB_EDITOR_CONTROL::TrackWidthInc(), and DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::updateNetInfo().

272 { return m_trackWidthIndex; }

BOARD_DESIGN_SETTINGS::m_trackWidthIndex

unsigned m_trackWidthIndex

0 is the index selection of the default value Netclass

Definition: board_design_settings.h:170

unsigned BOARD_DESIGN_SETTINGS::GetViaSizeIndex ( ) const

inline

Function GetViaSizeIndex.

Returns: the current via size list index.

Definition at line 318 of file board_design_settings.h.

Referenced by Append_Track_Width_List(), PCB_EDIT_FRAME::OnUpdateSelectViaSize(), SetCurrentNetClass(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::updateNetInfo(), PCB_EDITOR_CONTROL::ViaSizeDec(), and PCB_EDITOR_CONTROL::ViaSizeInc().

     {
         return m_viaSizeIndex;
     }

int BOARD_DESIGN_SETTINGS::GetVisibleElements ( ) const

inline

Function GetVisibleElements returns a bit-mask of all the element categories that are visible.

Returns: int - the visible element categories in bit-mapped form.

Definition at line 468 of file board_design_settings.h.

Referenced by PCB_IO::formatSetup(), and BOARD::GetVisibleElements().

     {
         return m_visibleElements;
     }

LSET BOARD_DESIGN_SETTINGS::GetVisibleLayers ( ) const

inline

Function GetVisibleLayers returns a bit-mask of all the layers that are visible.

Returns: int - the visible layers in bit-mapped form.

Definition at line 421 of file board_design_settings.h.

Referenced by BOARD::GetVisibleLayers().

     {
         return m_visibleLayers;
     }

bool BOARD_DESIGN_SETTINGS::IsElementVisible ( GAL_LAYER_ID aElementCategory ) const

inline

Function IsElementVisible tests whether a given element category is visible.

Keep this as an inline function.

Parameters

aElementCategory is from the enum by the same name

Returns: bool - true if the element is visible.

See also: enum GAL_LAYER_ID

Definition at line 491 of file board_design_settings.h.

References GAL_LAYER_INDEX.

Referenced by BOARD::IsElementVisible().

     {
         return ( m_visibleElements & ( 1 << GAL_LAYER_INDEX( aElementCategory ) ) );
     }

bool BOARD_DESIGN_SETTINGS::IsLayerEnabled ( PCB_LAYER_ID aLayerId ) const

inline

Function IsLayerEnabled tests whether a given layer is enabled.

Parameters

aLayerId = The layer to be tested

Returns: bool - true if the layer is enabled

Definition at line 528 of file board_design_settings.h.

Referenced by BOARD::IsLayerEnabled(), and SetLayerVisibility().

     {
         return m_enabledLayers[aLayerId];
     }

bool BOARD_DESIGN_SETTINGS::IsLayerVisible ( PCB_LAYER_ID aLayerId ) const

inline

Function IsLayerVisible tests whether a given layer is visible.

Parameters

aLayerId = The layer to be tested

Returns: bool - true if the layer is visible.

Definition at line 449 of file board_design_settings.h.

Referenced by BOARD::GetVisibleTrack(), CINFO3D_VISU::Is3DLayerEnabled(), and BOARD::IsLayerVisible().

     {
         // If a layer is disabled, it is automatically invisible
         return (m_visibleLayers & m_enabledLayers)[aLayerId];
     }

void BOARD_DESIGN_SETTINGS::SetBoardThickness ( int aThickness )

inline

Definition at line 558 of file board_design_settings.h.

Referenced by LEGACY_PLUGIN::loadGENERAL(), and DIALOG_LAYERS_SETUP::TransferDataFromWindow().

558 { m_boardThickness = aThickness; }

BOARD_DESIGN_SETTINGS::m_boardThickness

int m_boardThickness

Board thickness for 3D viewer.

Definition: board_design_settings.h:187

void BOARD_DESIGN_SETTINGS::SetCopperLayerCount ( int aNewLayerCount )

Function SetCopperLayerCount do what its name says...

Parameters

aNewLayerCount = The new number of enabled copper layers

Definition at line 343 of file board_design_settings.cpp.

References ALL_CU_LAYERS, LSET::AllCuMask(), LAYER_BACK, LAYER_FRONT, LAYER_N_2, m_copperLayerCount, and m_enabledLayers.

Referenced by BOARD_DESIGN_SETTINGS(), and BOARD::SetCopperLayerCount().

 {
     // if( aNewLayerCount < 2 ) aNewLayerCount = 2;
 
     m_copperLayerCount = aNewLayerCount;
 
     // ensure consistency with the m_EnabledLayers member
 #if 0
     // was:
     m_enabledLayers &= ~ALL_CU_LAYERS;
     m_enabledLayers |= LAYER_BACK;
 
     if( m_copperLayerCount > 1 )
         m_enabledLayers |= LAYER_FRONT;
 
     for( LAYER_NUM ii = LAYER_N_2; ii < aNewLayerCount - 1; ++ii )
         m_enabledLayers |= GetLayerSet( ii );
 #else
     // Update only enabled copper layers mask
     m_enabledLayers &= ~LSET::AllCuMask();
     m_enabledLayers |= LSET::AllCuMask( aNewLayerCount );
 #endif
 }

bool BOARD_DESIGN_SETTINGS::SetCurrentNetClass ( const wxString & aNetClassName )

Function SetCurrentNetClass Must be called after a netclass selection (or after a netclass parameter change Initialize vias and tracks values displayed in comb boxes of the auxiliary toolbar and some others parameters (netclass name ....)

Parameters

aNetClassName = the new netclass name

Returns: true if lists of tracks and vias sizes are modified

Definition at line 181 of file board_design_settings.cpp.

References NETCLASSES::Find(), NETCLASSES::GetDefault(), GetTrackWidthIndex(), GetViaSizeIndex(), m_currentNetClassName, m_NetClasses, m_TrackWidthList, m_ViasDimensionsList, SetTrackWidthIndex(), and SetViaSizeIndex().

Referenced by BOARD::BOARD(), SaveBoard(), and DIALOG_DESIGN_RULES::TransferDataFromWindow().

 {
     NETCLASSPTR netClass = m_NetClasses.Find( aNetClassName );
     bool        lists_sizes_modified = false;
 
     // if not found (should not happen) use the default
     if( netClass == NULL )
         netClass = m_NetClasses.GetDefault();
 
     m_currentNetClassName = netClass->GetName();
 
     // Initialize others values:
     if( m_ViasDimensionsList.size() == 0 )
     {
         VIA_DIMENSION viadim;
         lists_sizes_modified = true;
         m_ViasDimensionsList.push_back( viadim );
     }
 
     if( m_TrackWidthList.size() == 0 )
     {
         lists_sizes_modified = true;
         m_TrackWidthList.push_back( 0 );
     }
 
     /* note the m_ViasDimensionsList[0] and m_TrackWidthList[0] values
      * are always the Netclass values
      */
     if( m_ViasDimensionsList[0].m_Diameter != netClass->GetViaDiameter() )
     {
         lists_sizes_modified = true;
         m_ViasDimensionsList[0].m_Diameter = netClass->GetViaDiameter();
     }
 
     if( m_ViasDimensionsList[0].m_Drill != netClass->GetViaDrill() )
     {
         lists_sizes_modified = true;
         m_ViasDimensionsList[0].m_Drill = netClass->GetViaDrill();
     }
 
     if( m_TrackWidthList[0] != netClass->GetTrackWidth() )
     {
         lists_sizes_modified = true;
         m_TrackWidthList[0] = netClass->GetTrackWidth();
     }
 
     if( GetViaSizeIndex() >= m_ViasDimensionsList.size() )
         SetViaSizeIndex( m_ViasDimensionsList.size() );
 
     if( GetTrackWidthIndex() >= m_TrackWidthList.size() )
         SetTrackWidthIndex( m_TrackWidthList.size() );
 
     return lists_sizes_modified;
 }

void BOARD_DESIGN_SETTINGS::SetCustomTrackWidth ( int aWidth )

inline

Function SetCustomTrackWidth Sets custom width for track (i.e.

not available in netclasses or preset list). To have it returned with GetCurrentTrackWidth() you need to enable custom track & via sizes (UseCustomTrackViaSize()).

Parameters

aWidth is the new track width.

Definition at line 300 of file board_design_settings.h.

Referenced by BOARD::BOARD(), and DIALOG_TRACK_VIA_SIZE::TransferDataFromWindow().

     {
         m_customTrackWidth = aWidth;
     }

void BOARD_DESIGN_SETTINGS::SetCustomViaDrill ( int aDrill )

inline

Function SetCustomViaDrill Sets custom size for via drill (i.e.

not available in netclasses or preset list). To have it returned with GetCurrentViaDrill() you need to enable custom track & via sizes (UseCustomTrackViaSize()).

Parameters

aDrill is the new drill size.

Definition at line 381 of file board_design_settings.h.

References VIA_DIMENSION::m_Drill.

Referenced by BOARD::BOARD(), and DIALOG_TRACK_VIA_SIZE::TransferDataFromWindow().

     {
         m_customViaSize.m_Drill = aDrill;
     }

void BOARD_DESIGN_SETTINGS::SetCustomViaSize ( int aSize )

inline

Function SetCustomViaSize Sets custom size for via diameter (i.e.

not available in netclasses or preset list). To have it returned with GetCurrentViaSize() you need to enable custom track & via sizes (UseCustomTrackViaSize()).

Parameters

aSize is the new drill diameter.

Definition at line 352 of file board_design_settings.h.

References VIA_DIMENSION::m_Diameter.

Referenced by BOARD::BOARD(), and DIALOG_TRACK_VIA_SIZE::TransferDataFromWindow().

     {
         m_customViaSize.m_Diameter = aSize;
     }

void BOARD_DESIGN_SETTINGS::SetElementVisibility	(	GAL_LAYER_ID	aElementCategory,
		bool	aNewState
	)

Function SetElementVisibility changes the visibility of an element category.

Parameters

aElementCategory	is from the enum by the same name
aNewState	= The new visibility state of the element category

See also: enum GAL_LAYER_ID

Definition at line 334 of file board_design_settings.cpp.

References GAL_LAYER_INDEX, and m_visibleElements.

Referenced by BOARD::SetElementVisibility().

 {
     if( aNewState )
         m_visibleElements |= 1 << GAL_LAYER_INDEX( aElementCategory );
     else
         m_visibleElements &= ~( 1 << GAL_LAYER_INDEX( aElementCategory ) );
 }

void BOARD_DESIGN_SETTINGS::SetEnabledLayers ( LSET aMask )

Function SetEnabledLayers changes the bit-mask of enabled layers.

Parameters

aMask = The new bit-mask of enabled layers

Definition at line 368 of file board_design_settings.cpp.

References LSET::AllCuMask(), B_Cu, F_Cu, m_copperLayerCount, m_enabledLayers, and m_visibleLayers.

Referenced by BOARD::SetEnabledLayers().

 {
     // Back and front layers are always enabled.
     aMask.set( B_Cu ).set( F_Cu );
 
     m_enabledLayers = aMask;
 
     // A disabled layer cannot be visible
     m_visibleLayers &= aMask;
 
     // update m_CopperLayerCount to ensure its consistency with m_EnabledLayers
     m_copperLayerCount = ( aMask & LSET::AllCuMask() ).count();
 }

void BOARD_DESIGN_SETTINGS::SetLayerVisibility	(	PCB_LAYER_ID	aLayerId,
		bool	aNewState
	)

Function SetLayerVisibility changes the visibility of a given layer.

Parameters

aLayerId	= The layer to be changed
aNewState	= The new visibility state of the layer

Definition at line 325 of file board_design_settings.cpp.

References IsLayerEnabled(), and m_visibleLayers.

 {
     if( aNewState && IsLayerEnabled( aLayer ) )
         m_visibleLayers.set( aLayer, true );
     else
         m_visibleLayers.set( aLayer, false );
 }

void BOARD_DESIGN_SETTINGS::SetTrackWidthIndex ( unsigned aIndex )

Function SetTrackWidthIndex sets the current track width list index to aIndex.

Parameters

aIndex is the track width list index.

Definition at line 307 of file board_design_settings.cpp.

References m_trackWidthIndex, m_TrackWidthList, and m_useCustomTrackVia.

Referenced by TRACK_WIDTH_MENU::eventHandler(), PCB_EDIT_FRAME::OnHotKey(), SetCurrentNetClass(), PCB_EDIT_FRAME::Tracks_and_Vias_Size_Event(), PCB_EDITOR_CONTROL::TrackWidthDec(), PCB_EDITOR_CONTROL::TrackWidthInc(), and PCB_EDIT_FRAME::updateTraceWidthSelectBox().

 {
     if( aIndex >= m_TrackWidthList.size() )
         m_trackWidthIndex = m_TrackWidthList.size();
     else
         m_trackWidthIndex = aIndex;
 
     m_useCustomTrackVia = false;
 }

void BOARD_DESIGN_SETTINGS::SetViaSizeIndex ( unsigned aIndex )

Function SetViaSizeIndex sets the current via size list index to aIndex.

Parameters

aIndex is the via size list index.

Definition at line 283 of file board_design_settings.cpp.

References m_useCustomTrackVia, m_ViasDimensionsList, and m_viaSizeIndex.

Referenced by TRACK_WIDTH_MENU::eventHandler(), SetCurrentNetClass(), PCB_EDIT_FRAME::Tracks_and_Vias_Size_Event(), PCB_EDIT_FRAME::updateViaSizeSelectBox(), PCB_EDITOR_CONTROL::ViaSizeDec(), and PCB_EDITOR_CONTROL::ViaSizeInc().

 {
     if( aIndex >= m_ViasDimensionsList.size() )
         m_viaSizeIndex = m_ViasDimensionsList.size();
     else
         m_viaSizeIndex = aIndex;
 
     m_useCustomTrackVia = false;
 }

void BOARD_DESIGN_SETTINGS::SetVisibleAlls ( )

Function SetVisibleAlls Set the bit-mask of all visible elements categories, including enabled layers.

Definition at line 318 of file board_design_settings.cpp.

References m_visibleElements, and SetVisibleLayers().

 {
     SetVisibleLayers( LSET().set() );
     m_visibleElements = -1;
 }

void BOARD_DESIGN_SETTINGS::SetVisibleElements ( int aMask )

inline

Function SetVisibleElements changes the bit-mask of visible element categories.

Parameters

aMask = The new bit-mask of visible element categories

Definition at line 478 of file board_design_settings.h.

Referenced by LEGACY_PLUGIN::loadSETUP(), and PCB_PARSER::parseSetup().

     {
         m_visibleElements = aMask;
     }

void BOARD_DESIGN_SETTINGS::SetVisibleLayers ( LSET aMask )

inline

Function SetVisibleLayers changes the bit-mask of visible layers.

Parameters

aMask = The new bit-mask of visible layers

Definition at line 438 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), SetVisibleAlls(), and BOARD::SetVisibleLayers().

     {
         m_visibleLayers = aMask & m_enabledLayers;
     }

void BOARD_DESIGN_SETTINGS::UseCustomTrackViaSize ( bool aEnabled )

inline

Function UseCustomTrackViaSize Enables/disables custom track/via size settings.

If enabled, values set with SetCustomTrackWidth()/SetCustomViaSize()/SetCustomViaDrill() are used for newly created tracks and vias.

Parameters

aEnabled decides if custom settings should be used for new tracks/vias.

Definition at line 402 of file board_design_settings.h.

Referenced by BOARD::BOARD(), ROUTER_TOOL::CustomTrackWidthDialog(), TRACK_WIDTH_MENU::eventHandler(), PCB_EDIT_FRAME::OnUpdateSelectTrackWidth(), PCB_EDIT_FRAME::OnUpdateSelectViaSize(), PCB_EDITOR_CONTROL::TrackWidthDec(), PCB_EDITOR_CONTROL::TrackWidthInc(), PCB_EDITOR_CONTROL::ViaSizeDec(), and PCB_EDITOR_CONTROL::ViaSizeInc().

     {
         m_useCustomTrackVia = aEnabled;
     }

bool BOARD_DESIGN_SETTINGS::UseCustomTrackViaSize ( ) const

inline

Function UseCustomTrackViaSize.

Returns: True if custom sizes of tracks & vias are enabled, false otherwise.

Definition at line 411 of file board_design_settings.h.

     {
         return m_useCustomTrackVia;
     }

bool BOARD_DESIGN_SETTINGS::UseNetClassTrack ( ) const

inline

Function UseNetClassTrack returns true if netclass values should be used to obtain appropriate track width.

Definition at line 218 of file board_design_settings.h.

Referenced by PNS::SIZES_SETTINGS::Init().

     {
         return ( m_trackWidthIndex == 0 && !m_useCustomTrackVia );
     }

bool BOARD_DESIGN_SETTINGS::UseNetClassVia ( ) const

inline

Function UseNetClassVia returns true if netclass values should be used to obtain appropriate via size.

Definition at line 227 of file board_design_settings.h.

Referenced by PNS::SIZES_SETTINGS::Init().

     {
         return ( m_viaSizeIndex == 0 && !m_useCustomTrackVia );
     }

Member Data Documentation

wxPoint BOARD_DESIGN_SETTINGS::m_AuxOrigin

origin for plot exports

Definition at line 157 of file board_design_settings.h.

Referenced by BOARD::GetAuxOrigin(), LEGACY_PLUGIN::loadSETUP(), PCB_PARSER::parseSetup(), and BOARD::SetAuxOrigin().

bool BOARD_DESIGN_SETTINGS::m_BlindBuriedViaAllowed

true to allow blind/buried vias

Definition at line 112 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), DIALOG_DESIGN_RULES::CopyGlobalRulesToBoard(), DRC::doTrackDrc(), PCB_IO::formatSetup(), DIALOG_DESIGN_RULES::InitGlobalRules(), ROUTER_TOOL::onViaCommand(), and PCB_PARSER::parseSetup().

int BOARD_DESIGN_SETTINGS::m_boardThickness

private

Board thickness for 3D viewer.

Definition at line 187 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS().

int BOARD_DESIGN_SETTINGS::m_copperLayerCount

private

Number of copper layers for this design.

Definition at line 181 of file board_design_settings.h.

Referenced by SetCopperLayerCount(), and SetEnabledLayers().

wxString BOARD_DESIGN_SETTINGS::m_currentNetClassName

private

Current net class name used to display netclass info.

This is also the last used netclass after starting a track.

Definition at line 191 of file board_design_settings.h.

Referenced by GetCurrentMicroViaDrill(), GetCurrentMicroViaSize(), and SetCurrentNetClass().

VIATYPE_T BOARD_DESIGN_SETTINGS::m_CurrentViaType

via type (VIA_BLIND_BURIED, VIA_THROUGH VIA_MICROVIA)

Definition at line 113 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), PCB_EDIT_FRAME::OnHotKey(), OrCell_Trace(), PCB_EDIT_FRAME::PrepareLayerIndicator(), and PCB_EDIT_FRAME::Process_Special_Functions().

int BOARD_DESIGN_SETTINGS::m_customTrackWidth

private

Custom track width (used after UseCustomTrackViaSize( true ) was called).

Definition at line 176 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS().

VIA_DIMENSION BOARD_DESIGN_SETTINGS::m_customViaSize

private

Custom via size (used after UseCustomTrackViaSize( true ) was called).

Definition at line 179 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), and GetCurrentViaDrill().

int BOARD_DESIGN_SETTINGS::m_DrawSegmentWidth

current graphic line width (not EDGE layer)

Definition at line 117 of file board_design_settings.h.

Referenced by AppendConfigs(), PCB_EDIT_FRAME::Begin_DrawSegment(), BOARD_DESIGN_SETTINGS(), PCB_IO::formatSetup(), DRAWING_TOOL::getSegmentWidth(), DIALOG_GRAPHIC_ITEMS_OPTIONS::initValues(), LEGACY_PLUGIN::loadSETUP(), DIALOG_GRAPHIC_ITEM_PROPERTIES::OnLayerChoice(), DIALOG_GRAPHIC_ITEMS_OPTIONS::OnOkClick(), PCB_PARSER::parseSetup(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow(), and DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataToWindow().

int BOARD_DESIGN_SETTINGS::m_EdgeSegmentWidth

current graphic line width (EDGE layer only)

Definition at line 118 of file board_design_settings.h.

Referenced by AppendConfigs(), PCB_EDIT_FRAME::Begin_DrawSegment(), BOARD_DESIGN_SETTINGS(), PCB_IO::formatSetup(), DRAWING_TOOL::getSegmentWidth(), DIALOG_GRAPHIC_ITEMS_OPTIONS::initValues(), LEGACY_PLUGIN::loadSETUP(), DIALOG_GRAPHIC_ITEM_PROPERTIES::OnLayerChoice(), DIALOG_GRAPHIC_ITEMS_OPTIONS::OnOkClick(), PCB_PARSER::parseSetup(), PCB_EDITOR_CONTROL::PlaceTarget(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow(), and DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataToWindow().

LSET BOARD_DESIGN_SETTINGS::m_enabledLayers

private

Bit-mask for layer enabling.

Definition at line 183 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), SetCopperLayerCount(), and SetEnabledLayers().

wxPoint BOARD_DESIGN_SETTINGS::m_GridOrigin

origin for grid offsets

Definition at line 158 of file board_design_settings.h.

Referenced by BOARD::GetGridOrigin(), LEGACY_PLUGIN::loadSETUP(), PCB_PARSER::parseSetup(), and BOARD::SetGridOrigin().

bool BOARD_DESIGN_SETTINGS::m_MicroViasAllowed

true to allow micro vias

Definition at line 111 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), DIALOG_DESIGN_RULES::CopyGlobalRulesToBoard(), DRC::doTrackDrc(), PCB_IO::formatSetup(), DIALOG_DESIGN_RULES::InitGlobalRules(), LEGACY_PLUGIN::loadSETUP(), ROUTER_TOOL::onViaCommand(), and PCB_PARSER::parseSetup().

int BOARD_DESIGN_SETTINGS::m_MicroViasMinDrill

micro vias (not vias) min drill diameter

Definition at line 125 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), DIALOG_DESIGN_RULES::CopyGlobalRulesToBoard(), DRC::doNetClass(), DRC::doTrackDrc(), PCB_IO::formatSetup(), DIALOG_DESIGN_RULES::InitGlobalRules(), LEGACY_PLUGIN::loadSETUP(), and PCB_PARSER::parseSetup().

int BOARD_DESIGN_SETTINGS::m_MicroViasMinSize

micro vias (not vias) min diameter

Definition at line 124 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), DIALOG_DESIGN_RULES::CopyGlobalRulesToBoard(), DIALOG_DRC_CONTROL::DisplayDRCValues(), DRC::doNetClass(), DRC::doTrackDrc(), PCB_IO::formatSetup(), DIALOG_DESIGN_RULES::InitGlobalRules(), LEGACY_PLUGIN::loadSETUP(), PCB_PARSER::parseSetup(), and DIALOG_DRC_CONTROL::SetDrcParmeters().

int BOARD_DESIGN_SETTINGS::m_ModuleSegmentWidth

Default width for all graphic lines.

Definition at line 137 of file board_design_settings.h.

Referenced by AppendConfigs(), BOARD_DESIGN_SETTINGS(), FOOTPRINT_EDIT_FRAME::Enter_Edge_Width(), PCB_IO::formatSetup(), FOOTPRINT_EDIT_FRAME::GetConfigurationSettings(), DRAWING_TOOL::getSegmentWidth(), DIALOG_GRAPHIC_ITEMS_OPTIONS::initValues(), DIALOG_MODEDIT_OPTIONS::initValues(), LEGACY_PLUGIN::loadSETUP(), DIALOG_MODEDIT_OPTIONS::OnOkClick(), DIALOG_GRAPHIC_ITEMS_OPTIONS::OnOkClick(), PCB_PARSER::parseSetup(), DIALOG_MODEDIT_FP_BODY_ITEM_PROPERTIES::TransferDataFromWindow(), and DIALOG_MODEDIT_FP_BODY_ITEM_PROPERTIES::TransferDataToWindow().

wxSize BOARD_DESIGN_SETTINGS::m_ModuleTextSize

Default footprint texts size.

Definition at line 139 of file board_design_settings.h.

Referenced by AppendConfigs(), BOARD_DESIGN_SETTINGS(), PCB_BASE_FRAME::CreateNewModule(), PCB_IO::formatSetup(), FOOTPRINT_EDIT_FRAME::GetConfigurationSettings(), DIALOG_GLOBAL_FOOTPRINTS_FIELDS_EDITION::initDialog(), DIALOG_GRAPHIC_ITEMS_OPTIONS::initValues(), DIALOG_MODEDIT_OPTIONS::initValues(), LEGACY_PLUGIN::loadSETUP(), DIALOG_MODEDIT_OPTIONS::OnOkClick(), DIALOG_GRAPHIC_ITEMS_OPTIONS::OnOkClick(), PCB_PARSER::parseSetup(), DRAWING_TOOL::PlaceText(), PCB_BASE_FRAME::ResetTextSize(), and DIALOG_GLOBAL_FOOTPRINTS_FIELDS_EDITION::TransferDataFromWindow().

int BOARD_DESIGN_SETTINGS::m_ModuleTextWidth

Default footprint texts thickness.

Definition at line 140 of file board_design_settings.h.

Referenced by AppendConfigs(), BOARD_DESIGN_SETTINGS(), PCB_BASE_FRAME::CreateNewModule(), FOOTPRINT_EDIT_FRAME::CreateTextModule(), PCB_IO::formatSetup(), FOOTPRINT_EDIT_FRAME::GetConfigurationSettings(), DIALOG_GLOBAL_FOOTPRINTS_FIELDS_EDITION::initDialog(), DIALOG_GRAPHIC_ITEMS_OPTIONS::initValues(), DIALOG_MODEDIT_OPTIONS::initValues(), LEGACY_PLUGIN::loadSETUP(), DIALOG_MODEDIT_OPTIONS::OnOkClick(), DIALOG_GRAPHIC_ITEMS_OPTIONS::OnOkClick(), PCB_PARSER::parseSetup(), DRAWING_TOOL::PlaceText(), PCB_BASE_FRAME::ResetTextSize(), and DIALOG_GLOBAL_FOOTPRINTS_FIELDS_EDITION::TransferDataFromWindow().

NETCLASSES BOARD_DESIGN_SETTINGS::m_NetClasses

List of current netclasses. There is always the default netclass.

Definition at line 109 of file board_design_settings.h.

Referenced by GERBER_JOBFILE_WRITER::addJSONDesignRules(), PCBNEW_CONTROL::AppendBoard(), PCB_EDIT_FRAME::AppendBoardFile(), NETCLASSES::begin(), NETCLASSES::Clear(), DIALOG_DESIGN_RULES::CopyRulesListToBoard(), NETCLASSES::end(), PCB_IO::formatNetInformation(), DSN::SPECCTRA_DB::FromBOARD(), DSN::SPECCTRA_DB::FromSESSION(), GetBiggestClearanceValue(), NETCLASSES::GetCount(), GetCurrentMicroViaDrill(), GetCurrentMicroViaSize(), ROUTER_TOOL::getNetclassDimensions(), GetSmallestClearanceValue(), PNS::SIZES_SETTINGS::Init(), DIALOG_DESIGN_RULES::InitDialogRules(), DIALOG_DESIGN_RULES::InitRulesList(), LEGACY_PLUGIN::loadNETCLASS(), NETCLASSES::NetClasses(), NETINFO_ITEM::NETINFO_ITEM(), PNS_PCBNEW_RULE_RESOLVER::PNS_PCBNEW_RULE_RESOLVER(), NETINFO_ITEM::SetClass(), SetCurrentNetClass(), DRC::testNetClasses(), and DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::updateNetInfo().

D_PAD BOARD_DESIGN_SETTINGS::m_Pad_Master

A dummy pad to store all default parameters.

Definition at line 160 of file board_design_settings.h.

Referenced by PCB_BASE_FRAME::AddPad(), AppendConfigs(), PAD_TOOL::applyPadSettings(), PAD_TOOL::copyPadSettings(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), FOOTPRINT_EDIT_FRAME::DlgGlobalChange_PadSettings(), PCB_EDIT_FRAME::DlgGlobalChange_PadSettings(), PCB_BASE_FRAME::Export_Pad_Settings(), PCB_IO::formatSetup(), PCB_BASE_FRAME::GlobalChange_PadSettings(), PCB_BASE_FRAME::Import_Pad_Settings(), LEGACY_PLUGIN::loadSETUP(), PCB_PARSER::parseSetup(), and PAD_TOOL::pushPadSettings().

wxSize BOARD_DESIGN_SETTINGS::m_PcbTextSize

current Pcb (not module) Text size

Definition at line 120 of file board_design_settings.h.

Referenced by AppendConfigs(), BOARD_DESIGN_SETTINGS(), DRAWING_TOOL::DrawDimension(), PCB_IO::formatSetup(), DIALOG_GRAPHIC_ITEMS_OPTIONS::initValues(), EAGLE_PLUGIN::loadPlain(), LEGACY_PLUGIN::loadSETUP(), DIALOG_GRAPHIC_ITEMS_OPTIONS::OnOkClick(), PCB_PARSER::parseSetup(), DRAWING_TOOL::PlaceText(), and PCB_BASE_FRAME::ResetTextSize().

int BOARD_DESIGN_SETTINGS::m_PcbTextWidth

current Pcb (not module) Text width

Definition at line 119 of file board_design_settings.h.

Referenced by AppendConfigs(), BOARD_DESIGN_SETTINGS(), DRAWING_TOOL::DrawDimension(), PCB_EDIT_FRAME::EditDimension(), PCB_IO::formatSetup(), DIALOG_GRAPHIC_ITEMS_OPTIONS::initValues(), EAGLE_PLUGIN::loadPlain(), LEGACY_PLUGIN::loadSETUP(), DIALOG_GRAPHIC_ITEMS_OPTIONS::OnOkClick(), PCB_PARSER::parseSetup(), DRAWING_TOOL::PlaceText(), and PCB_BASE_FRAME::ResetTextSize().

int BOARD_DESIGN_SETTINGS::m_RefDefaultlayer

Default ref text layer on fp creation.

Definition at line 145 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), PCB_BASE_FRAME::CreateNewModule(), FOOTPRINT_EDIT_FRAME::GetConfigurationSettings(), DIALOG_MODEDIT_OPTIONS::initValues(), FOOTPRINT_EDIT_FRAME::LoadSettings(), and DIALOG_MODEDIT_OPTIONS::OnOkClick().

wxString BOARD_DESIGN_SETTINGS::m_RefDefaultText

Default ref text on fp creation.

Definition at line 142 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), PCB_BASE_FRAME::CreateNewModule(), FOOTPRINT_EDIT_FRAME::GetConfigurationSettings(), DIALOG_MODEDIT_OPTIONS::initValues(), and DIALOG_MODEDIT_OPTIONS::OnOkClick().

bool BOARD_DESIGN_SETTINGS::m_RefDefaultVisibility

Default ref text visibility on fp creation.

Definition at line 144 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), PCB_BASE_FRAME::CreateNewModule(), FOOTPRINT_EDIT_FRAME::GetConfigurationSettings(), DIALOG_MODEDIT_OPTIONS::initValues(), and DIALOG_MODEDIT_OPTIONS::OnOkClick().

int BOARD_DESIGN_SETTINGS::m_SolderMaskMargin

Solder mask margin.

Definition at line 128 of file board_design_settings.h.

Referenced by AppendConfigs(), BOARD_DESIGN_SETTINGS(), FOOTPRINT_EDIT_FRAME::FOOTPRINT_EDIT_FRAME(), PCB_IO::formatSetup(), D_PAD::GetSolderMaskMargin(), DIALOG_PLOT::init_Dialog(), LEGACY_PLUGIN::loadSETUP(), DIALOG_PADS_MASK_CLEARANCE::myInit(), DIALOG_PADS_MASK_CLEARANCE::OnButtonOkClick(), PCB_PARSER::parseSetup(), PlotSolderMaskLayer(), and PlotStandardLayer().

int BOARD_DESIGN_SETTINGS::m_SolderMaskMinWidth

Solder mask min width.

Definition at line 129 of file board_design_settings.h.

Referenced by AppendConfigs(), BOARD_DESIGN_SETTINGS(), PCB_IO::formatSetup(), DIALOG_PLOT::init_Dialog(), LEGACY_PLUGIN::loadSETUP(), DIALOG_PADS_MASK_CLEARANCE::myInit(), DIALOG_PADS_MASK_CLEARANCE::OnButtonOkClick(), PCB_PARSER::parseSetup(), and PlotOneBoardLayer().

int BOARD_DESIGN_SETTINGS::m_SolderPasteMargin

Solder paste margin absolute value.

Definition at line 132 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), PCB_IO::formatSetup(), D_PAD::GetSolderPasteMargin(), LEGACY_PLUGIN::loadSETUP(), DIALOG_PADS_MASK_CLEARANCE::myInit(), DIALOG_PADS_MASK_CLEARANCE::OnButtonOkClick(), and PCB_PARSER::parseSetup().

double BOARD_DESIGN_SETTINGS::m_SolderPasteMarginRatio

Solder pask margin ratio value of pad size The final margin is the sum of these 2 values.

Definition at line 133 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), PCB_IO::formatSetup(), D_PAD::GetSolderPasteMargin(), LEGACY_PLUGIN::loadSETUP(), DIALOG_PADS_MASK_CLEARANCE::myInit(), DIALOG_PADS_MASK_CLEARANCE::OnButtonOkClick(), and PCB_PARSER::parseSetup().

int BOARD_DESIGN_SETTINGS::m_TrackMinWidth

track min value for width ((min copper size value

Definition at line 121 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), DIALOG_DESIGN_RULES::CopyGlobalRulesToBoard(), DIALOG_DRC_CONTROL::DisplayDRCValues(), DRC::doNetClass(), DRC::doTrackDrc(), PCB_IO::formatSetup(), DIALOG_PLOT::init_Dialog(), DIALOG_DESIGN_RULES::InitGlobalRules(), EAGLE_PLUGIN::Load(), LEGACY_PLUGIN::loadSETUP(), PCB_PARSER::parseSetup(), DIALOG_DRC_CONTROL::SetDrcParmeters(), and PNS::DIFF_PAIR_PLACER::Start().

unsigned BOARD_DESIGN_SETTINGS::m_trackWidthIndex

private

0 is the index selection of the default value Netclass

Definition at line 170 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), and SetTrackWidthIndex().

std::vector<int> BOARD_DESIGN_SETTINGS::m_TrackWidthList

Track width list.

Definition at line 106 of file board_design_settings.h.

Referenced by Append_Track_Width_List(), TRACK_VIA_SIZE_MENU::AppendSizes(), DIALOG_DESIGN_RULES::CopyDimensionsListsToBoard(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), PCB_IO::formatSetup(), TRACK_VIA_SIZE_MENU::getTrackDescription(), DIALOG_DESIGN_RULES::InitGlobalRules(), LEGACY_PLUGIN::loadSETUP(), PCB_PARSER::parseSetup(), SetCurrentNetClass(), SetTrackWidthIndex(), PCB_EDITOR_CONTROL::TrackWidthInc(), TRACK_VIA_SIZE_MENU::update(), and PCB_EDIT_FRAME::updateTraceWidthSelectBox().

bool BOARD_DESIGN_SETTINGS::m_UseConnectedTrackWidth

if true, when creating a new track starting on an existing track, use this track width

Definition at line 116 of file board_design_settings.h.

Referenced by Append_Track_Width_List(), BOARD_DESIGN_SETTINGS(), TRACK_WIDTH_MENU::eventHandler(), PNS::SIZES_SETTINGS::Init(), PCB_EDIT_FRAME::OnUpdateSelectTrackWidth(), PCB_EDIT_FRAME::OnUpdateSelectViaSize(), ShowNewTrackWhenMovingCursor(), and PCB_EDIT_FRAME::Tracks_and_Vias_Size_Event().

bool BOARD_DESIGN_SETTINGS::m_useCustomTrackVia

private

Use custom values for track/via sizes (not specified in net class nor in the size lists).

Definition at line 173 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), GetCurrentViaDrill(), SetTrackWidthIndex(), and SetViaSizeIndex().

int BOARD_DESIGN_SETTINGS::m_ValueDefaultlayer

Default value text layer on fp creation.

Definition at line 152 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), PCB_BASE_FRAME::CreateNewModule(), FOOTPRINT_EDIT_FRAME::GetConfigurationSettings(), DIALOG_MODEDIT_OPTIONS::initValues(), FOOTPRINT_EDIT_FRAME::LoadSettings(), and DIALOG_MODEDIT_OPTIONS::OnOkClick().

wxString BOARD_DESIGN_SETTINGS::m_ValueDefaultText

Default value text on fp creation.

Definition at line 149 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), PCB_BASE_FRAME::CreateNewModule(), FOOTPRINT_EDIT_FRAME::GetConfigurationSettings(), DIALOG_MODEDIT_OPTIONS::initValues(), and DIALOG_MODEDIT_OPTIONS::OnOkClick().

bool BOARD_DESIGN_SETTINGS::m_ValueDefaultVisibility

Default value text visibility on fp creation.

Definition at line 151 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), PCB_BASE_FRAME::CreateNewModule(), FOOTPRINT_EDIT_FRAME::GetConfigurationSettings(), DIALOG_MODEDIT_OPTIONS::initValues(), and DIALOG_MODEDIT_OPTIONS::OnOkClick().

std::vector<VIA_DIMENSION> BOARD_DESIGN_SETTINGS::m_ViasDimensionsList

Vias size and drill list.

Definition at line 102 of file board_design_settings.h.

Referenced by Append_Track_Width_List(), TRACK_VIA_SIZE_MENU::AppendSizes(), DIALOG_DESIGN_RULES::CopyDimensionsListsToBoard(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), PCB_IO::formatSetup(), GetCurrentViaDrill(), TRACK_VIA_SIZE_MENU::getViaDescription(), DIALOG_DESIGN_RULES::InitGlobalRules(), LEGACY_PLUGIN::loadSETUP(), PCB_PARSER::parseSetup(), SetCurrentNetClass(), SetViaSizeIndex(), TRACK_VIA_SIZE_MENU::update(), PCB_EDIT_FRAME::updateViaSizeSelectBox(), and PCB_EDITOR_CONTROL::ViaSizeInc().

unsigned BOARD_DESIGN_SETTINGS::m_viaSizeIndex

private

Index for m_ViasDimensionsList to select the current via size.

0 is the index selection of the default value Netclass

Definition at line 166 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), GetCurrentViaDrill(), and SetViaSizeIndex().

int BOARD_DESIGN_SETTINGS::m_ViasMinDrill

vias (not micro vias) min drill diameter

Definition at line 123 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), DIALOG_DESIGN_RULES::CopyGlobalRulesToBoard(), DRC::doNetClass(), DRC::doTrackDrc(), PCB_IO::formatSetup(), DIALOG_DESIGN_RULES::InitGlobalRules(), EAGLE_PLUGIN::Load(), LEGACY_PLUGIN::loadSETUP(), and PCB_PARSER::parseSetup().

int BOARD_DESIGN_SETTINGS::m_ViasMinSize

vias (not micro vias) min diameter

Definition at line 122 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), DIALOG_DESIGN_RULES::CopyGlobalRulesToBoard(), DIALOG_DRC_CONTROL::DisplayDRCValues(), DRC::doNetClass(), DRC::doTrackDrc(), PCB_IO::formatSetup(), DIALOG_DESIGN_RULES::InitGlobalRules(), EAGLE_PLUGIN::Load(), LEGACY_PLUGIN::loadSETUP(), PCB_PARSER::parseSetup(), and DIALOG_DRC_CONTROL::SetDrcParmeters().

int BOARD_DESIGN_SETTINGS::m_visibleElements

private

Bit-mask for element category visibility.

Definition at line 186 of file board_design_settings.h.

Referenced by BOARD_DESIGN_SETTINGS(), SetElementVisibility(), and SetVisibleAlls().

LSET BOARD_DESIGN_SETTINGS::m_visibleLayers

private

Bit-mask for layer visibility.

Definition at line 184 of file board_design_settings.h.

Referenced by SetEnabledLayers(), and SetLayerVisibility().

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

Public Member Functions

Public Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation