FWRepresentationInfo Class Reference

#include <Fireworks/Core/interface/FWRepresentationInfo.h>

Public Member Functions
unsigned int	bitPackedViews () const
	FWRepresentationInfo (const std::string &iPurpose, unsigned int iProximity, unsigned int iBitPackedViews, bool iRepresentsSubPart, bool iRequiresFF)
	FWRepresentationInfo ()
bool	isValid () const
unsigned int	proximity () const
	measures how 'close' this representation is to the type in question, the large the number the farther away More...
const std::string &	purpose () const
bool	representsSubPart () const
bool	requiresFF () const

Private Attributes
unsigned int	m_bitPackedViews
unsigned int	m_proximity
std::string	m_purpose
bool	m_representsSubPart
bool	m_requiresFF

Detailed Description

Description: Collection of information about how a particular representation matches a data type

Usage: <usage>

Definition at line 28 of file FWRepresentationInfo.h.

Constructor & Destructor Documentation

FWRepresentationInfo::FWRepresentationInfo ( const std::string &  iPurpose, unsigned int  iProximity, unsigned int  iBitPackedViews, bool  iRepresentsSubPart, bool  iRequiresFF  )

inline

Definition at line 31 of file FWRepresentationInfo.h.

                                                                                                                                                     :
      m_purpose(iPurpose),
      m_proximity(iProximity),
      m_bitPackedViews(iBitPackedViews),
      m_representsSubPart(iRepresentsSubPart)
   {
   }

FWRepresentationInfo::FWRepresentationInfo ( )

inline

Definition at line 38 of file FWRepresentationInfo.h.

                          :
      m_purpose(),
      m_proximity(0xFFFFFFFF),
      m_bitPackedViews(0),
      m_representsSubPart(false),
      m_requiresFF(false){
   }

Member Function Documentation

unsigned int FWRepresentationInfo::bitPackedViews ( ) const

inline

Definition at line 65 of file FWRepresentationInfo.h.

References m_bitPackedViews.

                                       {
      return m_bitPackedViews;
   }

bool FWRepresentationInfo::isValid ( void  ) const

inline

Definition at line 55 of file FWRepresentationInfo.h.

References m_purpose.

Referenced by FWTypeToRepresentations::add(), and FWTypeToRepresentations::representationsForType().

                        {
      return !m_purpose.empty();
   }

unsigned int FWRepresentationInfo::proximity ( ) const

inline

measures how 'close' this representation is to the type in question, the large the number the farther away

Definition at line 52 of file FWRepresentationInfo.h.

References m_proximity.

Referenced by FWDetailViewManager::findViewersFor().

                                  {
      return m_proximity;
   }

const std::string& FWRepresentationInfo::purpose ( ) const

inline

Definition at line 48 of file FWRepresentationInfo.h.

References m_purpose.

                                    {
      return m_purpose;
   }

bool FWRepresentationInfo::representsSubPart ( void  ) const

inline

Definition at line 59 of file FWRepresentationInfo.h.

References m_representsSubPart.

                                  {
      return m_representsSubPart;
   }

bool FWRepresentationInfo::requiresFF ( ) const

inline

Definition at line 63 of file FWRepresentationInfo.h.

References m_requiresFF.

{ return m_requiresFF; }

Member Data Documentation

unsigned int FWRepresentationInfo::m_bitPackedViews

private

Definition at line 80 of file FWRepresentationInfo.h.

Referenced by bitPackedViews().

unsigned int FWRepresentationInfo::m_proximity

private

Definition at line 79 of file FWRepresentationInfo.h.

Referenced by proximity().

std::string FWRepresentationInfo::m_purpose

private

Definition at line 78 of file FWRepresentationInfo.h.

Referenced by isValid(), and purpose().

bool FWRepresentationInfo::m_representsSubPart

private

Definition at line 82 of file FWRepresentationInfo.h.

Referenced by representsSubPart().

bool FWRepresentationInfo::m_requiresFF

private

Definition at line 83 of file FWRepresentationInfo.h.

Referenced by requiresFF().