KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
TOP_LEVEL_SHEET_INFO Struct Reference

Information about a top-level schematic sheet. More...

#include <project_file.h>

Public Member Functions

 TOP_LEVEL_SHEET_INFO ()=default
 
 TOP_LEVEL_SHEET_INFO (const KIID &aUuid, const wxString &aName, const wxString &aFilename)
 
bool operator== (const TOP_LEVEL_SHEET_INFO &aOther) const
 
bool operator!= (const TOP_LEVEL_SHEET_INFO &aOther) const
 

Public Attributes

KIID uuid
 Unique identifier for the sheet.
 
wxString name
 Display name for the sheet.
 
wxString filename
 Relative path to the sheet file.
 

Detailed Description

Information about a top-level schematic sheet.

Definition at line 49 of file project_file.h.

Constructor & Destructor Documentation

◆ TOP_LEVEL_SHEET_INFO() [1/2]

TOP_LEVEL_SHEET_INFO::TOP_LEVEL_SHEET_INFO ( )
default

Referenced by operator!=(), and operator==().

◆ TOP_LEVEL_SHEET_INFO() [2/2]

TOP_LEVEL_SHEET_INFO::TOP_LEVEL_SHEET_INFO ( const KIID & aUuid,
const wxString & aName,
const wxString & aFilename )
inline

Definition at line 57 of file project_file.h.

References filename, name, and uuid.

Member Function Documentation

◆ operator!=()

bool TOP_LEVEL_SHEET_INFO::operator!= ( const TOP_LEVEL_SHEET_INFO & aOther) const
inline

Definition at line 66 of file project_file.h.

References TOP_LEVEL_SHEET_INFO().

◆ operator==()

bool TOP_LEVEL_SHEET_INFO::operator== ( const TOP_LEVEL_SHEET_INFO & aOther) const
inline

Definition at line 61 of file project_file.h.

References filename, name, TOP_LEVEL_SHEET_INFO(), and uuid.

Member Data Documentation

◆ filename

wxString TOP_LEVEL_SHEET_INFO::filename

Relative path to the sheet file.

Definition at line 53 of file project_file.h.

Referenced by BOOST_AUTO_TEST_CASE(), from_json(), PROJECT_FILE::LoadFromFile(), operator==(), to_json(), and TOP_LEVEL_SHEET_INFO().

◆ name

wxString TOP_LEVEL_SHEET_INFO::name

Display name for the sheet.

Definition at line 52 of file project_file.h.

Referenced by BOOST_AUTO_TEST_CASE(), from_json(), PROJECT_FILE::LoadFromFile(), operator==(), to_json(), and TOP_LEVEL_SHEET_INFO().

◆ uuid

KIID TOP_LEVEL_SHEET_INFO::uuid

Unique identifier for the sheet.

Definition at line 51 of file project_file.h.

Referenced by BOOST_AUTO_TEST_CASE(), from_json(), PROJECT_FILE::LoadFromFile(), operator==(), to_json(), and TOP_LEVEL_SHEET_INFO().

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