Ios3_PropertySerialization.h

Go to the documentation of this file.

// Copyright(C) 2025 National Technology & Engineering Solutions
// of Sandia, LLC (NTESS). Under the terms of Contract DE-NA0003525 with
// NTESS, the U.S. Government retains certain rights in this software.
//
// See packages/seacas/LICENSE for details
 
#pragma once
 
#include "ios3_export.h"
 
#include "Ios3_Utils.h"
#include "Ioss_Field.h"
#include "Ioss_GroupingEntity.h"
#include "Ioss_Property.h"
 
#include <string>
#include <vector>
 
namespace Ios3 {
 
  IOS3_EXPORT size_t data_size(const Ioss::Property &p);
 
  // Caller should write their own version of this PropertyFunction
  // should return a function or a lamba that matches the signature
  // below. The function it returns may or may not capture variables
  // that are given to the user-defined function.  Some examples are
  // given in this file and are also useful
  //
  using PropertyFunction = std::function<int(const Ioss::Region &, const Ioss::GroupingEntity &,
                                             const Ioss::Property &)>;
 
  using PackedBytes = std::vector<unsigned char>;
 
  // Applies PropertyFunction 'op' to all properties encountered in
  // the Ioss::Region and it's various Ioss::GroupingEntities
  //
  IOS3_EXPORT int map_properties(const Ioss::Region &region, PropertyFunction op);
 
  // Applies PropertyFunction 'op' to all properties encountered in
  // the Ioss::GroupingEntity
  //
  IOS3_EXPORT int map_properties(const Ioss::Region         &region,
                                 const Ioss::GroupingEntity &grouping_entity, PropertyFunction op);
 
  IOS3_EXPORT PackedBytes pack_property(const Ioss::Region         &region,
                                        const Ioss::GroupingEntity &entity,
                                        const Ioss::Property       &property);
 
  struct IOS3_EXPORT property_entry_t
  {
    Ioss::Property::BasicType basic_type;
    bool                      is_implicit{false};
    bool                      is_valid{false};
    value_entry_t             name;  // offset from data[0]
    value_entry_t             value; // offset from data[0]
 
    size_t data_size{0}; // Total size of data stored in data[0] ptr
 
    char data[0];
 
    explicit property_entry_t(const Ioss::Property &property, const size_t start = 0);
  };
 
  IOS3_EXPORT int64_t property_get_int(PackedBytes &p);
  IOS3_EXPORT std::string property_get_string(PackedBytes &p);
 
} // namespace Ios3