Aspect.hpp

Go to the documentation of this file.

/*
 * Copyright (c) 2011-2022, The DART development contributors
 * All rights reserved.
 *
 * The list of contributors can be found at:
 *   https://github.com/dartsim/dart/blob/master/LICENSE
 *
 * This file is provided under the following "BSD-style" License:
 *   Redistribution and use in source and binary forms, with or
 *   without modification, are permitted provided that the following
 *   conditions are met:
 *   * Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *   * Redistributions in binary form must reproduce the above
 *     copyright notice, this list of conditions and the following
 *     disclaimer in the documentation and/or other materials provided
 *     with the distribution.
 *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
 *   CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
 *   INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 *   MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 *   DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
 *   CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 *   USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
 *   AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 *   LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
 *   ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 *   POSSIBILITY OF SUCH DAMAGE.
 */
 
#ifndef DART_COMMON_DETAIL_ASPECT_HPP_
#define DART_COMMON_DETAIL_ASPECT_HPP_
 
#include <cassert>
 
#include "dart/common/Aspect.hpp"
#include "dart/common/Console.hpp"
#include "dart/common/Macros.hpp"
 
namespace dart {
namespace common {
 
//==============================================================================
template <class CompositeType>
CompositeTrackingAspect<CompositeType>::CompositeTrackingAspect()
  : mComposite(
      nullptr) // This will be set later when the Composite calls setComposite
{
  // Do nothing
}
 
//==============================================================================
template <class CompositeType>
CompositeType* CompositeTrackingAspect<CompositeType>::getComposite()
{
  return mComposite;
}
 
//==============================================================================
template <class CompositeType>
const CompositeType* CompositeTrackingAspect<CompositeType>::getComposite()
    const
{
  return mComposite;
}
 
//==============================================================================
template <class CompositeType>
bool CompositeTrackingAspect<CompositeType>::hasComposite() const
{
  return (nullptr != mComposite);
}
 
//==============================================================================
template <class CompositeType>
void CompositeTrackingAspect<CompositeType>::setComposite(
    Composite* newComposite)
{
  assert(nullptr == mComposite);
 
  mComposite = dynamic_cast<CompositeType*>(newComposite);
  // Note: Derived classes should be responsible for handling the case in which
  // the new composite type does not match the expected type. We should not
  // assume here that it is an error.
}
 
//==============================================================================
template <class CompositeType>
void CompositeTrackingAspect<CompositeType>::loseComposite(
    Composite* oldComposite)
{
  DART_UNUSED(oldComposite);
  assert(oldComposite == mComposite);
  mComposite = nullptr;
}
 
} // namespace common
} // namespace dart
 
#endif // DART_COMMON_DETAIL_ASPECT_HPP_