rso_interface_2.h

Go to the documentation of this file.

/*! \file
  \brief  Defines the RSO interface v2, which provides a generic way of accessing RSOs and other content, disti::RSOInterface2.
 
  \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 _RSO_INTERFACE_2_H
#define _RSO_INTERFACE_2_H
 
#include "rso_interface_1.h"
 
namespace disti
{
////////////////////////////////////////////////////////////////////////////////
// In order for the RSO to be discovered in a .DLL or .so file,
// The following "C" funtions need to be defined.
// They are only comments here.
////////////////////////////////////////////////////////////////////////////////
// RSOInterface1* CreateRSOInterface2_ClassNameHere()
// Optionally:
// const char* GlsDefaultClassName()
////////////////////////////////////////////////////////////////////////////////
 
/** The RSOInterface2 class defines an abstract interface to an RSO instance. 
  */
class RSOInterface2 : public RSOInterface1
{
public:
    ////////////////////////////////////////////////////////////////////////////////
    // The RSO Interface methods
    ////////////////////////////////////////////////////////////////////////////////
    typedef unsigned int ResourceHandle; ///< Typedef for a unique resource identifier.
 
    // Explicitly carry these methods forward from the base class, as we're creating overloads of them here.
    using RSOInterface1::GetResource;
    using RSOInterface1::SetResource;
 
    /// Obtains a resource handle to a given named resource
    /// This handle must be disposed of with the ReleaseResourceHandle method once it
    /// is no longer needed.
    /// If this method fails, the return value will not be a valid handle; this can
    /// be determined by calling IsResourceHandleValid.
    /// \param resourceName The resource name to create a handle for.
    /// \return A handle to the desired resource.
    virtual ResourceHandle CreateResourceHandle( const char* resourceName ) = 0;
 
    /// Disposes of a resource handle.
    /// \param resourceHandle The resource handle to release.
    virtual void ReleaseResourceHandle( ResourceHandle resourceHandle ) = 0;
 
    /// Checks if a given resource handle is valid.
    /// \param resourceHandle The resource handle to check.
    /// \return Whether or not the handle is valid.
    virtual bool IsResourceHandleValid( ResourceHandle resourceHandle ) = 0;
 
    /// Set the string value for a resource specified by handle
    /// \param resourceHandle The handle of the resource to set.
    /// \param resourceVal The new string value to set.
    virtual void SetResource( ResourceHandle resourceHandle, const char* resourceVal ) = 0;
 
    /// \return The string value for a resource specified by handle.
    /// \param resourceHandle The handle to return the string value for.
    virtual const char* GetResource( ResourceHandle resourceHandle ) = 0;
 
    /// Set the value as an integer for a given named resource.
    /// \param resourceName The name of the resource to set.
    /// \param resourceVal The new integer value to set.
    virtual void SetIntResource( const char* resourceName, long resourceVal ) = 0;
 
    /// \return The value as an integer for a given named resource.
    /// \param resourceName The name to return the integer value for.
    virtual long GetIntResource( const char* resourceName ) = 0;
 
    /// Set the value as an integer for a resource specified by handle.
    /// \param handle The handle of the resource to set.
    /// \param resourceVal The new integer value to set.
    virtual void SetIntResource( ResourceHandle handle, long resourceVal ) = 0;
 
    /// \return The value as an integer for a resource specified by handle.
    /// \param resourceHandle The handle to return the integer value for.
    virtual long GetIntResource( ResourceHandle resourceHandle ) = 0;
 
    /// Set the value as a float for a given named resource.
    /// \param resourceName The name of the resource to set.
    /// \param resourceVal The new float value to set.
    virtual void SetFloatResource( const char* resourceName, double resourceVal ) = 0;
 
    /// \return The value as a float for a given named resource.
    /// \param resourceName The name to return the float value for.
    virtual double GetFloatResource( const char* resourceName ) = 0;
 
    /// Set the value as a float for a resource specified by handle.
    /// \param handle The handle of the resource to set.
    /// \param resourceVal The new float value to set.
    virtual void SetFloatResource( ResourceHandle handle, double resourceVal ) = 0;
 
    /// \return The value as a float for a resource specified by handle.
    /// \param resourceHandle The handle to return the integer value for.
    virtual double GetFloatResource( ResourceHandle resourceHandle ) = 0;
 
protected:
    ////////////////////////////////////////////////////////////////////////////////
    /// Protected destructor so it can't be deleted directly.
    ////////////////////////////////////////////////////////////////////////////////
    virtual ~RSOInterface2() {}
};
 
} // end namespace disti
 
#endif