freStoreableMediaControllerBase.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: freStoreableMediaControllerBase.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 __freStoreableMediaControllerBase_txx
#define __freStoreableMediaControllerBase_txx

#include "freStoreableMediaControllerBase.h"
#include "freExceptions.h"

namespace FREE
{


template <class TMedia>
StoreableMediaControllerBase<TMedia>::
StoreableMediaControllerBase()
{
  this->UpdateControllerID(ControllerID::StoreableMediaControllerBase);
  this->m_Description = "Base class for all kind of media that can/must be stored on disk.";
};

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

  profile.Parameters().AddParameter(cParam_MediaFile,Parameter::PVTString,cParam_MediaFile,1,"");
};

template <class TMedia>
bool
StoreableMediaControllerBase<TMedia>::
SaveMedia(std::string sMediaPath, GenericMediaType* pMedia) const
{
        return false;
};

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

template <class TMedia>
void
StoreableMediaControllerBase<TMedia>::
SetMediaFile(const std::string& sMediaFile, SessionComponentCache* pCache) const
{
  if (!pCache) throwCtrlExceptionMacro("","Error; Passed cache pointer is NULL; cannot set media file.");
  if (!pCache->SetupIsAssigned()) throwCtrlExceptionMacro("","Error; Passed component setup is not assigned; cannot set media file.");

  pCache->Setup()->Parameters().SetParameterValue(cParam_MediaFile,sMediaFile);
};

template <class TMedia>
std::string
StoreableMediaControllerBase<TMedia>::
GetMediaFile(SessionComponentCache* pCache) const
{
  if (!pCache) throwCtrlExceptionMacro("","Error; Passed cache pointer is NULL; cannot get media file.");
  if (!pCache->SetupIsAssigned()) throwCtrlExceptionMacro("","Error; Passed component setup is not assigned; cannot get media file.");

  std::string sFile = "";
  pCache->Setup()->Parameters().GetParameterValue(cParam_MediaFile,sFile);

  return sFile;
};

template <class TMedia>
void
StoreableMediaControllerBase<TMedia>::
SetStatisticEntryMainComponent(StatisticEntry& rStatisticEntry,
                               ComponentType* pMainComponent,
                               SessionComponentCache* pMainComponentCache,
                               SessionInfo* pSessionInfo,
                               StatisticDictionary& rDictionary) const
{
  std::string sIDPath = pMainComponentCache->GetIDPath();
  StatisticValueDefinition* pEntry = rDictionary.GetValueDefinitionByName(sIDPath,"MediaID");
    
  if (!pEntry) //Entry is not recorded yet, so do so.
  {
    pEntry = rDictionary.AddValueDefinition(sIDPath,"MediaID","ID of the media");
    rDictionary.AddValueDefinition(sIDPath,"MediaFile","File where the media will be saved");
  }

  std::string sFile;

  try
  {
    SessionAccessor::GetParameterValue(pMainComponentCache,cParam_MediaFile,sFile);
  }
  catchAllNPassMacro("Error while retrieving parameter values.");

  rStatisticEntry.AddValue(pMainComponentCache->GetComponentID(),pEntry->GetRefID());
  rStatisticEntry.AddValue(sFile,pEntry->GetRefID()+1);
};

} //end of namespace free

#endif

---