physical/symmetry/BaseData.h

Go to the documentation of this file.

/*
 * This file is a part of the Biology project by eons LLC.
 * Biology (aka Develop Biology) is a framework for approaching software
 * development from a natural sciences perspective.
 *
 * Copyright (C) 2026 Séon O'Shannon & eons LLC
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
 
#pragma once
 
#include "bio/common/Bytes.h"
#include "bio/common/macro/LanguageMacros.h"
#include "bio/common/string/String.h"
#include "bio/physical/common/SymmetryTypes.h"
#include "bio/physical/symmetry/Symmetry.h"
 
//@formatter:off
#if BIO_CPP_VERSION < 11
    #include <stdint.h>
#else
    #include <cstdint>
#endif
//@formatter:on
 
namespace bio {
namespace physical {
namespace base_data {
 
// --- Kind checks ---------------------------------------------------------
 
bool IsNull(const Symmetry& symmetry);
bool IsBool(const Symmetry& symmetry);
bool IsSignedInt(const Symmetry& symmetry);
bool IsUnsignedInt(const Symmetry& symmetry);
bool IsFloat32(const Symmetry& symmetry);
bool IsFloat64(const Symmetry& symmetry);
bool IsText(const Symmetry& symmetry);
bool IsBytes(const Symmetry& symmetry);
bool IsSimple(const Symmetry& symmetry);
 
bool IsBaseDataScalar(const Symmetry& symmetry);
 
// --- Setters -------------------------------------------------------------
 
void SetNull(Symmetry& symmetry);
 
void SetBool(Symmetry& symmetry, bool value);
void SetSignedInt(Symmetry& symmetry, int64_t value);
void SetUnsignedInt(Symmetry& symmetry, uint64_t value);
void SetFloat32(Symmetry& symmetry, float value);
void SetFloat64(Symmetry& symmetry, double value);
void SetText(Symmetry& symmetry, const String& value);
void SetBytes(Symmetry& symmetry, const Bytes& value);
void SetSimple(Symmetry& symmetry, uint8_t value);
 
// --- Getters -------------------------------------------------------------
 
bool TryGetBool(const Symmetry& symmetry, bool& out);
bool TryGetSignedInt(const Symmetry& symmetry, int64_t& out);
bool TryGetUnsignedInt(const Symmetry& symmetry, uint64_t& out);
bool TryGetFloat32(const Symmetry& symmetry, float& out);
bool TryGetFloat64(const Symmetry& symmetry, double& out);
bool TryGetText(const Symmetry& symmetry, String& out);
bool TryGetBytes(const Symmetry& symmetry, Bytes& out);
bool TryGetSimple(const Symmetry& symmetry, uint8_t& out);
 
} //base_data namespace
} //physical namespace
} //bio namespace