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

Path to an element in a layout. More...

#include <WatchpointLayout.h>

Public Member Functions

 WatchpointLayoutPath ()
 Constructors. More...
 
 WatchpointLayoutPath (Amino::String const &path)
 Constructors. More...
 
 WatchpointLayoutPath (WatchpointLayoutPath const &)
 Constructors. More...
 
 WatchpointLayoutPath (WatchpointLayoutPath &&)
 Constructors. More...
 
 ~WatchpointLayoutPath ()
 /} More...
 
WatchpointLayoutPathoperator= (WatchpointLayoutPath const &)
 Assignment operators. More...
 
WatchpointLayoutPathoperator= (WatchpointLayoutPath &&)
 Constructors. More...
 
bool empty () const
 /} More...
 
void push_front (Amino::String const &element)
 Prepend an element. More...
 
void push_front (std::size_t index)
 Prepend an array index. More...
 
Amino::String const & front () const
 Get the first element of the path. More...
 
bool frontIsIndex () const
 Check if first item of path is an array index. More...
 
std::size_t frontAsIndex () const
 Get the first element of the path as an array index. More...
 
WatchpointLayoutPathpop_front ()
 Remove fist element. More...
 
void push_back (Amino::String const &element)
 Append an element. More...
 
void push_back (std::size_t index)
 Append an array index. More...
 
Amino::String const & back () const
 Get the last element of the path. More...
 
bool backIsIndex () const
 Check if last item of path is an array index. More...
 
std::size_t backAsIndex () const
 Get the last element of the path as an array index. More...
 
WatchpointLayoutPathpop_back ()
 Remove last element. More...
 

Detailed Description

Path to an element in a layout.

Definition at line 476 of file WatchpointLayout.h.

Constructor & Destructor Documentation

◆ WatchpointLayoutPath() [1/4]

BifrostGraph::Executor::WatchpointLayoutPath::WatchpointLayoutPath ( )

Constructors.

◆ WatchpointLayoutPath() [2/4]

BifrostGraph::Executor::WatchpointLayoutPath::WatchpointLayoutPath ( Amino::String const &  path)
explicit

Constructors.

◆ WatchpointLayoutPath() [3/4]

BifrostGraph::Executor::WatchpointLayoutPath::WatchpointLayoutPath ( WatchpointLayoutPath const &  )

Constructors.

◆ WatchpointLayoutPath() [4/4]

BifrostGraph::Executor::WatchpointLayoutPath::WatchpointLayoutPath ( WatchpointLayoutPath &&  )

Constructors.

◆ ~WatchpointLayoutPath()

BifrostGraph::Executor::WatchpointLayoutPath::~WatchpointLayoutPath ( )

/}

Destructor

Member Function Documentation

◆ back()

Amino::String const & BifrostGraph::Executor::WatchpointLayoutPath::back ( ) const

Get the last element of the path.

◆ backAsIndex()

std::size_t BifrostGraph::Executor::WatchpointLayoutPath::backAsIndex ( ) const

Get the last element of the path as an array index.

◆ backIsIndex()

bool BifrostGraph::Executor::WatchpointLayoutPath::backIsIndex ( ) const

Check if last item of path is an array index.

◆ empty()

bool BifrostGraph::Executor::WatchpointLayoutPath::empty ( ) const

/}

Check if path is empty

◆ front()

Amino::String const & BifrostGraph::Executor::WatchpointLayoutPath::front ( ) const

Get the first element of the path.

◆ frontAsIndex()

std::size_t BifrostGraph::Executor::WatchpointLayoutPath::frontAsIndex ( ) const

Get the first element of the path as an array index.

◆ frontIsIndex()

bool BifrostGraph::Executor::WatchpointLayoutPath::frontIsIndex ( ) const

Check if first item of path is an array index.

◆ operator=() [1/2]

WatchpointLayoutPath & BifrostGraph::Executor::WatchpointLayoutPath::operator= ( WatchpointLayoutPath &&  )

Constructors.

◆ operator=() [2/2]

WatchpointLayoutPath & BifrostGraph::Executor::WatchpointLayoutPath::operator= ( WatchpointLayoutPath const &  )

Assignment operators.

◆ pop_back()

WatchpointLayoutPath & BifrostGraph::Executor::WatchpointLayoutPath::pop_back ( )

Remove last element.

Returns
self

◆ pop_front()

WatchpointLayoutPath & BifrostGraph::Executor::WatchpointLayoutPath::pop_front ( )

Remove fist element.

Returns
self

◆ push_back() [1/2]

void BifrostGraph::Executor::WatchpointLayoutPath::push_back ( Amino::String const &  element)

Append an element.

Parameters
elementThe element's name

◆ push_back() [2/2]

void BifrostGraph::Executor::WatchpointLayoutPath::push_back ( std::size_t  index)

Append an array index.

Parameters
indexThe array index

◆ push_front() [1/2]

void BifrostGraph::Executor::WatchpointLayoutPath::push_front ( Amino::String const &  element)

Prepend an element.

Parameters
elementThe element's name

◆ push_front() [2/2]

void BifrostGraph::Executor::WatchpointLayoutPath::push_front ( std::size_t  index)

Prepend an array index.

Parameters
indexThe array index