Skip to content

Struct opae::fpga::types::guid_t

ClassList > opae > fpga > types > guid_t

Representation of the guid member of a properties object.

  • #include <pvalue.h>

Public Functions

Type Name
const uint8_t * c_type () const
Return a raw pointer to the guid.
guid_t (fpga_properties * p)
Construct the guid_t given its containing fpga_properties.
void invalidate ()
Invalidate the cached local copy of the guid.
bool is_set () const
Tracks whether the cached local copy of the guid is valid.
operator uint8_t * ()
Return a raw pointer to the guid.
guid_t & operator= (fpga_guid g)
Assign from fpga_guid Sets the guid field of the associated properties object using the OPAE properties API.
bool operator== (const fpga_guid & g)
Compare contents with an fpga_guid.
void parse (const char * str)
Convert a string representation of a guid to binary.
void update ()
Update the local cached copy of the guid.

Public Functions Documentation

function c_type

inline const uint8_t * opae::fpga::types::guid_t::c_type () const

function guid_t

inline opae::fpga::types::guid_t::guid_t (
    fpga_properties * p
) 

function invalidate

inline void opae::fpga::types::guid_t::invalidate () 

function is_set

inline bool opae::fpga::types::guid_t::is_set () const

function operator uint8_t *

Return a raw pointer to the guid.

inline opae::fpga::types::guid_t::operator uint8_t * () 

Return value:

  • nullptr if the guid could not be queried.

function operator=

Assign from fpga_guid Sets the guid field of the associated properties object using the OPAE properties API.

inline guid_t & opae::fpga::types::guid_t::operator= (
    fpga_guid g
) 

Parameters:

  • g The given fpga_guid.

Returns:

a reference to this guid_t.

function operator==

Compare contents with an fpga_guid.

inline bool opae::fpga::types::guid_t::operator== (
    const fpga_guid & g
) 

Return value:

  • The result of memcmp of the two objects.

function parse

Convert a string representation of a guid to binary.

inline void opae::fpga::types::guid_t::parse (
    const char * str
) 

Parameters:

  • str The guid string.

function update

inline void opae::fpga::types::guid_t::update () 

Friends Documentation

friend operator<<

inline std::ostream & opae::fpga::types::guid_t::operator<< (
    std::ostream & ostr,
    const guid_t & g
) 

The documentation for this class was generated from the following file docs/sw/include/opae/cxx/core/pvalue.h