occt/src/Standard/Standard_Transient.hxx

// Copyright (c) 1998-1999 Matra Datavision
// Copyright (c) 1999-2014 OPEN CASCADE SAS
//
// This file is part of Open CASCADE Technology software library.
//
// This library is free software; you can redistribute it and/or modify it under
// the terms of the GNU Lesser General Public License version 2.1 as published
// by the Free Software Foundation, with special exception defined in the file
// OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
// distribution for complete text of the license and disclaimer of any warranty.
//
// Alternatively, this file may be used under the terms of Open CASCADE
// commercial license or contractual agreement.

#ifndef _Standard_Transient_HeaderFile
#define _Standard_Transient_HeaderFile

#include <Standard.hxx>
#include <Standard_DefineAlloc.hxx>
#include <Standard_PrimitiveTypes.hxx>

class Standard_Type;

namespace opencascade {
  template <class T> class handle;
}

//! Abstract class which forms the root of the entire 
//! Transient class hierarchy.

class Standard_Transient
{
public:
  // Standard OCCT memory allocation stuff
  DEFINE_STANDARD_ALLOC

public:

  //! Empty constructor
  Standard_Transient() : myRefCount_(0) {}

  //! Copy constructor -- does nothing
  Standard_Transient (const Standard_Transient&) : myRefCount_(0) {}

  //! Assignment operator, needed to avoid copying reference counter
  Standard_Transient& operator= (const Standard_Transient&) { return *this; }

  //! Destructor must be virtual
  virtual ~Standard_Transient() {}

  //! Memory deallocator for transient classes
  Standard_EXPORT virtual void Delete() const;

public: 
  //!@name Support of run-time type information (RTTI)

  typedef void base_type;

  static const char* get_type_name () { return "Standard_Transient"; }

  //! Returns type descriptor of Standard_Transient class
  Standard_EXPORT static const opencascade::handle<Standard_Type>& get_type_descriptor ();

  //! Returns a type descriptor about this object.
  Standard_EXPORT virtual const opencascade::handle<Standard_Type>& DynamicType() const;

  //! Returns a true value if this is an instance of Type.
  Standard_EXPORT Standard_Boolean IsInstance(const opencascade::handle<Standard_Type>& theType) const;  

  //! Returns a true value if this is an instance of TypeName.
  Standard_EXPORT Standard_Boolean IsInstance(const Standard_CString theTypeName) const;  

  //! Returns true if this is an instance of Type or an
  //! instance of any class that inherits from Type.
  //! Note that multiple inheritance is not supported by OCCT RTTI mechanism.
  Standard_EXPORT Standard_Boolean IsKind(const opencascade::handle<Standard_Type>& theType) const;

  //! Returns true if this is an instance of TypeName or an
  //! instance of any class that inherits from TypeName.
  //! Note that multiple inheritance is not supported by OCCT RTTI mechanism.
  Standard_EXPORT Standard_Boolean IsKind(const Standard_CString theTypeName) const;

  //! Returns non-const pointer to this object (like const_cast).
  //! For protection against creating handle to objects allocated in stack
  //! or call from constructor, it will raise exception Standard_ProgramError
  //! if reference counter is zero.
  Standard_EXPORT Standard_Transient* This() const;

public:
  //!@name Reference counting, for use by handle<>

  //! Get the reference counter of this object
  Standard_Integer GetRefCount() const { return myRefCount_; }

  //! Increments the reference counter of this object
  Standard_EXPORT void IncrementRefCounter() const;

  //! Decrements the reference counter of this object;
  //! returns the decremented value
  Standard_EXPORT Standard_Integer DecrementRefCounter() const;

private:

  //! Reference counter.
  //! Note use of underscore, aimed to reduce probability 
  //! of conflict with names of members of derived classes.
  mutable volatile Standard_Integer myRefCount_;
};


//! Computes a hash code for the given transient object, in the range [1, theUpperBound]
//! @param theTransientObject the transient object which hash code is to be computed
//! @param theUpperBound the upper bound of the range a computing hash code must be within
//! @return a computed hash code, in the range [1, theUpperBound]
inline Standard_Integer HashCode (const Standard_Transient* const theTransientObject,
                                  const Standard_Integer          theUpperBound)
{
  return ::HashCode (static_cast<const void*> (theTransientObject), theUpperBound);
}

//! Definition of Handle_Standard_Transient as typedef for compatibility
typedef opencascade::handle<Standard_Transient> Handle_Standard_Transient;

#endif