AAX_CUnitDisplayDelegateDecorator.h

Go to the documentation of this file.

/*================================================================================================*/
/*
 *
 *  Copyright 2013 by Avid Technology, Inc.
 *  All rights reserved.
 *  
 *  CONFIDENTIAL: This document contains confidential information.  Do not 
 *  read or examine this document unless you are an Avid Technology employee
 *  or have signed a non-disclosure agreement with Avid Technology which protects
 *  the confidentiality of this document.  DO NOT DISCLOSE ANY INFORMATION 
 *  CONTAINED IN THIS DOCUMENT TO ANY THIRD-PARTY WITHOUT THE PRIOR WRITTEN CONSENT 
 *  OF Avid Technolgy, INC.
 *
 */

/*================================================================================================*/


#ifndef AAX_CUNITDISPLAYDELEGATEDECORATOR_H
#define AAX_CUNITDISPLAYDELEGATEDECORATOR_H

#include "AAX_IDisplayDelegateDecorator.h"


template <typename T>
class AAX_CUnitDisplayDelegateDecorator : public AAX_IDisplayDelegateDecorator<T>
{
public:
    AAX_CUnitDisplayDelegateDecorator(const AAX_IDisplayDelegate<T>& displayDelegate, const AAX_CString& unitString);
    
    //Virtual Overrides
    AAX_CUnitDisplayDelegateDecorator<T>*   Clone() const;
    bool        ValueToString(T value, AAX_CString* valueString) const; 
    bool        ValueToString(T value, int32_t maxNumChars, AAX_CString* valueString) const ;
    bool        StringToValue(const AAX_CString& valueString, T* value) const;

protected:
    const AAX_CString   mUnitString;
};




template <typename T>
AAX_CUnitDisplayDelegateDecorator<T>::AAX_CUnitDisplayDelegateDecorator(const AAX_IDisplayDelegate<T>& displayDelegate, const AAX_CString& unitString)  :
    AAX_IDisplayDelegateDecorator<T>(displayDelegate),
    mUnitString(unitString)
{

}

template <typename T>
AAX_CUnitDisplayDelegateDecorator<T>*   AAX_CUnitDisplayDelegateDecorator<T>::Clone() const
{
    return new AAX_CUnitDisplayDelegateDecorator(*this);
}

template <typename T>
bool        AAX_CUnitDisplayDelegateDecorator<T>::ValueToString(T value, AAX_CString* valueString) const 
{
    bool succeeded = AAX_IDisplayDelegateDecorator<T>::ValueToString(value, valueString);
    *valueString += mUnitString;
    return succeeded;
}

template <typename T>
bool        AAX_CUnitDisplayDelegateDecorator<T>::ValueToString(T value, int32_t maxNumChars, AAX_CString* valueString) const
{
    bool succeeded = AAX_IDisplayDelegateDecorator<T>::ValueToString(value, maxNumChars, valueString);
    uint32_t strlen = valueString->Length();
    const uint32_t maxNumCharsUnsigned = (0 <= maxNumChars) ? static_cast<uint32_t>(maxNumChars) : 0;
    if (maxNumCharsUnsigned > strlen && (maxNumCharsUnsigned-strlen >= mUnitString.Length()))
        *valueString += mUnitString;
    return succeeded;
}


template <typename T>
bool        AAX_CUnitDisplayDelegateDecorator<T>::StringToValue(const AAX_CString& valueString, T* value) const
{
    //Just call through if there is obviously no unit string.
    if (valueString.Length() <= mUnitString.Length())
        return AAX_IDisplayDelegateDecorator<T>::StringToValue(valueString, value);
        
    //Just call through if the end of this string does not match the unit string.   
    AAX_CString unitSubString;
    valueString.SubString(valueString.Length() - mUnitString.Length(), mUnitString.Length(), &unitSubString);
    if (unitSubString != mUnitString)
        return AAX_IDisplayDelegateDecorator<T>::StringToValue(valueString, value);
    
    //Call through with the stripped down value string.  
    AAX_CString valueSubString;
    valueString.SubString(0, valueString.Length() - mUnitString.Length(), &valueSubString);
    return AAX_IDisplayDelegateDecorator<T>::StringToValue(valueSubString, value);
}





#endif //AAX_CUNITDISPLAYDELEGATEDECORATOR_H