AAX_CNumberDisplayDelegate.h

Go to the documentation of this file.

/*================================================================================================*/
/*
 *
 *  Copyright 2013-2017, 2019, 2023-2024 Avid Technology, Inc.
 *  All rights reserved.
 *  
 *  This file is part of the Avid AAX SDK.
 *  
 *  The AAX SDK is subject to commercial or open-source licensing.
 *  
 *  By using the AAX SDK, you agree to the terms of both the Avid AAX SDK License
 *  Agreement and Avid Privacy Policy.
 *  
 *  AAX SDK License: https://developer.avid.com/aax
 *  Privacy Policy: https://www.avid.com/legal/privacy-policy-statement
 *  
 *  Or: You may also use this code under the terms of the GPL v3 (see
 *  www.gnu.org/licenses).
 *  
 *  THE AAX SDK IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES, WHETHER
 *  EXPRESSED OR IMPLIED, INCLUDING MERCHANTABILITY AND FITNESS FOR PURPOSE, ARE
 *  DISCLAIMED.
 *
 */
 
/*================================================================================================*/
 
 
#ifndef AAX_CNUMBERDISPLAYDELEGATE_H
#define AAX_CNUMBERDISPLAYDELEGATE_H
 
#include "AAX_IDisplayDelegate.h"
#include "AAX_CString.h"
 
 
template <typename T, uint32_t Precision=2, uint32_t SpaceAfter=0>
class AAX_CNumberDisplayDelegate : public AAX_IDisplayDelegate<T>
{
public:
    //Virtual Overrides
    AAX_CNumberDisplayDelegate* Clone() const AAX_OVERRIDE;
    bool        ValueToString(T value, AAX_CString* valueString) const AAX_OVERRIDE;
    bool        ValueToString(T value, int32_t maxNumChars, AAX_CString* valueString) const AAX_OVERRIDE;
    bool        StringToValue(const AAX_CString& valueString, T* value) const AAX_OVERRIDE;
};
 
 
 
 
template <typename T, uint32_t Precision, uint32_t SpaceAfter>
AAX_CNumberDisplayDelegate<T,Precision,SpaceAfter>*     AAX_CNumberDisplayDelegate<T,Precision,SpaceAfter>::Clone() const
{
    return new AAX_CNumberDisplayDelegate(*this);
}
 
template <typename T, uint32_t Precision, uint32_t SpaceAfter>
bool    AAX_CNumberDisplayDelegate<T,Precision,SpaceAfter>::ValueToString(T value, AAX_CString* valueString) const
{
    valueString->Clear();
    valueString->AppendNumber(value, Precision);
    if (SpaceAfter != 0)
        valueString->Append(" ");       //Added a space after the number for easier display of units.
    return true;
}
 
template <typename T, uint32_t Precision, uint32_t SpaceAfter>
bool    AAX_CNumberDisplayDelegate<T,Precision,SpaceAfter>::ValueToString(T value, int32_t maxNumChars, AAX_CString* valueString) const
{
    valueString->Clear();
    valueString->AppendNumber(value, Precision);
    uint32_t strlen = valueString->Length();
    const uint32_t maxNumCharsUnsigned = (0 <= maxNumChars) ? static_cast<uint32_t>(maxNumChars) : 0;
    if (strlen > maxNumCharsUnsigned)
    {
        valueString->Erase(maxNumCharsUnsigned, strlen-maxNumCharsUnsigned);
        strlen = valueString->Length();
    }
    
    if ( 0 < maxNumCharsUnsigned && strlen == maxNumCharsUnsigned && (*valueString)[maxNumCharsUnsigned-1] == '.')  //<DMT> Edge case when the decimal point is the last character, we probably shouldn't show it.
    {
        valueString->Erase(maxNumCharsUnsigned-1, 1);
        strlen = valueString->Length();
    }
 
    if ((SpaceAfter != 0) && (maxNumCharsUnsigned > strlen) && (maxNumCharsUnsigned-strlen > 2))            //<DMT> Kind of a random threshold for dropping the space after, but seems reasonable for our control surfaces.  (allows dB and Unit prefixes)
        valueString->Append(" ");       //Added a space after the number for easier display of units.
    return true;
}
 
template <typename T, uint32_t Precision, uint32_t SpaceAfter>
bool    AAX_CNumberDisplayDelegate<T,Precision,SpaceAfter>::StringToValue(const AAX_CString& valueString, T* value) const
{
    double dValue;
    if (valueString.ToDouble(&dValue))
    {
        *value = static_cast<T> (dValue);
        return true;    
    }
    *value = 0;
    return false;
}
 
 
 
 
#endif //AAX_CNUMBERDISPLAYDELEGATE_H