fsfw/datapoollocal/LocalPoolVariable.tpp

#ifndef FSFW_DATAPOOLLOCAL_LOCALPOOLVARIABLE_TPP_
#define FSFW_DATAPOOLLOCAL_LOCALPOOLVARIABLE_TPP_

#ifndef FSFW_DATAPOOLLOCAL_LOCALPOOLVARIABLE_H_
#error Include LocalPoolVariable.h before LocalPoolVariable.tpp!
#endif

template<typename T>
inline LocalPoolVariable<T>::LocalPoolVariable(HasLocalDataPoolIF* hkOwner,
		lp_id_t poolId, DataSetIF* dataSet, pool_rwm_t setReadWriteMode):
		LocalPoolObjectBase(poolId, hkOwner, dataSet, setReadWriteMode) {}

template<typename T>
inline LocalPoolVariable<T>::LocalPoolVariable(object_id_t poolOwner,
		lp_id_t poolId, DataSetIF *dataSet, pool_rwm_t setReadWriteMode):
        LocalPoolObjectBase(poolOwner, poolId, dataSet, setReadWriteMode) {}


template<typename T>
inline LocalPoolVariable<T>::LocalPoolVariable(gp_id_t globalPoolId,
		DataSetIF *dataSet, pool_rwm_t setReadWriteMode):
		LocalPoolObjectBase(globalPoolId.objectId, globalPoolId.localPoolId,
				dataSet, setReadWriteMode){}


template<typename T>
inline ReturnValue_t LocalPoolVariable<T>::read(
		MutexIF::TimeoutType timeoutType, uint32_t timeoutMs) {
	MutexHelper(hkManager->getMutexHandle(), timeoutType, timeoutMs);
	return readWithoutLock();
}

template<typename T>
inline ReturnValue_t LocalPoolVariable<T>::readWithoutLock() {
	if(readWriteMode == pool_rwm_t::VAR_WRITE) {
#if FSFW_CPP_OSTREAM_ENABLED == 1
		sif::warning << "LocalPoolVariable: Invalid read write "
				"mode for read call." << std::endl;
#else
		fsfw::printWarning("LocalPoolVariable: Invalid read write "
				"mode for read call.\n\r");
#endif  /* FSFW_CPP_OSTREAM_ENABLED == 1 */
		return PoolVariableIF::INVALID_READ_WRITE_MODE;
	}

	PoolEntry<T>* poolEntry = nullptr;
	ReturnValue_t result = hkManager->fetchPoolEntry(localPoolId, &poolEntry);
	if(result != RETURN_OK or poolEntry == nullptr) {
		object_id_t ownerObjectId = hkManager->getOwner()->getObjectId();
		reportReadCommitError(true, ownerObjectId, localPoolId);
		return result;
	}

	if(poolEntry->address == nullptr) {
		object_id_t ownerObjectId = hkManager->getOwner()->getObjectId();
		reportReadCommitError(true, ownerObjectId, localPoolId);
		return PoolVariableIF::INVALID_POOL_ENTRY;
	}

	this->value = *(poolEntry->address);
	this->valid = poolEntry->valid;
	return RETURN_OK;
}

template<typename T>
inline ReturnValue_t LocalPoolVariable<T>::commit(bool setValid,
		MutexIF::TimeoutType timeoutType, uint32_t timeoutMs) {
	this->setValid(setValid);
	return commit(timeoutType, timeoutMs);
}

template<typename T>
inline ReturnValue_t LocalPoolVariable<T>::commit(
		MutexIF::TimeoutType timeoutType, uint32_t timeoutMs) {
	MutexHelper(hkManager->getMutexHandle(), timeoutType, timeoutMs);
	return commitWithoutLock();
}

template<typename T>
inline ReturnValue_t LocalPoolVariable<T>::commitWithoutLock() {
	if(readWriteMode == pool_rwm_t::VAR_READ) {
#if FSFW_CPP_OSTREAM_ENABLED == 1
		sif::warning << "LocalPoolVariable: Invalid read write "
				 "mode for commit call." << std::endl;
#else
		fsfw::printWarning("LocalPoolVariable: Invalid read write "
				 "mode for commit call.\n\r");
#endif  /* FSFW_CPP_OSTREAM_ENABLED == 1 */
		return PoolVariableIF::INVALID_READ_WRITE_MODE;
	}
	PoolEntry<T>* poolEntry = nullptr;
	ReturnValue_t result = hkManager->fetchPoolEntry(localPoolId, &poolEntry);
	if(result != RETURN_OK or poolEntry == nullptr) {
		object_id_t ownerObjectId = hkManager->getOwner()->getObjectId();
		reportReadCommitError(false, ownerObjectId, localPoolId);
		return result;
	}

	*(poolEntry->address) = this->value;
	poolEntry->valid = this->valid;
	return RETURN_OK;
}

template<typename T>
inline ReturnValue_t LocalPoolVariable<T>::serialize(uint8_t** buffer,
		size_t* size, const size_t max_size,
		SerializeIF::Endianness streamEndianness) const {
	return SerializeAdapter::serialize(&value,
			buffer, size ,max_size, streamEndianness);
}

template<typename T>
inline size_t LocalPoolVariable<T>::getSerializedSize() const {
	return SerializeAdapter::getSerializedSize(&value);
}

template<typename T>
inline ReturnValue_t LocalPoolVariable<T>::deSerialize(const uint8_t** buffer,
		size_t* size, SerializeIF::Endianness streamEndianness) {
	return SerializeAdapter::deSerialize(&value, buffer, size, streamEndianness);
}

#if FSFW_CPP_OSTREAM_ENABLED == 1
template<typename T>
inline std::ostream& operator<< (std::ostream &out,
		const LocalPoolVariable<T> &var) {
    out << var.value;
    return out;
}
#endif

template<typename T>
inline LocalPoolVariable<T>::operator T() const {
	return value;
}

template<typename T>
inline LocalPoolVariable<T> & LocalPoolVariable<T>::operator=(
		const T& newValue) {
    value = newValue;
    return *this;
}

template<typename T>
inline LocalPoolVariable<T>& LocalPoolVariable<T>::operator =(
		const LocalPoolVariable<T>& newPoolVariable) {
	value = newPoolVariable.value;
	return *this;
}

template<typename T>
inline bool LocalPoolVariable<T>::operator ==(
		const LocalPoolVariable<T> &other) const {
	return this->value == other.value;
}

template<typename T>
inline bool LocalPoolVariable<T>::operator ==(const T &other) const {
	return this->value == other;
}


template<typename T>
inline bool LocalPoolVariable<T>::operator !=(
		const LocalPoolVariable<T> &other) const {
	return not (*this == other);
}

template<typename T>
inline bool LocalPoolVariable<T>::operator !=(const T &other) const {
	return not (*this == other);
}


template<typename T>
inline bool LocalPoolVariable<T>::operator <(
		const LocalPoolVariable<T> &other) const {
	return this->value < other.value;
}

template<typename T>
inline bool LocalPoolVariable<T>::operator <(const T &other) const {
	return this->value < other;
}


template<typename T>
inline bool LocalPoolVariable<T>::operator >(
		const LocalPoolVariable<T> &other) const {
	return not (*this < other);
}

template<typename T>
inline bool LocalPoolVariable<T>::operator >(const T &other) const {
	return not (*this < other);
}

template<typename T>
inline void LocalPoolVariable<T>::reportReadCommitError(bool read,
		object_id_t objectId, lp_id_t lpId) {
	const char* type = nullptr;
	if(read) {
		type = "read";
	}
	else {
		type = "commit";
	}

#if FSFW_CPP_OSTREAM_ENABLED == 1
	sif::warning << "PoolPoolVariable: " << type << " of local pool "
			<<"variable of object " << std::hex << std::setw(8)
			<< std::setfill('0') << objectId << " and lp ID 0x" << lpId
			<< std::dec << " failed." << std::endl;
#else
	fsfw::printWarning("LocalPoolVariable: %s of local pool variable of "
			"object 0x%08x and lp ID 0x%08x failed.\n\r",
			type, objectId, lpId);
#endif /* FSFW_CPP_OSTREAM_ENABLED == 1 */
}


#endif /* FSFW_DATAPOOLLOCAL_LOCALPOOLVARIABLE_TPP_ */