pathSegment.h

Go to the documentation of this file.

#line 1 "S:/jenkins/workspace/ECP/ufe/ufe-full-python3.10-windows/ufe/include/pathSegment.h"
#ifndef _ufePathSegment
#define _ufePathSegment
// ===========================================================================
// Copyright 2018 Autodesk, Inc. All rights reserved.
//
// Use of this software is subject to the terms of the Autodesk license
// agreement provided at the time of installation or download, or which
// otherwise accompanies this software in either electronic or hard copy form.
// ===========================================================================


#include "rtid.h"
#include "pathComponent.h"

#include <string>
#include <vector>

UFE_NS_DEF {
    class Path;

class UFE_SDK_DECL PathSegment
{
public:

    typedef std::vector<PathComponent> Components;

    PathSegment(
        const std::string& segment,
        Rtid               runTimeId,
        char               separator
    );

    PathSegment(
        const Components& components,
        Rtid              runTimeId,
        char              separator
    );

    PathSegment(
        Components&& components,
        Rtid              runTimeId,
        char              separator
    ) noexcept; 

    PathSegment(
        const PathComponent& component,
        Rtid                 runTimeId,
        char                 separator
    );

    PathSegment(const PathSegment&) = default;

    PathSegment& operator=(const PathSegment&) = default;

    PathSegment(PathSegment&&) noexcept;

    PathSegment& operator=(PathSegment&& rhs) noexcept;

    Rtid runTimeId() const;

    char separator() const;

    const Components& components() const;

    PathSegment pop() const;

    PathSegment popHead() const;

    PathSegment head(int nbComponents) const;

    bool operator==(const PathSegment& rhs) const;
    bool operator!=(const PathSegment& rhs) const;

    // Container of components interface.
    Components::size_type      size() const;
    bool                       empty() const;
    
    Components::const_iterator cbegin() const;
    Components::const_iterator begin() const;
    Components::const_iterator cend() const;
    Components::const_iterator end() const;
    Components::iterator       begin();
    Components::iterator       end();

    std::string string() const;

private:
    friend Path;
    Components fComponents;
    Rtid       fRunTimeId;
    char       fSeparator;
};

}

#endif /* _ufePathSegment */