DocumentModelSegments Class Reference

Model for DlgSettingsSegments and CmdSettingsSegments. More...

#include <DocumentModelSegments.h>

Inheritance diagram for DocumentModelSegments:

Collaboration diagram for DocumentModelSegments:

Public Member Functions
	DocumentModelSegments ()
	Default constructor.
	DocumentModelSegments (const Document &document)
	Initial constructor from Document.
	DocumentModelSegments (const DocumentModelSegments &other)
	Copy constructor.
DocumentModelSegments &	operator= (const DocumentModelSegments &other)
	Assignment constructor.
bool	fillCorners () const
	Get method for fill corners.
InactiveOpacity	inactiveOpacity () const
	Get method for inactive opacity.
ColorPalette	lineColor () const
	Get method for line color.
double	lineWidthActive () const
	Get method for line width when active.
double	lineWidthInactive () const
	Get method for line width when inactive.
virtual void	loadXml (QXmlStreamReader &reader)
	Load model from serialized xml.
double	minLength () const
	Get method for min length.
double	pointSeparation () const
	Get method for point separation.
void	printStream (QString indentation, QTextStream &str) const
	Debugging method that supports print method of this class and printStream method of some other class(es).
virtual void	saveXml (QXmlStreamWriter &writer) const
	Save entire model as xml into stream.
void	setFillCorners (bool fillCorners)
	Set method for fill corners.
void	setInactiveOpacity (InactiveOpacity inactiveOpacity)
	Set method for inactive opacity.
void	setLineColor (ColorPalette lineColor)
	Set method for line color.
void	setLineWidthActive (double lineWidth)
	Set method for line width when active.
void	setLineWidthInactive (double lineWidth)
	Set method for line width when inactive.
void	setMinLength (double minLength)
	Set method for min length.
void	setPointSeparation (double pointSeparation)
	Set method for point separation.
Public Member Functions inherited from DocumentModelAbstractBase
	DocumentModelAbstractBase ()
	Single constructor.
virtual	~DocumentModelAbstractBase ()
	Single destructor.

Detailed Description

Model for DlgSettingsSegments and CmdSettingsSegments.

Definition at line 18 of file DocumentModelSegments.h.

Constructor & Destructor Documentation

DocumentModelSegments() [1/3]

DocumentModelSegments::DocumentModelSegments

(

)

Default constructor.

Definition at line 24 of file DocumentModelSegments.cpp.

                                             :
  m_pointSeparation (DEFAULT_POINT_SEPARATION),
  m_minLength (DEFAULT_MIN_LENGTH),
  m_fillCorners (false),
  m_lineWidthActive (DEFAULT_LINE_WIDTH_ACTIVE),
  m_lineWidthInactive (DEFAULT_LINE_WIDTH_INACTIVE),  
  m_lineColor (DEFAULT_LINE_COLOR),
  m_inactiveOpacity (DEFAULT_INACTIVE_OPACITY)
{
}

DocumentModelSegments() [2/3]

DocumentModelSegments::DocumentModelSegments

(

const Document &

document

)

Initial constructor from Document.

Definition at line 35 of file DocumentModelSegments.cpp.

                                                                     :
  m_pointSeparation (document.modelSegments().pointSeparation()),
  m_minLength (document.modelSegments().minLength()),
  m_fillCorners (document.modelSegments().fillCorners()),
  m_lineWidthActive (document.modelSegments().lineWidthActive()),
  m_lineWidthInactive (document.modelSegments().lineWidthInactive()),  
  m_lineColor (document.modelSegments().lineColor()),
  m_inactiveOpacity (document.modelSegments().inactiveOpacity())
{
}

DocumentModelSegments() [3/3]

DocumentModelSegments::DocumentModelSegments

(

const DocumentModelSegments &

other

)

Copy constructor.

Definition at line 46 of file DocumentModelSegments.cpp.

                                                                               :
  m_pointSeparation (other.pointSeparation()),
  m_minLength (other.minLength()),
  m_fillCorners (other.fillCorners ()),
  m_lineWidthActive (other.lineWidthActive()),
  m_lineWidthInactive (other.lineWidthInactive()),  
  m_lineColor (other.lineColor()),
  m_inactiveOpacity (other.inactiveOpacity())
{
}

Member Function Documentation

fillCorners()

bool DocumentModelSegments::fillCorners

(

)

const

Get method for fill corners.

Definition at line 70 of file DocumentModelSegments.cpp.

{
  return m_fillCorners;
}

inactiveOpacity()

InactiveOpacity DocumentModelSegments::inactiveOpacity

(

)

const

Get method for inactive opacity.

Definition at line 75 of file DocumentModelSegments.cpp.

{
  return m_inactiveOpacity;
}

lineColor()

ColorPalette DocumentModelSegments::lineColor

(

)

const

Get method for line color.

Definition at line 80 of file DocumentModelSegments.cpp.

{
  return m_lineColor;
}

lineWidthActive()

double DocumentModelSegments::lineWidthActive

(

)

const

Get method for line width when active.

Definition at line 85 of file DocumentModelSegments.cpp.

{
  return m_lineWidthActive;
}

lineWidthInactive()

double DocumentModelSegments::lineWidthInactive

(

)

const

Get method for line width when inactive.

Definition at line 90 of file DocumentModelSegments.cpp.

{
  return m_lineWidthInactive;
}

loadXml()

void DocumentModelSegments::loadXml ( QXmlStreamReader & reader )

virtual

Load model from serialized xml.

Implements DocumentModelAbstractBase.

Definition at line 95 of file DocumentModelSegments.cpp.

{
  LOG4CPP_INFO_S ((*mainCat)) << "DocumentModelSegments::loadXml";
 
  bool success = true;
 
  QXmlStreamAttributes attributes = reader.attributes ();
 
  // Entries that are optional since they were removed in version 13
  //   DOCUMENT_SERIALIZE_SEGMENTS_LINE_WIDTH
  // Entries that are optional since they were added in version 13
  //   DOCUMENT_SERIALIZE_SEGMENTS_INACTIVE_OPACITY
  //   DOCUMENT_SERIALIZE_SEGMENTS_LINE_WIDTH_ACTIVE
  //   DOCUMENT_SERIALIZE_SEGMENTS_LINE_WIDTH_ACTIVE_STRING
  //   DOCUMENT_SERIALIZE_SEGMENTS_LINE_WIDTH_INACTIVE
  //   DOCUMENT_SERIALIZE_SEGMENTS_LINE_WIDTH_INACTIVE_STRING
  if (attributes.hasAttribute(DOCUMENT_SERIALIZE_SEGMENTS_POINT_SEPARATION) &&
      attributes.hasAttribute(DOCUMENT_SERIALIZE_SEGMENTS_MIN_LENGTH) &&
      attributes.hasAttribute(DOCUMENT_SERIALIZE_SEGMENTS_FILL_CORNERS) &&
      attributes.hasAttribute(DOCUMENT_SERIALIZE_SEGMENTS_LINE_WIDTH) &&
      attributes.hasAttribute(DOCUMENT_SERIALIZE_SEGMENTS_LINE_COLOR)) {
 
    // Boolean values
    QString fillCorners = attributes.value(DOCUMENT_SERIALIZE_SEGMENTS_FILL_CORNERS).toString();
 
    setPointSeparation (attributes.value (DOCUMENT_SERIALIZE_SEGMENTS_POINT_SEPARATION).toDouble());
    setMinLength (attributes.value (DOCUMENT_SERIALIZE_SEGMENTS_MIN_LENGTH).toDouble());
    setFillCorners (fillCorners == DOCUMENT_SERIALIZE_BOOL_TRUE);
    setLineColor (static_cast<ColorPalette> (attributes.value (DOCUMENT_SERIALIZE_SEGMENTS_LINE_COLOR).toInt()));
    
    if (attributes.hasAttribute (DOCUMENT_SERIALIZE_SEGMENTS_INACTIVE_OPACITY)) {
      setInactiveOpacity (static_cast<InactiveOpacity>  (attributes.value (DOCUMENT_SERIALIZE_SEGMENTS_INACTIVE_OPACITY).toInt ()));
    } else{
      setInactiveOpacity (DEFAULT_INACTIVE_OPACITY);
    }
    
    // For line widths, first look for single value (corresponding to versions before 13), then look
    // for two values (corresponding to version 13+)
    int lineWidthActive = DEFAULT_LINE_WIDTH_ACTIVE;
    int lineWidthInactive = DEFAULT_LINE_WIDTH_INACTIVE;    
    if (attributes.hasAttribute (DOCUMENT_SERIALIZE_SEGMENTS_LINE_WIDTH)) {
      lineWidthActive = attributes.value (DOCUMENT_SERIALIZE_SEGMENTS_LINE_WIDTH).toInt ();
      lineWidthInactive = attributes.value (DOCUMENT_SERIALIZE_SEGMENTS_LINE_WIDTH).toInt ();      
    } else if (attributes.hasAttribute (DOCUMENT_SERIALIZE_SEGMENTS_LINE_WIDTH_ACTIVE) &&
               attributes.hasAttribute (DOCUMENT_SERIALIZE_SEGMENTS_LINE_WIDTH_INACTIVE)) {
      lineWidthActive = attributes.value (DOCUMENT_SERIALIZE_SEGMENTS_LINE_WIDTH_ACTIVE).toInt ();
      lineWidthInactive = attributes.value (DOCUMENT_SERIALIZE_SEGMENTS_LINE_WIDTH_INACTIVE).toInt ();      
    }
    setLineWidthActive (lineWidthActive);
    setLineWidthInactive (lineWidthInactive);
 
    // Read until end of this subtree
    while ((reader.tokenType() != QXmlStreamReader::EndElement) ||
    (reader.name() != DOCUMENT_SERIALIZE_SEGMENTS)){
      loadNextFromReader(reader);
      if (reader.atEnd()) {
        success = false;
        break;
      }
    }
  }
 
  if (!success) {
    reader.raiseError(QObject::tr ("Cannot read segment data"));
  }
}

minLength()

double DocumentModelSegments::minLength

(

)

const

Get method for min length.

Definition at line 162 of file DocumentModelSegments.cpp.

{
  return m_minLength;
}

operator=()

DocumentModelSegments & DocumentModelSegments::operator=

(

const DocumentModelSegments &

other

)

Assignment constructor.

Definition at line 57 of file DocumentModelSegments.cpp.

{
  m_pointSeparation = other.pointSeparation();
  m_minLength = other.minLength();
  m_fillCorners = other.fillCorners ();
  m_lineWidthActive = other.lineWidthActive();
  m_lineWidthInactive = other.lineWidthInactive();  
  m_lineColor = other.lineColor();
  m_inactiveOpacity = other.inactiveOpacity();
 
  return *this;
}

pointSeparation()

double DocumentModelSegments::pointSeparation

(

)

const

Get method for point separation.

Definition at line 167 of file DocumentModelSegments.cpp.

{
  return m_pointSeparation;
}

printStream()

void DocumentModelSegments::printStream	(	QString	indentation,
		QTextStream &	str ) const

Debugging method that supports print method of this class and printStream method of some other class(es).

Definition at line 172 of file DocumentModelSegments.cpp.

{
  str << indentation << "DocumentModelSegments\n";
 
  indentation += INDENTATION_DELTA;
 
  str << indentation << "pointSeparation=" << m_pointSeparation << "\n";
  str << indentation << "minLength=" << m_minLength << "\n";
  str << indentation << "fillCorners=" << (m_fillCorners ? "true" : "false") << "\n";
  str << indentation << "lineWidthActive=" << m_lineWidthActive << "\n";
  str << indentation << "lineWidthInactive=" << m_lineWidthInactive << "\n";  
  str << indentation << "lineColor=" << colorPaletteToString (m_lineColor) << "\n";
  str << indentation << "inactiveOpacity=" << m_inactiveOpacity << "\n";
}

saveXml()

void DocumentModelSegments::saveXml ( QXmlStreamWriter & writer ) const

virtual

Save entire model as xml into stream.

Implements DocumentModelAbstractBase.

Definition at line 188 of file DocumentModelSegments.cpp.

{
  LOG4CPP_INFO_S ((*mainCat)) << "DocumentModelSegments::saveXml";
 
  writer.writeStartElement(DOCUMENT_SERIALIZE_SEGMENTS);
  writer.writeAttribute(DOCUMENT_SERIALIZE_SEGMENTS_POINT_SEPARATION, QString::number (m_pointSeparation));
  writer.writeAttribute(DOCUMENT_SERIALIZE_SEGMENTS_MIN_LENGTH, QString::number (m_minLength));
  writer.writeAttribute(DOCUMENT_SERIALIZE_SEGMENTS_FILL_CORNERS, m_fillCorners ?
                          DOCUMENT_SERIALIZE_BOOL_TRUE :
                          DOCUMENT_SERIALIZE_BOOL_FALSE);
  writer.writeAttribute(DOCUMENT_SERIALIZE_SEGMENTS_LINE_WIDTH_ACTIVE, QString::number (m_lineWidthActive));
  writer.writeAttribute(DOCUMENT_SERIALIZE_SEGMENTS_LINE_WIDTH_INACTIVE, QString::number (m_lineWidthInactive));  
  writer.writeAttribute(DOCUMENT_SERIALIZE_SEGMENTS_LINE_COLOR, QString::number (m_lineColor));
  writer.writeAttribute(DOCUMENT_SERIALIZE_SEGMENTS_LINE_COLOR_STRING, colorPaletteToString (m_lineColor));
  writer.writeAttribute(DOCUMENT_SERIALIZE_SEGMENTS_INACTIVE_OPACITY, QString::number (m_inactiveOpacity));
  writer.writeEndElement();
}

setFillCorners()

void DocumentModelSegments::setFillCorners

(

bool

fillCorners

)

Set method for fill corners.

Definition at line 206 of file DocumentModelSegments.cpp.

{
  m_fillCorners = fillCorners;
}

setInactiveOpacity()

void DocumentModelSegments::setInactiveOpacity

(

InactiveOpacity

inactiveOpacity

)

Set method for inactive opacity.

Definition at line 211 of file DocumentModelSegments.cpp.

{
  m_inactiveOpacity = inactiveOpacity;
}

setLineColor()

void DocumentModelSegments::setLineColor

(

ColorPalette

lineColor

)

Set method for line color.

Definition at line 216 of file DocumentModelSegments.cpp.

{
  m_lineColor = lineColor;
}

setLineWidthActive()

void DocumentModelSegments::setLineWidthActive

(

double

lineWidth

)

Set method for line width when active.

Definition at line 221 of file DocumentModelSegments.cpp.

{
  m_lineWidthActive = lineWidthActive;
}

setLineWidthInactive()

void DocumentModelSegments::setLineWidthInactive

(

double

lineWidth

)

Set method for line width when inactive.

Definition at line 226 of file DocumentModelSegments.cpp.

{
  m_lineWidthInactive = lineWidthInactive;
}

setMinLength()

void DocumentModelSegments::setMinLength

(

double

minLength

)

Set method for min length.

Definition at line 231 of file DocumentModelSegments.cpp.

{
  m_minLength = minLength;
}

setPointSeparation()

void DocumentModelSegments::setPointSeparation

(

double

pointSeparation

)

Set method for point separation.

Definition at line 236 of file DocumentModelSegments.cpp.

{
  m_pointSeparation = pointSeparation;
}

---

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

• Document/DocumentModelSegments.h
• Document/DocumentModelSegments.cpp