KiCad PCB EDA Suite
LAYER Struct Reference

Container to hold information pertinent to a layer of a BOARD. More...

#include <board.h>

Public Member Functions

 LAYER ()
 
void clear ()
 

Static Public Member Functions

static const char * ShowType (LAYER_T aType)
 Convert a LAYER_T enum to a string representation of the layer type. More...
 
static LAYER_T ParseType (const char *aType)
 Convert a string to a LAYER_T. More...
 

Public Attributes

wxString m_name
 The canonical name of the layer. More...
 
wxString m_userName
 The user defined name of the layer. More...
 
LAYER_T m_type
 The type of the layer. More...
 
bool m_visible
 
int m_number
 The layer ID. More...
 

Detailed Description

Container to hold information pertinent to a layer of a BOARD.

Definition at line 159 of file board.h.

Constructor & Destructor Documentation

◆ LAYER()

LAYER::LAYER ( )
inline

Definition at line 161 of file board.h.

162 {
163 clear();
164 }
void clear()
Definition: board.h:166

References clear().

Member Function Documentation

◆ clear()

void LAYER::clear ( )
inline

Definition at line 166 of file board.h.

167 {
169 m_visible = true;
170 m_number = 0;
171 m_name.clear();
172 m_userName.clear();
173 }
@ LT_SIGNAL
Definition: board.h:149
LAYER_T m_type
The type of the layer.
Definition: board.h:188
wxString m_name
The canonical name of the layer.
Definition: board.h:186
wxString m_userName
The user defined name of the layer.
Definition: board.h:187
bool m_visible
Definition: board.h:189
int m_number
The layer ID.
Definition: board.h:190

References LT_SIGNAL, m_name, m_number, m_type, m_userName, and m_visible.

Referenced by LAYER(), and PCB_PARSER::parseLayer().

◆ ParseType()

LAYER_T LAYER::ParseType ( const char *  aType)
static

Convert a string to a LAYER_T.

Parameters
aTypeThe layer name to convert.
Returns
The binary representation of the layer type, or LAYER_T(-1) if the string is invalid.

Definition at line 548 of file board.cpp.

549{
550 if( strcmp( aType, "signal" ) == 0 )
551 return LT_SIGNAL;
552 else if( strcmp( aType, "power" ) == 0 )
553 return LT_POWER;
554 else if( strcmp( aType, "mixed" ) == 0 )
555 return LT_MIXED;
556 else if( strcmp( aType, "jumper" ) == 0 )
557 return LT_JUMPER;
558 else
559 return LT_UNDEFINED;
560}
@ LT_POWER
Definition: board.h:150
@ LT_MIXED
Definition: board.h:151
@ LT_UNDEFINED
Definition: board.h:148
@ LT_JUMPER
Definition: board.h:152

References LT_JUMPER, LT_MIXED, LT_POWER, LT_SIGNAL, and LT_UNDEFINED.

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

◆ ShowType()

const char * LAYER::ShowType ( LAYER_T  aType)
static

Convert a LAYER_T enum to a string representation of the layer type.

Parameters
aTypeThe LAYER_T to convert
Returns
The string representation of the layer type.

Definition at line 535 of file board.cpp.

536{
537 switch( aType )
538 {
539 default:
540 case LT_SIGNAL: return "signal";
541 case LT_POWER: return "power";
542 case LT_MIXED: return "mixed";
543 case LT_JUMPER: return "jumper";
544 }
545}

References LT_JUMPER, LT_MIXED, LT_POWER, and LT_SIGNAL.

Referenced by PCB_PLUGIN::formatBoardLayers().

Member Data Documentation

◆ m_name

wxString LAYER::m_name

The canonical name of the layer.

See also
LSET::Name

Definition at line 186 of file board.h.

Referenced by BOARD::BOARD(), clear(), PCB_PARSER::parseLayer(), and PCB_PARSER::parseLayers().

◆ m_number

int LAYER::m_number

The layer ID.

See also
PCB_LAYER_ID

Definition at line 190 of file board.h.

Referenced by clear(), PCB_PARSER::parseLayer(), and PCB_PARSER::parseLayers().

◆ m_type

LAYER_T LAYER::m_type

The type of the layer.

See also
LAYER_T

Definition at line 188 of file board.h.

Referenced by BOARD::BOARD(), clear(), BOARD::GetLayerType(), PCB_PARSER::parseLayer(), PCB_PARSER::parseLayers(), and BOARD::SetLayerType().

◆ m_userName

wxString LAYER::m_userName

The user defined name of the layer.

Definition at line 187 of file board.h.

Referenced by clear(), BOARD::GetLayerName(), PCB_PARSER::parseLayer(), and BOARD::SetLayerName().

◆ m_visible

bool LAYER::m_visible

Definition at line 189 of file board.h.

Referenced by clear(), PCB_PARSER::parseLayer(), and PCB_PARSER::parseLayers().


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