doc updates
This commit is contained in:
parent
472b6a1c39
commit
e219e64d28
|
|
@ -30,18 +30,18 @@
|
|||
namespace sACN {
|
||||
|
||||
/**
|
||||
* @brief ArbitratingUniverse::MergeProxyUniverse
|
||||
* @brief UniverseArbitrator::UniverseArbitrator
|
||||
*/
|
||||
UniverseArbitrator::UniverseArbitrator()
|
||||
: sACN::Universe()
|
||||
, expectedUniverse(0)
|
||||
, hold_last_look_(true)
|
||||
: sACN::Universe()
|
||||
, expectedUniverse(0)
|
||||
, hold_last_look_(true)
|
||||
{
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* @brief ArbitratingUniverse::setHoldLastLook
|
||||
* @brief UniverseArbitrator::setHoldLastLook
|
||||
* @param state
|
||||
*/
|
||||
void UniverseArbitrator::setHoldLastLook(const bool state)
|
||||
|
|
@ -52,7 +52,7 @@ void UniverseArbitrator::setHoldLastLook(const bool state)
|
|||
|
||||
|
||||
/**
|
||||
* @brief ArbitratingUniverse::getHoldLastLook
|
||||
* @brief UniverseArbitrator::getHoldLastLook
|
||||
* @return
|
||||
*/
|
||||
bool UniverseArbitrator::getHoldLastLook() const
|
||||
|
|
@ -62,6 +62,10 @@ bool UniverseArbitrator::getHoldLastLook() const
|
|||
}
|
||||
|
||||
|
||||
/**
|
||||
* @brief UniverseArbitrator::sources
|
||||
* @return
|
||||
*/
|
||||
const std::vector<DATA::data_header> UniverseArbitrator::sources() const
|
||||
{
|
||||
std::shared_lock lk_ctl(mtx_control);
|
||||
|
|
@ -73,7 +77,7 @@ const std::vector<DATA::data_header> UniverseArbitrator::sources() const
|
|||
|
||||
|
||||
/**
|
||||
* @brief ArbitratingUniverse::sourceUniverse
|
||||
* @brief UniverseArbitrator::sourceUniverse
|
||||
* @param src
|
||||
* @return
|
||||
*/
|
||||
|
|
@ -88,7 +92,7 @@ std::shared_ptr<Universe> UniverseArbitrator::sourceUniverse(const DATA::data_he
|
|||
|
||||
|
||||
/**
|
||||
* @brief ArbitratingUniverse::hasSourceUniverse
|
||||
* @brief UniverseArbitrator::hasSourceUniverse
|
||||
* @param src
|
||||
* @return
|
||||
*/
|
||||
|
|
@ -99,6 +103,11 @@ bool UniverseArbitrator::hasSourceUniverse(const DATA::data_header& src) const
|
|||
}
|
||||
|
||||
|
||||
/**
|
||||
* @brief UniverseArbitrator::addNewSource
|
||||
* @param src
|
||||
* @return
|
||||
*/
|
||||
std::shared_ptr<Universe> UniverseArbitrator::addNewSource(const DATA::data_header &src)
|
||||
{
|
||||
{
|
||||
|
|
@ -118,7 +127,7 @@ std::shared_ptr<Universe> UniverseArbitrator::addNewSource(const DATA::data_head
|
|||
|
||||
|
||||
/**
|
||||
* @brief ArbitratingUniverse::deleteSourceUniverse
|
||||
* @brief UniverseArbitrator::deleteSourceUniverse
|
||||
* @param src
|
||||
*/
|
||||
void UniverseArbitrator::deleteSourceUniverse(const DATA::data_header& src)
|
||||
|
|
@ -147,7 +156,7 @@ void UniverseArbitrator::deleteSourceUniverse(const DATA::data_header& src)
|
|||
|
||||
|
||||
/**
|
||||
* @brief ArbitratingUniverse::onSourceListChange
|
||||
* @brief UniverseArbitrator::onSourceListChange
|
||||
* @param cb
|
||||
* @return
|
||||
*/
|
||||
|
|
@ -164,7 +173,7 @@ std::shared_ptr<void> UniverseArbitrator::onSourceListChange(std::function<void(
|
|||
|
||||
|
||||
/**
|
||||
* @brief ArbitratingUniverse::doListChangeCallbacks
|
||||
* @brief UniverseArbitrator::doListChangeCallbacks
|
||||
*/
|
||||
void UniverseArbitrator::doListChangeCallbacks()
|
||||
{
|
||||
|
|
@ -185,7 +194,7 @@ void UniverseArbitrator::doListChangeCallbacks()
|
|||
|
||||
|
||||
/**
|
||||
* @brief ArbitratingUniverse::isSyncronized
|
||||
* @brief UniverseArbitrator::isSyncronized
|
||||
* @return
|
||||
*/
|
||||
bool UniverseArbitrator::isSyncronized() const
|
||||
|
|
@ -198,7 +207,7 @@ bool UniverseArbitrator::isSyncronized() const
|
|||
|
||||
|
||||
/**
|
||||
* @brief ArbitratingUniverse::metadata
|
||||
* @brief UniverseArbitrator::metadata
|
||||
* @return
|
||||
*/
|
||||
std::shared_ptr<DATA::data_header> UniverseArbitrator::metadata() const
|
||||
|
|
@ -215,6 +224,10 @@ std::shared_ptr<DATA::data_header> UniverseArbitrator::metadata() const
|
|||
}
|
||||
|
||||
|
||||
/**
|
||||
* @brief UniverseArbitrator::status
|
||||
* @return
|
||||
*/
|
||||
uint8_t UniverseArbitrator::status() const
|
||||
{
|
||||
auto universe = dominant_();
|
||||
|
|
@ -225,7 +238,7 @@ uint8_t UniverseArbitrator::status() const
|
|||
|
||||
|
||||
/**
|
||||
* @brief ArbitratingUniverse::synchronize
|
||||
* @brief UniverseArbitrator::synchronize
|
||||
* @param sequence_number
|
||||
*/
|
||||
void UniverseArbitrator::synchronize(uint8_t sequence_number)
|
||||
|
|
@ -236,12 +249,20 @@ void UniverseArbitrator::synchronize(uint8_t sequence_number)
|
|||
}
|
||||
|
||||
|
||||
/**
|
||||
* @brief UniverseArbitrator::isEditable
|
||||
* @return
|
||||
*/
|
||||
bool UniverseArbitrator::isEditable() const
|
||||
{
|
||||
return false;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* @brief UniverseArbitrator::activeSlots
|
||||
* @return
|
||||
*/
|
||||
uint16_t UniverseArbitrator::activeSlots() const
|
||||
{
|
||||
auto universe = dominant_();
|
||||
|
|
@ -252,7 +273,7 @@ uint16_t UniverseArbitrator::activeSlots() const
|
|||
|
||||
|
||||
/**
|
||||
* @brief ArbitratingUniverse::slot
|
||||
* @brief UniverseArbitrator::slot
|
||||
* @param address
|
||||
* @return
|
||||
*/
|
||||
|
|
@ -266,7 +287,7 @@ uint8_t UniverseArbitrator::slot(const uint16_t address) const
|
|||
|
||||
|
||||
/**
|
||||
* @brief ArbitratingUniverse::rxRate
|
||||
* @brief UniverseArbitrator::rxRate
|
||||
* @return
|
||||
*/
|
||||
double UniverseArbitrator::rxRate()
|
||||
|
|
@ -280,7 +301,7 @@ double UniverseArbitrator::rxRate()
|
|||
|
||||
|
||||
/**
|
||||
* @brief ArbitratingUniverse::rxDmpSetProperty
|
||||
* @brief UniverseArbitrator::rxDmpSetProperty
|
||||
* @param message
|
||||
*/
|
||||
void UniverseArbitrator::rxDmpSetProperty(ACN::PDU::Message<ACN::DMP::Pdu> message)
|
||||
|
|
|
|||
Loading…
Reference in New Issue