pathComponent.h

Go to the documentation of this file.

#line 1 "D:/Jenkins/workspace/EMS/ECG/ufe/full/ufe-full-python3.13-windows/ufe/include/pathComponent.h"
#ifndef UFE_PATHCOMPONENT_H
#define UFE_PATHCOMPONENT_H
 
// ===========================================================================
// Copyright 2025 Autodesk, Inc. All rights reserved.
//
// The use of this software is subject to the Autodesk Terms of Use or other
// license agreement provided at the time of installation or download, or
// which otherwise accompanies this software.
// ===========================================================================
 
#include "common/ufeExport.h"
#include <string>
#include <memory>
#include <vector>
#include <cstdint>
 
UFE_NS_DEF {
 
class UFE_SDK_DECL PathComponent {
public:
    class Data;
 
    static bool exists(const std::string& aString);
 
    static std::vector<PathComponent> toComponents(const std::vector<std::string>& strings);
 
    static std::size_t tableSize();
 
    PathComponent(const std::string& aString);
 
    PathComponent();
 
    ~PathComponent();
 
    operator bool() const;
 
    PathComponent(const PathComponent&) = default;
    PathComponent& operator=(const PathComponent&);
 
    bool operator==(const PathComponent& rhs) const;
    bool operator!=(const PathComponent& rhs) const;
 
    const std::string& string() const;
    std::int64_t id() const;
 
private:
    void releaseSharedData();
 
    std::shared_ptr<Data> fData;
};
 
}
 
// Hashing support.
namespace std {
template<> struct hash<Ufe::PathComponent> {
    std::size_t operator()(const Ufe::PathComponent& c) const {
        // Use the ID as the hash value. If the PathComponent is empty, id() returns -1,
        // which the static_cast to size_t will turn into the largeset positive value that
        // size_t can hold. Which is fine for a hash value since you would probably never
        // have an empty PathComponent in a hash table.
        return static_cast<std::size_t>(c.id());
    }
};
}
 
#endif /* UFE_PATHCOMPONENT_H */