VPTissue Reference Manual
SimPT_Sim::Util::PTreeFile Class Reference

Utility interface for dealing with ptree xml or xml.gz files. More...

#include <PTreeFile.h>

Collaboration diagram for SimPT_Sim::Util::PTreeFile:
Collaboration graph

Static Public Member Functions

static void Compress (const std::string &in_path, const std::string &out_path)
 
static void Decompress (const std::string &in_path, const std::string &out_path)
 
static std::string GetBaseNameExcludingLabel (const std::string &path)
 Base name excluding label (label encodes time step = chars from last "_" to first "." ).
 
static std::string GetBaseNameIncludingLabel (const std::string &path)
 Base name including label (label encodes time step = chars from last "_" to first "." ).
 
static std::string GetCompleteSuffix (const std::string &path)
 Return complete suffix (everything following the first ".").
 
static std::string GetLabel (const std::string &path)
 
static constexpr bool IsBoostGzipAvailable ()
 Signal availability of boost iostreams with gzip capability.
 
static bool IsGzipped (const std::string &path)
 
static bool IsPTreeFile (const std::string &path)
 Indicates whether the file has the appropriate extension.
 
static void Read (const std::string &path, boost::property_tree::ptree &pt)
 
static void ReadXml (const std::string &path, boost::property_tree::ptree &pt)
 
static void ReadXmlGz (const std::string &path, boost::property_tree::ptree &pt)
 
static void Write (const std::string &path, const boost::property_tree::ptree &pt)
 
static void WriteXml (const std::string &path, const boost::property_tree::ptree &pt)
 
static void WriteXmlGz (const std::string &path, const boost::property_tree::ptree &pt)
 

Detailed Description

Utility interface for dealing with ptree xml or xml.gz files.

Definition at line 32 of file PTreeFile.h.


The documentation for this class was generated from the following files: