gls_rso_container_util.h

Go to the documentation of this file.

/*! \file
  \brief  Standard GL Studio implementation of the rso interface (container side), disti::GlsRSO1_ResourceFilterImpl.
 
  \par Copyright Information
 
  Copyright (c) 2017 by The DiSTI Corporation.<br>
  11301 Corporate Blvd; Suite 100<br>
  Orlando, Florida 32817<br>
  USA<br>
  <br>
  All rights reserved.<br>
 
  This Software contains proprietary trade secrets of DiSTI and may not be
reproduced, in whole or part, in any form, or by any means of electronic,
mechanical, or otherwise, without the written permission of DiSTI.  Said
permission may be derived through the purchase of applicable DiSTI product
licenses which detail the distribution rights of this content and any
Derivative Works based on this or other copyrighted DiSTI Software.
 
  NO WARRANTY. THE SOFTWARE IS PROVIDED "AS-IS," WITHOUT WARRANTY OF ANY KIND,
AND ANY USE OF THIS SOFTWARE PRODUCT IS AT YOUR OWN RISK. TO THE MAXIMUM EXTENT
PERMITTED BY APPLICABLE LAW, DISTI AND ITS SUPPLIERS DISCLAIM ALL WARRANTIES
AND CONDITIONS, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
IMPLIED WARRANTIES AND CONDITIONS OF MERCHANTABILITY AND/OR FITNESS FOR A
PARTICULAR PURPOSE, TITLE, AND NON-INFRINGEMENT, WITH REGARD TO THE SOFTWARE.
 
  LIMITATION OF LIABILITY. TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW,
IN NO EVENT SHALL DISTI OR ITS SUPPLIERS BE LIABLE FOR ANY SPECIAL, INCIDENTAL,
INDIRECT, OR CONSEQUENTIAL DAMAGES WHATSOEVER (INCLUDING, WITHOUT LIMITATION,
DAMAGES FOR LOSS OF BUSINESS PROFITS, BUSINESS INTERRUPTION, LOSS OF BUSINESS
INFORMATION, OR ANY OTHER PECUNIARY LOSS) ARISING OUT OF THE USE OF OR
INABILITY TO USE THE SOFTWARE, EVEN IF DISTI HAS BEEN ADVISED OF THE POSSIBILITY
OF SUCH DAMAGES.  DISTI'S ENTIRE LIABILITY AND YOUR EXCLUSIVE REMEDY SHALL NOT
EXCEED FIVE DOLLARS (US$5.00).
 
  The aforementioned terms and restrictions are governed by the laws of the
State of Florida and the United States of America.
 
*/
#ifndef _GLS_RSO_CONTAINER_UTIL_H
#define _GLS_RSO_CONTAINER_UTIL_H
 
#include "gls_resources.h"
 
#ifdef GLES
#    include "rso_interface_es_1.h"
typedef disti::RSOInterfaceES1 RsoImplBaseInterface; ///< Typedef for the original RSO interface.
#else
#    include "rso_interface_1.h"
typedef disti::RSOInterface1 RsoImplBaseInterface; ///< Typedef for the original RSO interface.
#endif
 
namespace disti
{
/** Standard implmentation for the RSO1_ResourceFilter interface
*   This wraps the GlsResourceFilter class
*/
class GlsRSO1_ResourceFilterImpl : public RsoImplBaseInterface::ResourceFilter
{
protected:
    /// Reference to the GlsResourceFilter object being wrapped.
    /// The GlsRSO1_ResourceFilterImpl does not delete this object.
    GlsResourceFilter* _filter;
 
public:
    /// Constructor
    /// \param filter The filter object to wrap.
    GlsRSO1_ResourceFilterImpl( GlsResourceFilter* filter )
        : _filter( filter )
    {}
 
    virtual ~GlsRSO1_ResourceFilterImpl() {}
 
    /// Change the filter object that this interface is wrapping.
    /// \param filter The new filter to set.
    void Filter( GlsResourceFilter* filter ) { _filter = filter; }
 
    /// \return The current filter object.
    GlsResourceFilter* Filter() { return _filter; }
 
    /// \return The current levels of qualification to show in the name. -1 means full qualification.
    virtual int LevelsUp() const { return _filter ? _filter->LevelsUp() : -1; }
 
    /// How many levels of qualification to show in the name. -1 means full qualification.
    /// \param value the new qualification level to set
    virtual void LevelsUp( int value )
    {
        if( _filter )
        {
            _filter->LevelsUp( value );
        }
    }
 
    /// \return The current levels of children to show.
    virtual int GroupLevelsDown() const { return _filter ? _filter->GroupLevelsDown() : 0; }
 
    /// How many levels of children to show.
    ///  0 means don't show any children properties
    /// -1 means all the way down.
    /// \param value The new levels of children to show.
    virtual void GroupLevelsDown( int value )
    {
        if( _filter )
        {
            _filter->GroupLevelsDown( value );
        }
    }
 
    /// \return Whether or not to show names, or names and values.
    virtual bool NamesOnly() const { return _filter ? _filter->NamesOnly() : false; }
 
    /// If true, only a list of names will be returned.
    /// Values will not be returned.
    /// The format changes to not include the ":".
    /// \param value The new name format flag to set.
    virtual void NamesOnly( bool value )
    {
        if( _filter )
        {
            _filter->NamesOnly( value );
        }
    }
 
    /// Manage the exclude list. Takes precedence over includes.
    /// \param str The new name to add to the exclude list.
    virtual void AddExclude( const char* str )
    {
        if( _filter )
        {
            _filter->AddExclude( str );
        }
    }
 
    /// \return The number of items in the exclusion list.
    virtual int ExcludeCount() const { return _filter ? _filter->ExcludeCount() : 0; }
 
    /// \return The name of the exclude item associated with the index.
    /// \param index The index whose name is to be returned.
    virtual const char* GetExclude( int index ) const { return ( _filter ) ? ( _filter->GetExclude( index ) ) : ( NULL ); }
 
    /// Manage the include list.
    /// \param str The new name to add to the include list.
    virtual void AddInclude( const char* str )
    {
        if( _filter )
        {
            _filter->AddInclude( str );
        }
    }
 
    /// \return The number of items in the inclusion list.
    virtual int IncludeCount() const { return _filter ? _filter->IncludeCount() : 0; }
 
    /// \return The name of the include item associated with the index.
    /// \param index The index whose name is to be returned.
    virtual const char* GetInclude( int index ) const { return ( _filter ) ? ( _filter->GetInclude( index ) ) : ( NULL ); }
 
    /// Check a name against the filter.
    /// \param name The name to check against the filter.
    /// \return Whether or not the name passes the filter (to be included in the results).
    virtual bool PassFilter( const char* name ) const { return _filter ? _filter->PassFilter( name ) : true; }
};
 
} // namespace disti
 
#endif