GeopsyCore::AsciiSignalFormatComponent Class Reference

Brief description of class still missing. More...

#include <AsciiSignalFormatComponent.h>

Inheritance diagram for GeopsyCore::AsciiSignalFormatComponent:

List of all members.

Public Member Functions
	AsciiSignalFormatComponent ()
	AsciiSignalFormatComponent (const AsciiSignalFormatComponent &o)
Signal::Components	component () const
const QString &	pattern () const
void	setComponent (Signal::Components c)
void	setPattern (const QString &p)
virtual const QString &	xml_tagName () const
Static Public Attributes
static const QString	xmlComponentTag = "Component"
Protected Member Functions
virtual XMLMember	xml_member (XML_MEMBER_ARGS)
virtual bool	xml_setProperty (XML_SETPROPERTY_ARGS)
virtual void	xml_writeProperties (XML_WRITEPROPERTIES_ARGS) const

---

Detailed Description

Brief description of class still missing.

Full description of class still missing

---

Constructor & Destructor Documentation

GeopsyCore::AsciiSignalFormatComponent::AsciiSignalFormatComponent

(

)

Constructs a basic rule: for all channels, not constant, mandatory, empty pattern, pattern index set to 1, not multiplication factor.

References GeopsyCore::Signal::UndefinedComponent.

{
  _component=Signal::UndefinedComponent;
}

GeopsyCore::AsciiSignalFormatComponent::AsciiSignalFormatComponent

(

const AsciiSignalFormatComponent &

o

)

Copy constructor

    : XMLClass()
{
  _pattern=o._pattern;
  _component=o._component;
}

---

Member Function Documentation

Signal::Components GeopsyCore::AsciiSignalFormatComponent::component

(

)

const [inline]

{return _component;}

const QString& GeopsyCore::AsciiSignalFormatComponent::pattern

(

)

const [inline]

{return _pattern;}

void GeopsyCore::AsciiSignalFormatComponent::setComponent

(

Signal::Components

c

)

[inline]

{_component=c;}

void GeopsyCore::AsciiSignalFormatComponent::setPattern

(

const QString &

p

)

[inline]

{_pattern=p;}

XMLMember GeopsyCore::AsciiSignalFormatComponent::xml_member

(

XML_MEMBER_ARGS

)

[protected, virtual]

Re-implement this function to offer XML restore (children and properties) support to your class.

From tag and map (with contains the attibute value) return a unique identifier under the format of a XMLMember. XMLMember is initialized with 3 types of contructors:

• An integer: id number of a property
• A XMLClass * : a child of this object identified by tag
• Default constructor: error, unknow child or property

Map of attributes can be inspected in this way (can be achived also in xml_setProperty()):

    static const QString tmp("childrenName");
    XMLRestoreAttributeIterator it=map.find(tmp);
    if(it!=map.end()) {
      // found attribute "childrenName"
    }

If the map of attributes is not used:

    Q_UNUSED(attributes);
    if(tag=="x1") return XMLMember(0);
    else if(tag=="y1") return XMLMember(1);
    else if(tag=="x2") return XMLMember(2);
    else if(tag=="y2") return XMLMember(3);
    else return XMLMember(XMLMember::Unknown);

Arithmetic operations + and - apply to XMLMember to avoid confusion of property id numbers between inherited objects. Offset 3 corresponds to the number of properties defined in this object.

    if(tag=="anInteger") return XMLMember(0);
    else if(tag=="aString") return XMLMember(1);
    else if(tag=="aDouble") return XMLMember(2);
    return AbstractLine::xml_member(tag, attributes, context)+3;

For the arguments of this function use Macro XML_MEMBER_ARGS.

Reimplemented from QGpCoreTools::XMLClass.

References TRACE.

{
  TRACE;
  Q_UNUSED(context);
  Q_UNUSED(attributes);
  if(tag=="pattern" ) return XMLMember(0);
  else if(tag=="component" ) return XMLMember(1);
  else return XMLMember(XMLMember::Unknown);
}

bool GeopsyCore::AsciiSignalFormatComponent::xml_setProperty

(

XML_SETPROPERTY_ARGS

)

[protected, virtual]

Re-implement this function to offer XML restore properties support to your class.

From memberID set the corresponding property with value content. The map of attributes is given as a supplementary information (not useful in all cases).

For a general case:

  Q_UNUSED(attributes);
  double val=content.toDouble();
  switch (memberID) {
  case 0:
    _x1=val;
    return true;
  case 1:
    _y1=val;
    return true;
  case 2:
    _x2=val;
    return true;
  case 3:
    _y2=val;
    return true;
  default:
    return false;
  }

For classes inheriting other classes (see also xml_member())

  switch (memberID) {
  case 0:
    _anInteger=content.toString();
    return true;
  case 1:
    _aString=content.toInt();
    return true;
  case 2:
    _aDouble=content.toDouble();
    return true;
  default:
    return AbstractLine::xml_setProperty(memberID-3, map, content);

For the arguments of this function use Macro XML_SETPROPERTY_ARGS.

Reimplemented from QGpCoreTools::XMLClass.

References GeopsyCore::Signal::standardComponent(), and TRACE.

{
  TRACE;
  Q_UNUSED(tag);
  Q_UNUSED(context);
  Q_UNUSED(attributes);
  switch (memberID) {
  case 0: _pattern=content.toString(); return true;
  case 1: _component=Signal::standardComponent(content.toString()); return true;
  default:
    break;
  }
  return false;
}

virtual const QString& GeopsyCore::AsciiSignalFormatComponent::xml_tagName

(

)

const [inline, virtual]

Implements QGpCoreTools::XMLClass.

{return xmlComponentTag;}

void GeopsyCore::AsciiSignalFormatComponent::xml_writeProperties

(

XML_WRITEPROPERTIES_ARGS

)

const [protected, virtual]

Reimplemented from QGpCoreTools::XMLClass.

References GeopsyCore::Signal::standardName(), TRACE, and QGpCoreTools::XMLClass::writeProperty().

{
  TRACE;
  Q_UNUSED(context);
  writeProperty(s, "pattern", _pattern);
  writeProperty(s, "component", Signal::standardName(_component));
}

---

Member Data Documentation

const QString GeopsyCore::AsciiSignalFormatComponent::xmlComponentTag = "Component" [static]

Referenced by GeopsyCore::AsciiSignalFormat::xml_member().

---

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

• GeopsyCore/AsciiSignalFormatComponent.h
• GeopsyCore/AsciiSignalFormatComponent.cpp