geopm  3.1.1.dev214+gba4f9f6d
GEOPM - Global Extensible Open Power Manager
Public Member Functions | List of all members
geopm::ELF Class Referenceabstract

Class encapsulating interactions with ELF files. More...

Inheritance diagram for geopm::ELF:
Inheritance graph
[legend]

Public Member Functions

 ELF ()=default
 
virtual ~ELF ()=default
 
virtual size_t num_symbol (void)=0
 Get the number of symbols in the current section. More...
 
virtual std::string symbol_name (void)=0
 Get the name of the current symbol. More...
 
virtual size_t symbol_offset (void)=0
 Get the offset of the current symbol. More...
 
virtual bool next_section (void)=0
 Iterate to the next section. More...
 
virtual bool next_data (void)=0
 Iterate to the next data descriptor in the section. More...
 
virtual bool next_symbol (void)=0
 Iterate to the next symbol in the section. More...
 

Detailed Description

Class encapsulating interactions with ELF files.

Constructor & Destructor Documentation

◆ ELF()

geopm::ELF::ELF ( )
default

◆ ~ELF()

virtual geopm::ELF::~ELF ( )
virtualdefault

Member Function Documentation

◆ next_data()

virtual bool geopm::ELF::next_data ( void  )
pure virtual

Iterate to the next data descriptor in the section.

Returns
True if next data descriptor exists, false when all data descriptors in the section have been iterated over.

Implemented in geopm::ELFImp.

◆ next_section()

virtual bool geopm::ELF::next_section ( void  )
pure virtual

Iterate to the next section.

Returns
True if next section exists, false when all sections have been iterated over.

Implemented in geopm::ELFImp.

◆ next_symbol()

virtual bool geopm::ELF::next_symbol ( void  )
pure virtual

Iterate to the next symbol in the section.

Returns
True if next symbol in section exists, false when all symbols in the section have been iterated over.

Implemented in geopm::ELFImp.

◆ num_symbol()

virtual size_t geopm::ELF::num_symbol ( void  )
pure virtual

Get the number of symbols in the current section.

Returns
Number of symbols.

Implemented in geopm::ELFImp.

◆ symbol_name()

virtual std::string geopm::ELF::symbol_name ( void  )
pure virtual

Get the name of the current symbol.

Returns
Current symbol name. Will return an empty string if all symbols in section have been iterated over.

Implemented in geopm::ELFImp.

◆ symbol_offset()

virtual size_t geopm::ELF::symbol_offset ( void  )
pure virtual

Get the offset of the current symbol.

Returns
Current symbol offset. Will return zero if all symbols in section have been iterated over.

Implemented in geopm::ELFImp.


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