GTIRB  v1.10.4
GrammaTech Intermediate Representation for Binaries: C++ API
Public Member Functions | Public Attributes | Friends | List of all members
gtirb::Offset Class Reference

Describes a location inside a node (byte interval, block, etc). More...

#include <Offset.hpp>

Public Member Functions

 Offset ()=default
 Default constructor. More...
 
 Offset (const UUID &ElemId, uint64_t Disp)
 Constructor using a ElemId uuid and a Displacement. More...
 

Public Attributes

uint64_t Displacement {0}
 The displacement from the start of the node, in bytes. More...
 
UUID ElementId
 The UUID of the node. More...
 

Friends

bool fromProtobuf (Context &, Offset &, const MessageType &)
 
bool operator!= (const Offset &LHS, const Offset &RHS) noexcept
 Inequality operator for Offset. More...
 
constexpr friend bool operator< (const Offset &LHS, const Offset &RHS) noexcept
 Less-than operator for Offset. More...
 
constexpr friend bool operator<= (const Offset &LHS, const Offset &RHS) noexcept
 Less-than-or-equal operator for Offset. More...
 
bool operator== (const Offset &LHS, const Offset &RHS) noexcept
 Equality operator for Offset. More...
 
constexpr friend bool operator> (const Offset &LHS, const Offset &RHS) noexcept
 Greater-than operator for Offset. More...
 
constexpr friend bool operator>= (const Offset &LHS, const Offset &RHS) noexcept
 Greater-than-or-equal operator for Offset. More...
 

Detailed Description

Describes a location inside a node (byte interval, block, etc).

Constructor & Destructor Documentation

◆ Offset() [1/2]

gtirb::Offset::Offset ( const UUID ElemId,
uint64_t  Disp 
)
inline

Constructor using a ElemId uuid and a Displacement.

◆ Offset() [2/2]

gtirb::Offset::Offset ( )
default

Default constructor.

Friends And Related Function Documentation

◆ fromProtobuf

bool fromProtobuf ( Context ,
Offset ,
const MessageType &   
)
friend

◆ operator!=

bool operator!= ( const Offset LHS,
const Offset RHS 
)
friend

Inequality operator for Offset.

◆ operator<

constexpr friend bool operator< ( const Offset LHS,
const Offset RHS 
)
friend

Less-than operator for Offset.

◆ operator<=

constexpr friend bool operator<= ( const Offset LHS,
const Offset RHS 
)
friend

Less-than-or-equal operator for Offset.

◆ operator==

bool operator== ( const Offset LHS,
const Offset RHS 
)
friend

Equality operator for Offset.

◆ operator>

constexpr friend bool operator> ( const Offset LHS,
const Offset RHS 
)
friend

Greater-than operator for Offset.

◆ operator>=

constexpr friend bool operator>= ( const Offset LHS,
const Offset RHS 
)
friend

Greater-than-or-equal operator for Offset.

Member Data Documentation

◆ Displacement

uint64_t gtirb::Offset::Displacement {0}

The displacement from the start of the node, in bytes.

◆ ElementId

UUID gtirb::Offset::ElementId

The UUID of the node.


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