freSessionAccessor.h

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: freSessionAccessor.h,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 __freSessionAccessor_h
#define __freSessionAccessor_h

#include "freElementals.h"
#include "freParameter.h"
#include "freIDPath.h"
#include "freValidityTag.h"

namespace FREE
{

class SessionInfo; //will be included in the implementation part, to avoid circular reference
class SessionComponentCache;  //will be included in the implementation part, to avoid circular reference

class SessionAccessor
{
public:
  //  General interface part  //

  static ValidityTag::Pointer GetValidityTag(const IDPath& path, SessionComponentCache* pComponentCache); 

  static ValidityTag::Pointer GetValidityTagRequirement(const IDPath& path, SessionComponentCache* pComponentCache); 

  //   Media interface part   //

  typedef GenericMediaType::Pointer GenericMediaPointer;

  static GenericMediaPointer GetMedia(const IDPath& mediaID, SessionInfo* pInfo);

  static GenericMediaPointer GetLinkedMedia(const std::string& sMediaID,
                                            SessionComponentCache* pComponentCache,
                                            SessionInfo* pInfo,
                                            bool bMissingLinkException = false);

  static void SetMedia(const IDPath& mediaID, GenericMediaPointer& rMedia, SessionInfo* pInfo);

  static std::string GetMediaControllerID(const IDPath& mediaID, SessionComponentCache* pComponentCache); 

  // Parameter interface part //

  static void GetParameterValueByIDPath(const SessionComponentCache* pComponentCache, const IDPath& parameterID, std::string& value, bool bGetLastValidLayer = false);

  static void GetParameterValueByIDPath(const SessionComponentCache* pComponentCache, const IDPath& parameterID, bool& value, bool bGetLastValidLayer = false);

  static void GetParameterValueByIDPath(const SessionComponentCache* pComponentCache, const IDPath& parameterID, double& value, bool bGetLastValidLayer = false);
  
  static void GetParameterValueByIDPath(const SessionComponentCache* pComponentCache, const IDPath& parameterID, int& value, bool bGetLastValidLayer = false);

  static void GetParameterValueByIDPath(const SessionComponentCache* pComponentCache, const IDPath& parameterID, long& value, bool bGetLastValidLayer = false);

  static void GetParameterValueByIDPath(const SessionComponentCache* pComponentCache, const IDPath& parameterID, unsigned long& value, bool bGetLastValidLayer = false);

  static void GetParameterValue(const SessionComponentCache* pComponentCache, const std::string& sParameterName, std::string& value, const Parameter::ValueCountType& iItemPos = 0, const Parameter::LayerCountType& iLayer = 0, const bool& bGetLastValidLayer = false);

  static void GetParameterValue(const SessionComponentCache* pComponentCache, const std::string& sParameterName, bool& value, const Parameter::ValueCountType& iItemPos = 0, const Parameter::LayerCountType& iLayer = 0, const bool& bGetLastValidLayer = false);

  static void GetParameterValue(const SessionComponentCache* pComponentCache, const std::string& sParameterName, double& value, const Parameter::ValueCountType& iItemPos = 0, const Parameter::LayerCountType& iLayer = 0, const bool& bGetLastValidLayer = false);
  
  static void GetParameterValue(const SessionComponentCache* pComponentCache, const std::string& sParameterName, int& value, const Parameter::ValueCountType& iItemPos = 0, const Parameter::LayerCountType& iLayer = 0, const bool& bGetLastValidLayer = false);

  static void GetParameterValue(const SessionComponentCache* pComponentCache, const std::string& sParameterName, long& value, const Parameter::ValueCountType& iItemPos = 0, const Parameter::LayerCountType& iLayer = 0, const bool& bGetLastValidLayer = false);

  static void GetParameterValue(const SessionComponentCache* pComponentCache, const std::string& sParameterName, unsigned long& value, const Parameter::ValueCountType& iItemPos = 0, const Parameter::LayerCountType& iLayer = 0, const bool& bGetLastValidLayer = false);

  static Parameter::Pointer GetParameter(const SessionComponentCache* pComponentCache, const std::string& sParameterName);
  static Parameter::Pointer GetParameterByIDPath(const SessionComponentCache* pComponentCache, const IDPath& parameterID);


  static void SetParameterValueByIDPath(SessionComponentCache* pComponentCache, const IDPath& parameterID, const std::string& value);

  static void SetParameterValueByIDPath(SessionComponentCache* pComponentCache, const IDPath& parameterID, const bool& value);

  static void SetParameterValueByIDPath(SessionComponentCache* pComponentCache, const IDPath& parameterID, const double& value);
  
  static void SetParameterValueByIDPath(SessionComponentCache* pComponentCache, const IDPath& parameterID, const int& value);

  static void SetParameterValueByIDPath(SessionComponentCache* pComponentCache, const IDPath& parameterID, const long& value);

  static void SetParameterValueByIDPath(SessionComponentCache* pComponentCache, const IDPath& parameterID, const unsigned long& value);

};

} //end of namespace free;

#endif

---