/*
 *
 *  Copyright (C) 2010-2024, OFFIS e.V.
 *  All rights reserved.  See COPYRIGHT file for details.
 *
 *  This software and supporting documentation were developed by
 *
 *    OFFIS e.V.
 *    R&D Division Health
 *    Escherweg 2
 *    D-26121 Oldenburg, Germany
 *
 *
 *  Module: dcmsr
 *
 *  Author: Joerg Riesmeier
 *
 *  Purpose:
 *    classes: DSRGraphicData3DItem, DSRGraphicData3DList
 *
 */


#ifndef DSRSC3GR_H
#define DSRSC3GR_H

#include "dcmtk/config/osconfig.h"   /* make sure OS specific configuration is included first */

#include "dcmtk/dcmsr/dsrtypes.h"
#include "dcmtk/dcmsr/dsrtlist.h"


// include this file in doxygen documentation

/** @file dsrsc3gr.h
 *  @brief definitions for class DSRGraphicData3DItem
 */


/*---------------------*
 *  class declaration  *
 *---------------------*/

/** Class for graphic data (3D) items
 */
class DCMTK_DCMSR_EXPORT DSRGraphicData3DItem
{
  public:

    /** (default) constructor
     ** @param  x  optional x value
     *  @param  y  optional y value
     *  @param  z  optional z value
     */
    DSRGraphicData3DItem(const Float32 x = 0,
                         const Float32 y = 0,
                         const Float32 z = 0)
      : XCoord(x),
        YCoord(y),
        ZCoord(z)
    {
    }

    /** check whether items are "equal"
     ** @param  item  item with which the (x,y,z) triplet should be compared
     ** @return OFTrue if both triplets are equal, OFFalse otherwise
     */
    inline OFBool isEqual(const DSRGraphicData3DItem &item) const
    {
        return (item.XCoord == XCoord) && (item.YCoord == YCoord) && (item.ZCoord == ZCoord);
    }

    /** check whether items are "not equal"
     ** @param  item  item with which the (x,y,z) triplet should be compared
     ** @return OFTrue if not equal, OFFalse if equal
     */
    inline OFBool isNotEqual(const DSRGraphicData3DItem &item) const
    {
        return (item.XCoord != XCoord) || (item.YCoord != YCoord) || (item.ZCoord != ZCoord);
    }

    /* copy constructor and assignment operator are defined implicitly */

    /// x value (VR=FL)
    Float32 XCoord;
    /// y value (VR=FL)
    Float32 YCoord;
    /// z value (VR=FL)
    Float32 ZCoord;
};


/** Class for graphic data (3D) lists
 */
class DCMTK_DCMSR_EXPORT DSRGraphicData3DList
  : public DSRListOfItems<DSRGraphicData3DItem>
{

  public:

    /** default constructor
     */
    DSRGraphicData3DList();

    /** copy constructor
     ** @param  lst  list to be copied
     */
    DSRGraphicData3DList(const DSRGraphicData3DList &lst);

    /** destructor
     */
    virtual ~DSRGraphicData3DList();

    /** assignment operator
     ** @param  lst  list to be copied
     ** @return reference to this list after 'lst' has been copied
     */
    DSRGraphicData3DList &operator=(const DSRGraphicData3DList &lst);

    /** print list of graphic data.
     *  The output of a typical list looks like this: 0/0/0,127/127/127,255/255/255
     ** @param  stream            output stream to which the list should be printed
     *  @param  flags             flag used to customize the output (see DSRTypes::PF_xxx)
     *  @param  tripletSeparator  character specifying the separator between the value triplets
     *  @param  itemSeparator     character specifying the separator between the list items
     ** @return status, EC_Normal if successful, an error code otherwise
     */
    OFCondition print(STD_NAMESPACE ostream &stream,
                      const size_t flags = 0,
                      const char tripletSeparator = '/',
                      const char itemSeparator = ',') const;

    /** read list of graphic data
     ** @param  dataset  DICOM dataset from which the list should be read
     *  @param  flags    flag used to customize the reading process (see DSRTypes::RF_xxx)
     ** @return status, EC_Normal if successful, an error code otherwise
     */
    OFCondition read(DcmItem &dataset,
                     const size_t flags);

    /** write list of graphic data
     ** @param  dataset  DICOM dataset to which the list should be written
     ** @return status, EC_Normal if successful, an error code otherwise
     */
    OFCondition write(DcmItem &dataset) const;

    /** get reference to the specified item
     ** @param  idx  index of the item to be returned (starting from 1)
     ** @return reference to the specified item if successful, EmptyItem otherwise
     */
    const DSRGraphicData3DItem &getItem(const size_t idx) const;

    /** get copy of the specified value triplet
     ** @param  idx  index of the value triplet to be returned (starting from 1)
     *  @param  x    x value of the specified index (set to 0 first)
     *  @param  y    y value of the specified index (set to 0 first)
     *  @param  z    z value of the specified index (set to 0 first)
     ** @return status, EC_Normal if successful, an error code otherwise
     */
    OFCondition getItem(const size_t idx,
                        Float32 &x,
                        Float32 &y,
                        Float32 &z) const;

    /** add value triplet to the list
     ** @param  x  x value to be added
     *  @param  y  y value to be added
     *  @param  z  z value to be added
     */
    void addItem(const Float32 x,
                 const Float32 y,
                 const Float32 z);

    /** put list of graphic data as a string.
     *  This function expects the same input format as created by print(), i.e. a comma
     *  separated list of numerical value triplets.
     ** @param  stringValue  string value to be set
     ** @return status, EC_Normal if successful, an error code otherwise
     */
    OFCondition putString(const char *stringValue);
};


/*------------------------*
 *  comparison operators  *
 *------------------------*/

/** equality operator.
 *  Internally, the DSRGraphicData3DItem::isEqual() method is used.
 *  @param  lhs  left-hand side
 *  @param  rhs  right-hand side
 *  @return OFTrue if 'lhs' and 'rhs' are equal, OFFalse otherwise
 */
DCMTK_DCMSR_EXPORT OFBool operator==(const DSRGraphicData3DItem &lhs,
                                     const DSRGraphicData3DItem &rhs);

/** inequality operator.
 *  Internally, the DSRGraphicData3DItem::isNotEqual() method is used.
 *  @param  lhs  left-hand side
 *  @param  rhs  right-hand side
 *  @return OFTrue if 'lhs' and 'rhs' are not equal, OFFalse otherwise
 */
DCMTK_DCMSR_EXPORT OFBool operator!=(const DSRGraphicData3DItem &lhs,
                                     const DSRGraphicData3DItem &rhs);


#endif
