cx::Rep Class Reference

Abstract interface for entities that can be added to a View. More...

#include <cxRep.h>

Inheritance diagram for cx::Rep:

Public Member Functions
virtual	~Rep ()
virtual QString	getType () const =0
virtual void	connectToView (ViewPtr theView)=0
virtual void	disconnectFromView (ViewPtr theView)=0
virtual bool	isConnectedToView (ViewPtr theView) const =0
virtual void	setName (QString name)=0
virtual QString	getName () const =0
virtual QString	getUid () const =0
virtual void	printSelf (std::ostream &os, Indent indent)=0

Detailed Description

Abstract interface for entities that can be added to a View.

Rep (Representation) is the interface that all Representations in ssc must implement.

The default implementation can be found in RepImpl. Inherit from that when implementing concrete classes.

Definition at line 43 of file cxRep.h.

Constructor & Destructor Documentation

virtual cx::Rep::~Rep ( )

inlinevirtual

Definition at line 47 of file cxRep.h.

Member Function Documentation

virtual void cx::Rep::connectToView ( ViewPtr  theView )

pure virtual

Do not use this method! It is only used by View to set up an internal connection between the two.

Parameters

theView

The view to add this representation to.

Returns

Implemented in cx::RepImpl.

virtual void cx::Rep::disconnectFromView ( ViewPtr  theView )

pure virtual

Do not use this method! It is only used by View to tear down an internal connection between the two.

Parameters

theView

The view to disconnect from.

Returns

Implemented in cx::RepImpl.

virtual QString cx::Rep::getName ( ) const

pure virtual

Returns

a user-friendly name for this instance

Implemented in cx::RepImpl.

virtual QString cx::Rep::getType ( ) const

pure virtual

Returns

a string identifying the Rep type. Each suclass implement this with its own class name. Subclasses from other namespaces (such as cx and snw) should add that namespace as a prefix.

Implemented in cx::SlicePlanes3DMarkerIn2DRep, cx::SlicePlanes3DRep, cx::LandmarkRep, cx::Image2DRep3D, cx::GeometricRep, cx::Texture3DSlicerRep, cx::VolumetricRep, cx::OrientationAnnotationRep, cx::PickerRep, cx::ToolRep3D, cx::Slices3DRep, cx::ToolRep2D, cx::AngleMetricRep, cx::VideoFixedPlaneRep, cx::CrossHairRep2D, cx::MetricNamesRep, cx::SphereMetricRep, cx::RepImpl, cx::OrientationAnnotationSmartRep, cx::FiberBundleRep, cx::GeometricRep2D, cx::CustomMetricRep, cx::DistanceMetricRep, cx::DisplayTextRep, cx::SliceRepSW, cx::ToolMetricRep, cx::FrameMetricRep, cx::PointMetricRep, cx::PointMetricRep2D, cx::DonutMetricRep, cx::RegionOfInterestMetricRep, cx::GuideRep2D, cx::AxesRep, cx::PlaneMetricRep, cx::SphereMetricRep2D, cx::OrientationAnnotation3DRep, cx::Stream2DRep3D, and cx::StreamRep3D.

virtual QString cx::Rep::getUid ( ) const

pure virtual

Return an unique id for this instance, i.e. unique over all Rep instances.

Returns

the unique id.

Implemented in cx::RepImpl.

virtual bool cx::Rep::isConnectedToView ( ViewPtr  theView ) const

pure virtual

Traverse the vector of views to see if this Representation is connected to one of them.

Parameters

theView

A view pointer.

Returns

True if theView was found in the internal vector of View pointers. false otherwise.

Implemented in cx::RepImpl.

virtual void cx::Rep::printSelf ( std::ostream &  os, Indent  indent  )

pure virtual

Implemented in cx::Texture3DSlicerRep, cx::RepImpl, and cx::SliceRepSW.

virtual void cx::Rep::setName ( QString  name )

pure virtual

Set the name of this Rep. This is useful for context-menus in Views and other user interaction constructs.

Parameters

name	The user-friendly name for this instance.

Implemented in cx::RepImpl.

---

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

• /media/dev/bamboodrive/b/xml-data/build-dir/CX-TB-JOB1/CX/CX/source/resource/view/Rep/cxRep.h