freMediaControllerBase.txx

Go to the documentation of this file.

/*=========================================================================

  Program:   F.R.E.E. - flexible registration evaluation engine
  Version:   v.1.0.0
  Date:      $Date: 2006/09/01 12:00:00 $
  Module:    $RCSfile: freMediaControllerBase.txx,v $
  Language:  C++



  Copyright (c) 2007 Ralf o Floca (Department of Medical Informatics,
  Institute for Medical Biometry and Informatics, University of Heidelberg,
  Germany). All rights reserved.
  See FREECopyright.txt or http://www.mi.med.uni-hd.de/free/copyright.htm
  for details.

     This software is distributed WITHOUT ANY WARRANTY; without even 
     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
     PURPOSE.  See the above copyright notices for more information.

=========================================================================*/

#ifndef __freMediaControllerBase_txx
#define __freMediaControllerBase_txx

#include "freMediaControllerBase.h"
#include "freExceptions.h"

namespace FREE
{


template <class TMedia>
MediaControllerBase<TMedia>::
MediaControllerBase()
{
  this->UpdateControllerID(ControllerID::MediaControllerBase);
  this->m_Description = "Base class for all kind of media.";
};

template <class TMedia>
void
MediaControllerBase<TMedia>::
GenerateProfile(CtrlProfile::ControllerProfile& profile, 
                const SessionComponentCache* pComponentCache,
                bool bRegardOldSetup) const
{
  Superclass::GenerateProfile(profile,pComponentCache,bRegardOldSetup);

  profile.MediaMap().AddMedia("media",this->ControllerID(), DAGet,this->GetMediaDimension());
};

template <class TMedia>
typename MediaControllerBase<TMedia>::ComponentPointer
MediaControllerBase<TMedia>::
BuildMainComponent(ComponentSetup* pComponentSetup, SessionComponentCache* pComponentCache) const
{
  ComponentPointer component = Superclass::BuildMainComponent(pComponentSetup,pComponentCache);
  DirectSessionComponentAccessor::SetRepositoryElement(SessionComponentRepositoryKeys::MediaValidity("media"),ValidityTag::NewNull(),pComponentCache);
  return component;
};

template <class TMedia>
bool
MediaControllerBase<TMedia>::
LoadMedia(SessionComponentCache* pCache) const
{
        return false;
};

template <class TMedia>
unsigned long
MediaControllerBase<TMedia>::
GetMediaDimension() const
{
  return 0;
};

template <class TMedia>
typename MediaControllerBase<TMedia>::GenericMediaPointer
MediaControllerBase<TMedia>::
GetMediaCasted(const MediaID& mediaID,
               ComponentType* pComponent,
               SessionComponentCache* pComponentCache,
               SessionInfo* pSessionInfo) const
{
    if (!pComponentCache)
        throwCtrlExceptionMacro("", "Error; passed component cache is NULL");
    if (!pComponentCache->ComponentIsAssigned())
        throwCtrlExceptionMacro("", "Error; No component available to retrieve MediaID "<<mediaID<<". Check if session was correctly initialized.");

    /*by default the component is the media itself and can be retrieved
      via the media interface by using the ID media. Redefine this function,
        if you want to change that behaviour.*/
    if (mediaID == "media")
        return pComponentCache->Component();

    throwCtrlExceptionMacro("", "Error; mediaID "<<mediaID<<" is not known by the component/controller. Check if session was correctly initialized.");
}; 


template <class TMedia>
void
MediaControllerBase<TMedia>::
SetMediaCasted(const MediaID& mediaID,
                              GenericMediaType* pMedia,
                                                                                                                  ComponentType* pComponent,
                              SessionComponentCache* pComponentCache,
                              SessionInfo* pSessionInfo) const
{
    if (!pComponentCache)
        throwCtrlExceptionMacro("", "Error; passed component cache is NULL");

    /*by default the component is the media itself and can be set
      via the media interface by using the ID media. Also the validity
      tag will be updated. Redefine this function,
        if you want to change that behaviour.*/
    if (mediaID == "media")
    {
      this->SetGenericComponent(pMedia,pComponentCache);
      this->ActualizeMediaValidityTag(mediaID,pComponentCache);
    }

    throwCtrlExceptionMacro("", "Error; mediaID "<<mediaID<<" is not known by the component/controller. Check if session was correctly initialized.");
}; 

} //end of namespace free

#endif

---