Bifrost SDK
Bifrost SDK documentation
BifrostGraph::Executor::WatchpointLayoutArray Class Reference

Array layout. More...

#include <WatchpointLayout.h>

Inheritance diagram for BifrostGraph::Executor::WatchpointLayoutArray:
BifrostGraph::Executor::WatchpointLayout

Public Member Functions

 ~WatchpointLayoutArray () override
 Destructor. More...
 
Amino::TypeId const & getElementTypeId () const
 Get the element typeId of the layout array type. More...
 
Amino::Type const & getElementType () const
 Get the element type of the layout array type. More...
 
Amino::String const & getElementTypeName () const
 Get the fully qualified element type name of the layout array type. More...
 
Amino::String const & getElementTypeKind () const
 Get the kind name of the element layout's. More...
 
bool getIndices (Watchpoint::Filters const &filters, Watchpoint::Sorter const &sorter, Watchpoint::Indices &out_indices) const
 Helper to return the indices of the array for given filters and sorter settings. More...
 
std::size_t size () const
 Return the number of elements. More...
 
WatchpointLayoutPtr layout (std::size_t index) const
 Get the layout of the element at given index. More...
 
- Public Member Functions inherited from BifrostGraph::Executor::WatchpointLayout
virtual ~WatchpointLayout ()
 Destructor. More...
 
Amino::TypeId const & getTypeId () const
 Get the typeId the layout is based on. More...
 
Amino::Type const & getType () const
 Get the type the layout is based on. More...
 
Amino::String const & getTypeName () const
 Get the fully qualified type name the layout is based on. More...
 
Amino::String const & getTypeKind () const
 Get the layout's kind name. More...
 

Static Public Member Functions

static WatchpointLayoutPtr create (WatchpointLayoutFactory const &factory, Amino::Any const &value)
 Create a new WatchpointLayoutArray for value value. More...
 
static WatchpointLayoutPtr create (WatchpointLayoutFactory const &factory, Amino::Type const &type, Amino::Any const &value)
 Create a new WatchpointLayoutArray for value value. More...
 
- Static Public Member Functions inherited from BifrostGraph::Executor::WatchpointLayout
static WatchpointLayoutPtr create (WatchpointLayoutFactory const &factory, Amino::TypeId const &typeId)
 Create a new WatchpointLayout. More...
 
static WatchpointLayoutPtr create (Amino::Type const &type, Amino::TypeId const &typeId)
 Create a new WatchpointLayout. More...
 

Protected Member Functions

 WatchpointLayoutArray (WatchpointLayoutFactory const &factory, Amino::Type const &type, Amino::Any const &value)
 Internal constructor. More...
 
- Protected Member Functions inherited from BifrostGraph::Executor::WatchpointLayout
 WatchpointLayout (Amino::Type const &type, Amino::TypeId const &typeId)
 Internal constructor. More...
 

Detailed Description

Array layout.

Definition at line 321 of file WatchpointLayout.h.

Constructor & Destructor Documentation

◆ ~WatchpointLayoutArray()

BifrostGraph::Executor::WatchpointLayoutArray::~WatchpointLayoutArray ( )
override

Destructor.

◆ WatchpointLayoutArray()

BifrostGraph::Executor::WatchpointLayoutArray::WatchpointLayoutArray ( WatchpointLayoutFactory const &  factory,
Amino::Type const &  type,
Amino::Any const &  value 
)
protected

Internal constructor.

Member Function Documentation

◆ create() [1/2]

static WatchpointLayoutPtr BifrostGraph::Executor::WatchpointLayoutArray::create ( WatchpointLayoutFactory const &  factory,
Amino::Any const &  value 
)
static

Create a new WatchpointLayoutArray for value value.

Parameters
factoryThe layout factory.
valueThe value.
Returns
a smart pointer to the new layout.

◆ create() [2/2]

static WatchpointLayoutPtr BifrostGraph::Executor::WatchpointLayoutArray::create ( WatchpointLayoutFactory const &  factory,
Amino::Type const &  type,
Amino::Any const &  value 
)
static

Create a new WatchpointLayoutArray for value value.

Parameters
factoryThe layout factory.
typethe datamodel type of the layout
valueThe value.
Returns
a smart pointer to the new layout.

◆ getElementType()

Amino::Type const & BifrostGraph::Executor::WatchpointLayoutArray::getElementType ( ) const

Get the element type of the layout array type.

◆ getElementTypeId()

Amino::TypeId const & BifrostGraph::Executor::WatchpointLayoutArray::getElementTypeId ( ) const

Get the element typeId of the layout array type.

◆ getElementTypeKind()

Amino::String const & BifrostGraph::Executor::WatchpointLayoutArray::getElementTypeKind ( ) const

Get the kind name of the element layout's.

Note
This corresponds to the element type's 'type_kind' metadata.

◆ getElementTypeName()

Amino::String const & BifrostGraph::Executor::WatchpointLayoutArray::getElementTypeName ( ) const

Get the fully qualified element type name of the layout array type.

◆ getIndices()

bool BifrostGraph::Executor::WatchpointLayoutArray::getIndices ( Watchpoint::Filters const &  filters,
Watchpoint::Sorter const &  sorter,
Watchpoint::Indices out_indices 
) const

Helper to return the indices of the array for given filters and sorter settings.

Parameters
filtersThe list of filters
sorterThe sorting settings
out_indicesThe filtered and sorted indices
Returns
True on success, false otherwise.

◆ layout()

WatchpointLayoutPtr BifrostGraph::Executor::WatchpointLayoutArray::layout ( std::size_t  index) const

Get the layout of the element at given index.

Parameters
indexThe index of the element.
Returns
The element layout on success or an empty pointer otherwise.

◆ size()

std::size_t BifrostGraph::Executor::WatchpointLayoutArray::size ( ) const

Return the number of elements.