Class GeneratedFile

Defined in File generated_file.hpp

Inheritance Relationships

Base Type

public std::enable_shared_from_this< GeneratedFile >

Derived Types

public moveit_setup::SRDFConfig::GeneratedSRDF (Class SRDFConfig::GeneratedSRDF)
public moveit_setup::TemplatedGeneratedFile (Class TemplatedGeneratedFile)
public moveit_setup::YamlGeneratedFile (Class YamlGeneratedFile)

Class Documentation

class GeneratedFile : public std::enable_shared_from_this<GeneratedFile>

Container for the logic for a single file to appear in MoveIt configuration package.

Subclassed by moveit_setup::SRDFConfig::GeneratedSRDF, moveit_setup::TemplatedGeneratedFile, moveit_setup::YamlGeneratedFile

Public Functions

GeneratedFile(const GeneratedFile&) = default

GeneratedFile(GeneratedFile&&) = default

virtual ~GeneratedFile() = default

inline GeneratedFile(const std::filesystem::path &package_path, const GeneratedTime &last_gen_time)

virtual std::filesystem::path getRelativePath() const = 0: Returns the path relative to the configuration package root.

virtual std::string getDescription() const = 0: Returns an English description of this file’s purpose.

virtual bool hasChanges() const = 0: Returns true if this file will have changes when it is written to file.

virtual bool write() = 0: Writes the file to disk.

inline std::filesystem::path getPath() const: Returns the fully qualified path to this file.

inline FileStatus getStatus() const

Protected Attributes

std::filesystem::path package_path_

const GeneratedTime &last_gen_time_

Protected Static Attributes

static constexpr GeneratedTime::duration TIME_MOD_TOLERANCE = std::chrono::seconds(10)