Mantid::Geometry::ComponentInfoItem< T > Class Template Reference

ComponentInfoItem Return type for ComponentInfoIterators. More...

#include <ComponentInfoItem.h>

Public Member Functions
const std::vector< size_t > &	children () const
	ComponentInfoItem (T &componentInfo, const size_t index)
std::vector< size_t >	componentsInSubtree () const
std::vector< size_t >	detectorsInSubtree () const
bool	hasParent () const
size_t	index () const
bool	isDetector () const
std::string	name () const
size_t	parent () const
Kernel::V3D	position () const
Kernel::Quat	rotation () const
Kernel::V3D	scaleFactor () const

Public Attributes
T *	m_componentInfo
size_t	m_index

Detailed Description

template<typename T>
class Mantid::Geometry::ComponentInfoItem< T >

ComponentInfoItem Return type for ComponentInfoIterators.

Provides AOS type access to ComponentInfo

Definition at line 20 of file ComponentInfoItem.h.

Constructor & Destructor Documentation

ComponentInfoItem()

template<typename T >

Mantid::Geometry::ComponentInfoItem< T >::ComponentInfoItem ( T &  componentInfo, const size_t  index  )

inline

Definition at line 22 of file ComponentInfoItem.h.

Member Function Documentation

children()

template<typename T >

const std::vector< size_t > & Mantid::Geometry::ComponentInfoItem< T >::children ( ) const

inline

Definition at line 27 of file ComponentInfoItem.h.

References Mantid::Geometry::ComponentInfoItem< T >::m_componentInfo, and Mantid::Geometry::ComponentInfoItem< T >::m_index.

componentsInSubtree()

template<typename T >

std::vector< size_t > Mantid::Geometry::ComponentInfoItem< T >::componentsInSubtree ( ) const

inline

Definition at line 26 of file ComponentInfoItem.h.

References Mantid::Geometry::ComponentInfoItem< T >::m_componentInfo, and Mantid::Geometry::ComponentInfoItem< T >::m_index.

detectorsInSubtree()

template<typename T >

std::vector< size_t > Mantid::Geometry::ComponentInfoItem< T >::detectorsInSubtree ( ) const

inline

Definition at line 25 of file ComponentInfoItem.h.

References Mantid::Geometry::ComponentInfoItem< T >::m_componentInfo, and Mantid::Geometry::ComponentInfoItem< T >::m_index.

hasParent()

template<typename T >

bool Mantid::Geometry::ComponentInfoItem< T >::hasParent ( ) const

inline

Definition at line 31 of file ComponentInfoItem.h.

References Mantid::Geometry::ComponentInfoItem< T >::m_componentInfo, and Mantid::Geometry::ComponentInfoItem< T >::m_index.

index()

template<typename T >

size_t Mantid::Geometry::ComponentInfoItem< T >::index ( ) const

inline

Definition at line 34 of file ComponentInfoItem.h.

References Mantid::Geometry::ComponentInfoItem< T >::m_index.

isDetector()

template<typename T >

bool Mantid::Geometry::ComponentInfoItem< T >::isDetector ( ) const

inline

Definition at line 24 of file ComponentInfoItem.h.

References Mantid::Geometry::ComponentInfoItem< T >::m_componentInfo, and Mantid::Geometry::ComponentInfoItem< T >::m_index.

name()

template<typename T >

std::string Mantid::Geometry::ComponentInfoItem< T >::name ( ) const

inline

Definition at line 33 of file ComponentInfoItem.h.

References Mantid::Geometry::ComponentInfoItem< T >::m_componentInfo, and Mantid::Geometry::ComponentInfoItem< T >::m_index.

parent()

template<typename T >

size_t Mantid::Geometry::ComponentInfoItem< T >::parent ( ) const

inline

Definition at line 30 of file ComponentInfoItem.h.

References Mantid::Geometry::ComponentInfoItem< T >::m_componentInfo, and Mantid::Geometry::ComponentInfoItem< T >::m_index.

position()

template<typename T >

Kernel::V3D Mantid::Geometry::ComponentInfoItem< T >::position ( ) const

inline

Definition at line 28 of file ComponentInfoItem.h.

References Mantid::Geometry::ComponentInfoItem< T >::m_componentInfo, and Mantid::Geometry::ComponentInfoItem< T >::m_index.

rotation()

template<typename T >

Kernel::Quat Mantid::Geometry::ComponentInfoItem< T >::rotation ( ) const

inline

Definition at line 29 of file ComponentInfoItem.h.

References Mantid::Geometry::ComponentInfoItem< T >::m_componentInfo, and Mantid::Geometry::ComponentInfoItem< T >::m_index.

scaleFactor()

template<typename T >

Kernel::V3D Mantid::Geometry::ComponentInfoItem< T >::scaleFactor ( ) const

inline

Definition at line 32 of file ComponentInfoItem.h.

References Mantid::Geometry::ComponentInfoItem< T >::m_componentInfo, and Mantid::Geometry::ComponentInfoItem< T >::m_index.

Member Data Documentation

m_componentInfo

template<typename T >

T* Mantid::Geometry::ComponentInfoItem< T >::m_componentInfo

Definition at line 38 of file ComponentInfoItem.h.

Referenced by Mantid::Geometry::ComponentInfoItem< T >::children(), Mantid::Geometry::ComponentInfoItem< T >::componentsInSubtree(), Mantid::Geometry::ComponentInfoItem< T >::detectorsInSubtree(), Mantid::Geometry::ComponentInfoItem< T >::hasParent(), Mantid::Geometry::ComponentInfoItem< T >::isDetector(), Mantid::Geometry::ComponentInfoItem< T >::name(), Mantid::Geometry::ComponentInfoItem< T >::parent(), Mantid::Geometry::ComponentInfoItem< T >::position(), Mantid::Geometry::ComponentInfoItem< T >::rotation(), and Mantid::Geometry::ComponentInfoItem< T >::scaleFactor().

m_index

template<typename T >

size_t Mantid::Geometry::ComponentInfoItem< T >::m_index

Definition at line 39 of file ComponentInfoItem.h.

Referenced by Mantid::Geometry::ComponentInfoItem< T >::children(), Mantid::Geometry::ComponentInfoItem< T >::componentsInSubtree(), Mantid::Geometry::ComponentInfoItem< T >::detectorsInSubtree(), Mantid::Geometry::ComponentInfoItem< T >::hasParent(), Mantid::Geometry::ComponentInfoItem< T >::index(), Mantid::Geometry::ComponentInfoItem< T >::isDetector(), Mantid::Geometry::ComponentInfoItem< T >::name(), Mantid::Geometry::ComponentInfoItem< T >::parent(), Mantid::Geometry::ComponentInfoItem< T >::position(), Mantid::Geometry::ComponentInfoItem< T >::rotation(), and Mantid::Geometry::ComponentInfoItem< T >::scaleFactor().

---

The documentation for this class was generated from the following file:

• Framework/Geometry/inc/MantidGeometry/Instrument/ComponentInfoItem.h