CMS 3D CMS Logo

List of all members | Public Member Functions | Private Attributes
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 30 of file FWRepresentationInfo.h.

35  : m_purpose(iPurpose),
36  m_proximity(iProximity),
37  m_bitPackedViews(iBitPackedViews),
38  m_representsSubPart(iRepresentsSubPart),
39  m_requiresFF(iRequiresFF) {}
FWRepresentationInfo::FWRepresentationInfo ( )
inline

Member Function Documentation

unsigned int FWRepresentationInfo::bitPackedViews ( ) const
inline

Definition at line 57 of file FWRepresentationInfo.h.

References m_bitPackedViews.

57 { return m_bitPackedViews; }
bool FWRepresentationInfo::isValid ( void  ) const
inline
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 49 of file FWRepresentationInfo.h.

References m_proximity.

Referenced by FWDetailViewManager::findViewersFor().

49 { return m_proximity; }
const std::string& FWRepresentationInfo::purpose ( ) const
inline

Definition at line 46 of file FWRepresentationInfo.h.

References m_purpose.

46 { return m_purpose; }
bool FWRepresentationInfo::representsSubPart ( void  ) const
inline

Definition at line 53 of file FWRepresentationInfo.h.

References m_representsSubPart.

bool FWRepresentationInfo::requiresFF ( ) const
inline

Definition at line 55 of file FWRepresentationInfo.h.

References m_requiresFF.

Member Data Documentation

unsigned int FWRepresentationInfo::m_bitPackedViews
private

Definition at line 71 of file FWRepresentationInfo.h.

Referenced by bitPackedViews().

unsigned int FWRepresentationInfo::m_proximity
private

Definition at line 70 of file FWRepresentationInfo.h.

Referenced by proximity().

std::string FWRepresentationInfo::m_purpose
private

Definition at line 69 of file FWRepresentationInfo.h.

Referenced by isValid(), and purpose().

bool FWRepresentationInfo::m_representsSubPart
private

Definition at line 73 of file FWRepresentationInfo.h.

Referenced by representsSubPart().

bool FWRepresentationInfo::m_requiresFF
private

Definition at line 74 of file FWRepresentationInfo.h.

Referenced by requiresFF().