OdbDesignLib
OdbDesign ODB++ Parsing Library
 
Loading...
Searching...
No Matches
Classes | Public Member Functions | Static Public Attributes | List of all members
Odb::Lib::FileModel::Design::ComponentsFile Class Reference
Inheritance diagram for Odb::Lib::FileModel::Design::ComponentsFile:
Odb::Lib::IProtoBuffable< Odb::Lib::Protobuf::ComponentsFile > Odb::Lib::FileModel::IStreamSaveable

Classes

struct  BomDescriptionRecord
 
struct  ComponentRecord
 

Public Member Functions

bool Parse (std::filesystem::path directory)
 
bool Save (std::ostream &os) override
 
std::string GetUnits () const
 
BoardSide GetSide () const
 
std::filesystem::path GetPath ()
 
std::filesystem::path GetDirectory ()
 
std::string GetLayerName () const
 
const ComponentRecord::Vector & GetComponentRecords () const
 
const ComponentRecord::StringMap & GetComponentRecordsByName () const
 
const std::vector< std::string > & GetAttributeNames () const
 
const std::vector< std::string > & GetAttributeTextValues () const
 
const BomDescriptionRecord::StringMap & GetBomDescriptionRecordsByCpn () const
 
std::unique_ptr< Odb::Lib::Protobuf::ComponentsFile > to_protobuf () const override
 
void from_protobuf (const Odb::Lib::Protobuf::ComponentsFile &message) override
 
- Public Member Functions inherited from Odb::Lib::IProtoBuffable< Odb::Lib::Protobuf::ComponentsFile >
bool to_pbstring (std::string &pb_string) const
 
bool from_pbstring (const std::string &pb_string)
 
bool to_stream (std::ostream &outputStream) const
 
bool from_stream (std::istream &inputStream)
 
std::string to_json () const override
 
void from_json (const std::string &json) override
 

Static Public Attributes

static constexpr const char * TOP_COMPONENTS_LAYER_NAME = "comp_+_top"
 
static constexpr const char * BOTTOM_COMPONENTS_LAYER_NAME = "comp_+_bot"
 

Detailed Description

Definition at line 19 of file ComponentsFile.h.

Constructor & Destructor Documentation

◆ ComponentsFile()

Odb::Lib::FileModel::Design::ComponentsFile::ComponentsFile ( )

Definition at line 19 of file ComponentsFile.cpp.

◆ ~ComponentsFile()

Odb::Lib::FileModel::Design::ComponentsFile::~ComponentsFile ( )

Definition at line 25 of file ComponentsFile.cpp.

Member Function Documentation

◆ from_protobuf()

void Odb::Lib::FileModel::Design::ComponentsFile::from_protobuf ( const Odb::Lib::Protobuf::ComponentsFile &  message)
overridevirtual

Implements Odb::Lib::IProtoBuffable< Odb::Lib::Protobuf::ComponentsFile >.

Definition at line 126 of file ComponentsFile.cpp.

◆ GetAttributeNames()

const std::vector< std::string > & Odb::Lib::FileModel::Design::ComponentsFile::GetAttributeNames ( ) const

Definition at line 69 of file ComponentsFile.cpp.

◆ GetAttributeTextValues()

const std::vector< std::string > & Odb::Lib::FileModel::Design::ComponentsFile::GetAttributeTextValues ( ) const

Definition at line 74 of file ComponentsFile.cpp.

◆ GetBomDescriptionRecordsByCpn()

const ComponentsFile::BomDescriptionRecord::StringMap & Odb::Lib::FileModel::Design::ComponentsFile::GetBomDescriptionRecordsByCpn ( ) const

Definition at line 79 of file ComponentsFile.cpp.

◆ GetComponentRecords()

const ComponentsFile::ComponentRecord::Vector & Odb::Lib::FileModel::Design::ComponentsFile::GetComponentRecords ( ) const

Definition at line 59 of file ComponentsFile.cpp.

◆ GetComponentRecordsByName()

const ComponentsFile::ComponentRecord::StringMap & Odb::Lib::FileModel::Design::ComponentsFile::GetComponentRecordsByName ( ) const

Definition at line 64 of file ComponentsFile.cpp.

◆ GetDirectory()

std::filesystem::path Odb::Lib::FileModel::Design::ComponentsFile::GetDirectory ( )

Definition at line 49 of file ComponentsFile.cpp.

◆ GetLayerName()

std::string Odb::Lib::FileModel::Design::ComponentsFile::GetLayerName ( ) const

Definition at line 54 of file ComponentsFile.cpp.

◆ GetPath()

std::filesystem::path Odb::Lib::FileModel::Design::ComponentsFile::GetPath ( )

Definition at line 44 of file ComponentsFile.cpp.

◆ GetSide()

BoardSide Odb::Lib::FileModel::Design::ComponentsFile::GetSide ( ) const

Definition at line 39 of file ComponentsFile.cpp.

◆ GetUnits()

std::string Odb::Lib::FileModel::Design::ComponentsFile::GetUnits ( ) const

Definition at line 34 of file ComponentsFile.cpp.

◆ Parse()

bool Odb::Lib::FileModel::Design::ComponentsFile::Parse ( std::filesystem::path  directory)

Definition at line 294 of file ComponentsFile.cpp.

◆ Save()

bool Odb::Lib::FileModel::Design::ComponentsFile::Save ( std::ostream &  os)
overridevirtual

Implements Odb::Lib::FileModel::IStreamSaveable.

Definition at line 160 of file ComponentsFile.cpp.

◆ to_protobuf()

std::unique_ptr< Odb::Lib::Protobuf::ComponentsFile > Odb::Lib::FileModel::Design::ComponentsFile::to_protobuf ( ) const
overridevirtual

Implements Odb::Lib::IProtoBuffable< Odb::Lib::Protobuf::ComponentsFile >.

Definition at line 84 of file ComponentsFile.cpp.

Member Data Documentation

◆ BOTTOM_COMPONENTS_LAYER_NAME

constexpr const char* Odb::Lib::FileModel::Design::ComponentsFile::BOTTOM_COMPONENTS_LAYER_NAME = "comp_+_bot"
inlinestaticconstexpr

Definition at line 128 of file ComponentsFile.h.

◆ TOP_COMPONENTS_LAYER_NAME

constexpr const char* Odb::Lib::FileModel::Design::ComponentsFile::TOP_COMPONENTS_LAYER_NAME = "comp_+_top"
inlinestaticconstexpr

Definition at line 127 of file ComponentsFile.h.

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