PBProperties Class Reference

#include <PBProperties.h>

Classes
class	PBProperty

Public Member Functions
	PBProperties ()
	PBProperties (const PBProperties &other)
	PBProperties (PBProperties &&other) noexcept
	~PBProperties ()
PBProperty *	Begin ()
PBProperty *	End ()
const PBProperty *	Begin () const
const PBProperty *	End () const
const PBProperty *	GetPropertyByIndex (TSIZE a_iIndex) const
const PBPropertyValue *	GetPropertyValue (TSIZE a_iIndex) const
const PBPropertyValue *	GetProperty (const TCHAR *a_szName) const
template<typename T>
TBOOL	GetOptionalPropertyValue (T &a_rOutValue, const TCHAR *a_szName) const
const PBProperties *	GetParentProperties () const
TUINT32	GetPropertyCount () const
PBProperty *	AddProperty (const Toshi::TString8 &a_Name, TINT a_iValue)
PBProperty *	AddProperty (const Toshi::TString8 &a_Name, PBPropertyLocaleString a_strLocaleString)
PBProperty *	AddPropertyBool (const Toshi::TString8 &a_Name, TBOOL a_bValue)
PBProperty *	AddProperty (const Toshi::TString8 &a_Name, TFLOAT a_fValue)
PBProperty *	AddProperty (const Toshi::TString8 &a_Name, TUINT32 a_uiValue)
PBProperty *	AddProperty (const Toshi::TString8 &a_Name, const Toshi::TString8 &a_sValue)
PBProperty *	AddProperties (const Toshi::TString8 &a_Name)
PBProperty *	AddPropertyArray (const Toshi::TString8 &a_Name)

Static Public Attributes
static constexpr const TCHAR *	TRB_SECTION_NAME = "Main"

Friends
class	PPropertiesWriter

Detailed Description

Definition at line 660 of file PBProperties.h.

Constructor & Destructor Documentation

PBProperties() [1/3]

PBProperties::PBProperties ( )

inline

Definition at line 804 of file PBProperties.h.

    {
        m_pParent     = TNULL;
        m_pProperties = TNULL;
        m_iCount      = 0;
    }

PBProperties() [2/3]

PBProperties::PBProperties ( const PBProperties & other )

inline

Definition at line 811 of file PBProperties.h.

    {
        m_pParent = other.m_pParent;
 
        if ( other.m_pProperties != TNULL )
        {
            m_pProperties = new PBProperty[ other.m_iCount ];
 
            for ( TSIZE i = 0; i < other.m_iCount; i++ )
            {
                m_pProperties[ i ] = other.m_pProperties[ i ];
                auto pValue        = m_pProperties[ i ].GetValue();
 
                if ( pValue->GetType() == PBPropertyValue::Type::Properties )
                {
                    pValue->GetProperties()->m_pParent = this;
                }
            }
        }
        else
        {
            m_pProperties = other.m_pProperties;
        }
 
        m_iCount = other.m_iCount;
    }

PBProperties() [3/3]

PBProperties::PBProperties ( PBProperties && other )

inlinenoexcept

Definition at line 838 of file PBProperties.h.

    {
        m_pParent           = other.m_pParent;
        m_pProperties       = other.m_pProperties;
        m_iCount            = other.m_iCount;
        other.m_pParent     = TNULL;
        other.m_pProperties = TNULL;
        other.m_iCount      = 0;
    }

~PBProperties()

PBProperties::~PBProperties ( )

inline

Definition at line 848 of file PBProperties.h.

    {
        Delete();
    }

Member Function Documentation

AddProperties()

PBProperty * PBProperties::AddProperties ( const Toshi::TString8 & a_Name )

inline

Definition at line 966 of file PBProperties.h.

    {
        PBProperties* pProperties = new PBProperties;
        pProperties->m_pParent    = this;
 
        return AllocProperty( PBProperty( a_Name, pProperties ) );
    }

AddProperty() [1/5]

PBProperty * PBProperties::AddProperty ( const Toshi::TString8 & a_Name, const Toshi::TString8 & a_sValue )

inline

Definition at line 961 of file PBProperties.h.

    {
        return AllocProperty( PBProperty( a_Name, a_sValue ) );
    }

AddProperty() [2/5]

PBProperty * PBProperties::AddProperty ( const Toshi::TString8 & a_Name, PBPropertyLocaleString a_strLocaleString )

inline

Definition at line 941 of file PBProperties.h.

    {
        return AllocProperty( PBProperty( a_Name, a_strLocaleString ) );
    }

AddProperty() [3/5]

PBProperty * PBProperties::AddProperty ( const Toshi::TString8 & a_Name, TFLOAT a_fValue )

inline

Definition at line 951 of file PBProperties.h.

    {
        return AllocProperty( PBProperty( a_Name, a_fValue ) );
    }

AddProperty() [4/5]

PBProperty * PBProperties::AddProperty ( const Toshi::TString8 & a_Name, TINT a_iValue )

inline

Definition at line 936 of file PBProperties.h.

    {
        return AllocProperty( PBProperty( a_Name, a_iValue ) );
    }

AddProperty() [5/5]

PBProperty * PBProperties::AddProperty ( const Toshi::TString8 & a_Name, TUINT32 a_uiValue )

inline

Definition at line 956 of file PBProperties.h.

    {
        return AllocProperty( PBProperty( a_Name, a_uiValue ) );
    }

AddPropertyArray()

PBProperty * PBProperties::AddPropertyArray ( const Toshi::TString8 & a_Name )

inline

Definition at line 974 of file PBProperties.h.

    {
        PBPropertyValueArray* pArray = new PBPropertyValueArray;
 
        return AllocProperty( PBProperty( a_Name, pArray ) );
    }

AddPropertyBool()

PBProperty * PBProperties::AddPropertyBool ( const Toshi::TString8 & a_Name, TBOOL a_bValue )

inline

Definition at line 946 of file PBProperties.h.

    {
        return AllocProperty( PBProperty( a_Name, a_bValue ) );
    }

Begin() [1/2]

PBProperty * PBProperties::Begin ( )

inline

Definition at line 853 of file PBProperties.h.

    {
        return m_pProperties;
    }

Begin() [2/2]

const PBProperty * PBProperties::Begin ( ) const

inline

Definition at line 863 of file PBProperties.h.

    {
        return m_pProperties;
    }

End() [1/2]

PBProperty * PBProperties::End ( )

inline

Definition at line 858 of file PBProperties.h.

    {
        return m_pProperties + m_iCount;
    }

End() [2/2]

const PBProperty * PBProperties::End ( ) const

inline

Definition at line 868 of file PBProperties.h.

    {
        return m_pProperties + m_iCount;
    }

GetOptionalPropertyValue()

template<typename T>

TBOOL PBProperties::GetOptionalPropertyValue ( T & a_rOutValue, const TCHAR * a_szName ) const

inline

Definition at line 898 of file PBProperties.h.

    {
        const PBPropertyValue* pFoundProperty = GetProperty( a_szName );
 
        if ( pFoundProperty && pFoundProperty->GetType() == PBPropertiesTypeCast<T>::type )
        {
            if constexpr ( PBPropertiesTypeCast<T>::type == PBPropertyValue::Type::Float )
                a_rOutValue = pFoundProperty->GetFloat();
            else if constexpr ( PBPropertiesTypeCast<T>::type == PBPropertyValue::Type::Int )
                a_rOutValue = pFoundProperty->GetInteger();
            else if constexpr ( PBPropertiesTypeCast<T>::type == PBPropertyValue::Type::Bool )
                a_rOutValue = pFoundProperty->GetBoolean();
            else if constexpr ( PBPropertiesTypeCast<T>::type == PBPropertyValue::Type::UInt32 )
                a_rOutValue = pFoundProperty->GetUINT32();
            else if constexpr ( PBPropertiesTypeCast<T>::type == PBPropertyValue::Type::String )
                a_rOutValue = pFoundProperty->GetString();
            else
            {
                void* rawValue = pFoundProperty->GetRaw();
                a_rOutValue    = *(T*)( &rawValue );
            }
 
            return TTRUE;
        }
 
        return TFALSE;
    }

GetParentProperties()

const PBProperties * PBProperties::GetParentProperties ( ) const

inline

Definition at line 926 of file PBProperties.h.

    {
        return m_pParent;
    }

GetProperty()

const PBPropertyValue * PBProperties::GetProperty ( const TCHAR * a_szName ) const

inline

Definition at line 884 of file PBProperties.h.

    {
        for ( TSIZE i = 0; i < m_iCount; i++ )
        {
            if ( m_pProperties[ i ].GetName() == a_szName )
            {
                return m_pProperties[ i ].GetValue();
            }
        }
 
        return TNULL;
    }

GetPropertyByIndex()

const PBProperty * PBProperties::GetPropertyByIndex ( TSIZE a_iIndex ) const

inline

Definition at line 873 of file PBProperties.h.

    {
        TASSERT( m_iCount > a_iIndex );
        return &m_pProperties[ a_iIndex ];
    }

GetPropertyCount()

TUINT32 PBProperties::GetPropertyCount ( ) const

inline

Definition at line 931 of file PBProperties.h.

    {
        return m_iCount;
    }

GetPropertyValue()

const PBPropertyValue * PBProperties::GetPropertyValue ( TSIZE a_iIndex ) const

inline

Definition at line 879 of file PBProperties.h.

    {
        return GetPropertyByIndex( a_iIndex )->GetValue();
    }

Friends And Related Symbol Documentation

PPropertiesWriter

friend class PPropertiesWriter

friend

Definition at line 799 of file PBProperties.h.

Member Data Documentation

TRB_SECTION_NAME

const TCHAR* PBProperties::TRB_SECTION_NAME = "Main"

staticconstexpr

Definition at line 801 of file PBProperties.h.

---

The documentation for this class was generated from the following file:

• D:/_dev/OpenBarnyard/Source/Toshi/Source/Plugins/PPropertyParser/PBProperties.h