RepBase Class Reference

List of all members.

---

Detailed Description

Definition at line 18 of file RepBase.sip.

Public Member Functions
	RepBase ()
virtual	~RepBase ()
	The virtual destructor.
virtual RepBase *	clone ()=0
	Returns a copy of the object.
const std::string &	name () const
	Returns the name of the representation.
virtual void	setColor (const Color &)
	Sets the color of the representation.
virtual void	setStyle (unsigned int)
	Sets the symbol of the representation.
virtual unsigned int	getStyle () const
	Returns the style of the point representation.
void	setText (const std::string &)
	Sets the text.
virtual const Color &	getColor () const
	Get the color of the representation.
virtual const Color &	color () const
	Returns the representation's color.
virtual void	setSelected (bool yes=true)
	Sets the representation to be selected if yes is true, otherwise set it to be deselected.
virtual bool	isSelected () const
	Returns true if representation is in selected state, otherwise returns false.
float	size () const
	Returns the size of the representation.
void	setSize (float)
	Sets the size of the representation.
virtual bool	xError () const
	Returns true if the point representation displays error on the X axis.
virtual bool	yError () const
	Returns true if the point representation displays error on the Y axis.
virtual void	setErrorOn (const std::string &, bool yes=true)
	Sets the error representation on specified axis, if any, to yes.

---

Constructor & Destructor Documentation

RepBase::RepBase (   )

virtual RepBase::~RepBase (   )  [virtual]

The virtual destructor.

---

Member Function Documentation

virtual RepBase* RepBase::clone (   )  [pure virtual]

Returns a copy of the object. Derived classes should implement this function by calling their copy constructor.

virtual const Color& RepBase::color (   )  const [virtual]

Returns the representation's color. Todo: Remove this member in favor of getColor().

virtual const Color& RepBase::getColor (   )  const [virtual]

Get the color of the representation.

virtual unsigned int RepBase::getStyle (   )  const [virtual]

Returns the style of the point representation. Derived class should override this member function if they support styles. This base class implementation returns 0.

virtual bool RepBase::isSelected (   )  const [virtual]

Returns true if representation is in selected state, otherwise returns false.

const std:: string& RepBase::name (   )  const

Returns the name of the representation. This name might be used by a Factory.

virtual void RepBase::setColor (  const Color &   )  [virtual]

Sets the color of the representation.

virtual void RepBase::setErrorOn (  const std::string &  , bool  yes = true )  [virtual]

Sets the error representation on specified axis, if any, to yes.

virtual void RepBase::setSelected (  bool  yes = true  )  [virtual]

Sets the representation to be selected if yes is true, otherwise set it to be deselected.

void RepBase::setSize (  float   )

Sets the size of the representation.

virtual void RepBase::setStyle (  unsigned  int  )  [virtual]

Sets the symbol of the representation. Derived classes may use this method to set the style of the representation, if they have various styles. This base class implementation does nothing.

void RepBase::setText (  const std::string &   )

Sets the text.

float RepBase::size (   )  const

Returns the size of the representation.

virtual bool RepBase::xError (   )  const [virtual]

Returns true if the point representation displays error on the X axis. The default implementation returns false. May be overridden by derived classes.

virtual bool RepBase::yError (   )  const [virtual]

Returns true if the point representation displays error on the Y axis. The default implementation returns false. May be overridden by derived classes.

---

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

• RepBase.sip

---