AAX_CStringDisplayDelegate.h

Go to the documentation of this file.

/*================================================================================================*/
/*
 *
 *  Copyright 2014-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_CSTRINGDISPLAYDELEGATE_H
#define AAX_CSTRINGDISPLAYDELEGATE_H
 
#include "AAX_IDisplayDelegate.h"
#include <sstream>
#include <map>
 
 
template <typename T>
class AAX_CStringDisplayDelegate : public AAX_IDisplayDelegate<T>
{
public:
    AAX_CStringDisplayDelegate(const std::map<T,AAX_CString>& stringMap);
    
    //Virtual Overrides
    AAX_CStringDisplayDelegate<T>*  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;
    
protected:
    std::map<T, AAX_CString>            mStringMap;
    std::map<AAX_CString, T>            mInverseStringMap;
};
 
 
 
template <typename T>
AAX_CStringDisplayDelegate<T>::AAX_CStringDisplayDelegate(const std::map<T,AAX_CString>& stringMap)  :
    AAX_IDisplayDelegate<T>(),
    mStringMap(stringMap),
    mInverseStringMap()
{
    //Construct an inverse string map from our already copied internal copy of the string map.
    //This inverse map is used for stringToValue conversion.
    typename std::map<T,AAX_CString>::iterator valueStringIterator = mStringMap.begin();
    while ( valueStringIterator != mStringMap.end() )
    {
        mInverseStringMap.insert(std::pair<AAX_CString, T>(valueStringIterator->second, valueStringIterator->first));
        valueStringIterator++;
    }
}
 
template <typename T>
AAX_CStringDisplayDelegate<T>*      AAX_CStringDisplayDelegate<T>::Clone() const
{
    return new AAX_CStringDisplayDelegate(*this);
}
 
template <typename T>
bool        AAX_CStringDisplayDelegate<T>::ValueToString(T value, AAX_CString* valueString) const
{
    typename std::map<T,AAX_CString>::const_iterator mapPairIterator = mStringMap.find(value);
    if( mapPairIterator != mStringMap.end() ) 
    {
        *valueString = mapPairIterator->second;
        return true;
    }
    *valueString = AAX_CString("String Not Found");
    return false;
}
 
template <typename T>
bool        AAX_CStringDisplayDelegate<T>::ValueToString(T value, int32_t /*maxNumChars*/, AAX_CString* valueString) const
{
    // First, get the full length string.
    bool result = this->ValueToString(value, valueString);
    
    //<DMT> TODO: Shorten the string based on the number of characters...  
    
    return result;
}
 
template <typename T>
bool        AAX_CStringDisplayDelegate<T>::StringToValue(const AAX_CString& valueString, T* value) const
{
    typename std::map<AAX_CString, T>::const_iterator mapPairIterator = mInverseStringMap.find(valueString);
    if( mapPairIterator != mInverseStringMap.end() ) 
    {
        *value = mapPairIterator->second;
        return true;
    }
    *value = 0;
    return false;
}
 
 
 
 
#endif //AAX_CSTRINGDISPLAYDELEGATE_H