AAX_CParameterManager.h

Go to the documentation of this file.

/*================================================================================================*/
/*
 *
 *  Copyright 2014-2015, 2018, 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_CPARAMETERMANAGER_H
#define AAX_CPARAMETERMANAGER_H
 
#include "AAX_CParameter.h"
#include "AAX.h"
 
#include <vector>
#include <map>
 
 
 
 
class AAX_IAutomationDelegate;
 
class AAX_CParameterManager
{
public:
    AAX_CParameterManager();
    ~AAX_CParameterManager();
 
    void            Initialize(AAX_IAutomationDelegate* iAutomationDelegateUnknown);
    
    int32_t     NumParameters() const;  
    
    void            RemoveParameterByID(AAX_CParamID identifier);
    
    void            RemoveAllParameters();
 
    AAX_IParameter*         GetParameterByID(AAX_CParamID  identifier);
    
    const AAX_IParameter*   GetParameterByID(AAX_CParamID  identifier) const;
    
    AAX_IParameter*         GetParameterByName(const char*  name);
    
    const AAX_IParameter*   GetParameterByName(const char*  name) const;
    
    AAX_IParameter*         GetParameter(int32_t index);
 
    const AAX_IParameter*   GetParameter(int32_t index) const;
    
    int32_t                 GetParameterIndex(AAX_CParamID identifier) const;
 
    void                    AddParameter(AAX_IParameter*    param);
    
    void                    RemoveParameter(AAX_IParameter* param);
    
protected:
    
    AAX_IAutomationDelegate*        mAutomationDelegate;        //This object is not ref-counted here.  Do not delete it.  It is ref counted by this object's parent.
    std::vector<AAX_IParameter*>    mParameters;
    std::map<std::string, AAX_IParameter*> mParametersMap;
};
 
 
 
 
#endif // AAX_CPARAMETERMANAGER_H