component_output_subfield.h

Go to the documentation of this file.

#pragma once
 
#include <liboscar/utilities/c_string_view.h>
#include <liboscar/utilities/flags.h>
 
#include <cstdint>
#include <optional>
#include <span>
 
namespace OpenSim { class AbstractOutput; }
namespace SimTK { class State; }
 
namespace opyn
{
    // flag type that can be used to say what subfields an OpenSim output has
    enum class ComponentOutputSubfield : uint32_t {
        None       = 0,
        X          = 1<<0,
        Y          = 1<<1,
        Z          = 1<<2,
        Magnitude  = 1<<3,
        RX         = 1<<4,
        RY         = 1<<5,
        RZ         = 1<<6,
        RMagnitude = 1<<7,
        NUM_FLAGS  =    8,
 
        Default = None,
    };
    using ComponentOutputSubfields = osc::Flags<ComponentOutputSubfield>;
 
    std::optional<osc::CStringView> GetOutputSubfieldLabel(ComponentOutputSubfield);
    std::span<const ComponentOutputSubfield> GetAllSupportedOutputSubfields();
 
    // tests if the output produces numeric values (e.g. `float`, `Vector3`, etc. - as opposed to `std::string`)
    bool ProducesExtractableNumericValues(const OpenSim::AbstractOutput&);
 
    // returns `ComponentOutputSubfield`s that are usable with the given output.
    ComponentOutputSubfields GetSupportedSubfields(const OpenSim::AbstractOutput&);
 
    using SubfieldExtractorFunc = double(*)(const OpenSim::AbstractOutput&, const SimTK::State&);
    SubfieldExtractorFunc GetExtractorFuncOrNull(const OpenSim::AbstractOutput&, ComponentOutputSubfield);
}