Bifrost SDK
Bifrost SDK documentation
Amino::Source Class Reference

Generic opaque handle to a source (provenance). More...

#include <Source.h>

Public Member Functions

 Source () noexcept
 Default constructor (empty/invalid Source). More...
 
 Source (Source const &o)
 Copy constructor. More...
 
 Source (Source &&o) noexcept
 Move constructor. More...
 
Sourceoperator= (Source const &o)
 Copy assignment operator. More...
 
Sourceoperator= (Source &&o) noexcept
 Move assignment operator. More...
 
 ~Source ()
 Destructor. More...
 
bool isValid () const
 Whether the Source is valid or not. More...
 
 operator bool () const
 Whether the Source is valid or not. More...
 

Detailed Description

Generic opaque handle to a source (provenance).

This can be used to attach a source object to messages (Message) or other entities such that the source entity can be retrieved back if needed.

Definition at line 35 of file Source.h.

Constructor & Destructor Documentation

◆ Source() [1/3]

Amino::Source::Source ( )
noexcept

Default constructor (empty/invalid Source).

◆ Source() [2/3]

Amino::Source::Source ( Source const &  o)

Copy constructor.

◆ Source() [3/3]

Amino::Source::Source ( Source &&  o)
noexcept

Move constructor.

◆ ~Source()

Amino::Source::~Source ( )

Destructor.

Member Function Documentation

◆ isValid()

bool Amino::Source::isValid ( ) const

Whether the Source is valid or not.

◆ operator bool()

Amino::Source::operator bool ( ) const
inlineexplicit

Whether the Source is valid or not.

Definition at line 60 of file Source.h.

◆ operator=() [1/2]

Source & Amino::Source::operator= ( Source &&  o)
noexcept

Move assignment operator.

◆ operator=() [2/2]

Source & Amino::Source::operator= ( Source const &  o)

Copy assignment operator.