ms_customproperty.hpp

/*
##############################################################################
# file: ms_customproperty.hpp                                                #
# 'msparser' toolkit                                                         #
# Represents a custom property with unknown structure. It is useful for new  # 
# properties or for properties with variable structure that can be explored  #
# at run-time                                                                #
##############################################################################
# COPYRIGHT NOTICE                                                           #
# Copyright 1998-2003 Matrix Science Limited  All Rights Reserved.           #
#                                                                            #
##############################################################################
#    $Archive:: /Mowse/ms_mascotresfile/include/ms_customproperty.hpp      $ #
#     $Author: villek@matrixscience.com $ #
#       $Date: 2018-07-30 16:23:53 +0100 $ #
#   $Revision: 1b450440f9c97e1e41d0fc6016a27d68951d4532 | MSPARSER_REL_2_8_1-0-gea32989045 $ #
# $NoKeywords::                                                            $ #
##############################################################################
*/

#ifndef MS_CUSTOMPROPERTY_HPP
#define MS_CUSTOMPROPERTY_HPP


#include <string>
#include <vector>

#include "msparser_lim.hpp"

namespace matrix_science {


    class MS_MASCOTRESFILE_API ms_customproperty
    {
    public:
        ms_customproperty();

        ~ms_customproperty();

        void defaultValues();

        void copyFrom(const ms_customproperty* src);

        int getNumberOfProperties() const;

        std::string getPropertyName(const int index) const;

        void setPropertyName(const int index, const char* name);

        int findProperty(const char* name, const int startFrom = 0) const;

        int findPropertyBeginning(const char* nameBeginning, const int startFrom = 0) const;

        std::string getPropValStringByName(const char* name) const;

        std::string getPropValStringByNumber(const int index) const;

        std::string getDelimiterByNumber(const int index) const;

        void appendProperty
            ( const char* name
            , const char* value 
            , const char* delimiter
            , const bool bFirstPlace = false
            );

        void appendText
            ( const char* line
            , const bool bFirstPlace = false
            );

        void setPropValStringByName
            ( const char* name
            , const char* value
            , const bool bFirstPlace = false
            );

        void setPropValCharByName
            ( const char* name
            , const char value
            , const bool bFirstPlace = false
            );

        void setPropValIntByName
            ( const char* name
            , const int value
            , const bool bFirstPlace = false
            );

        void setPropValInt64ByName
            ( const char* name
            , const INT64 value
            , const bool bFirstPlace = false
            );

        void setPropValBoolByName
            ( const char* name
            , const bool value
            , const bool bFirstPlace = false
            );

        void setPropValFloatByName
            ( const char* name
            , const double value
            , const bool bFirstPlace = false
            );

        void setPropValStringByNumber
            ( const int index
            , const char* value
            );


        std::string getDefaultDelimiter() const;

        void setDefaultDelimiter(const char* delim);

        void delProp(const char* name);

        void delPropStart(const char* nameBeginning);

        void delNonEmpty();

        void delPropByNumber(const int index);

        bool uncommentProp(const int index, const char * delimeter = 0);

        std::string getPreceedingComments() const;

        void setPreceedingComments(const std::string & comments);

    private:
        std::vector< std::string > names_;
        std::vector< std::string > values_;
        std::vector< std::string > delimiters_;
        std::string                defaultDelimiter_;
        std::string                preceedingComments_;
    }; // class ms_customproperty
} // namespace matrix_science

#endif // MS_CUSTOMPROPERTY_HPP

/*------------------------------- End of File -------------------------------*/