HCF.h

Go to the documentation of this file.

#pragma once

#include "swCommonLib/Common/TypesDefinitions.h"
#include "swCommonLib/System/Path.h"

#include "swCommonLib/HierarchicalChunkedFormat/Attributes/IAttribute.h"
#include "swCommonLib/HierarchicalChunkedFormat/Internal/ImplHCF.h"

#include "Chunk.h"
#include "Attribute.h"

#include <string>


namespace sw
{

class ImplHCF;


class HCF
{
    FRIEND_CLASS_TESTER( HCF );
public:

    enum WriteMode : uint8
    {
        DirectToFile,
        Indirect
    };

    const static bool       READ_ONLY               = true;
    const static bool       READ_WRITE              = false;
    const static Size       UserDefinedAttributes   = 0xFFFFFFFFFFFF0000;

private:
    ImplHCF         m_impl;

protected:
public:
    explicit        HCF         ();
                    ~HCF        () = default;

    bool            LoadFile        ( const filesystem::Path& filePath, bool readOnly );
    bool            Load            ( DataPtr data, Size size );

    bool            WriteFile       ( const filesystem::Path& filePath );

    bool            OpenFile        ( const filesystem::Path& filePath, WriteMode mode );

    Chunk           GetRootChunk    ();
    Chunk           CreateRootChunk ();


    Attribute       AddAttribute    ( AttributeType type, const DataPtr data, Size dataSize );

    template< typename AttributeStruct >
    Attribute       AddAttribute    ( AttributeType type, const AttributeStruct& content );

    template< typename AttributeStruct >
    Attribute       AddAttribute    ( const AttributeStruct& content );

};



}   // sw

template< typename AttributeStruct >
sw::AttributeType       GetAttributeTypeID      ();


#include "HCF.inl"