/////////////////////////////////////////////////////////////////////////////// 
// Copyright (C) 2002-2016, Open Design Alliance (the "Alliance"). 
// All rights reserved. 
// 
// This software and its documentation and related materials are owned by 
// the Alliance. The software may only be incorporated into application 
// programs owned by members of the Alliance, subject to a signed 
// Membership Agreement and Supplemental Software License Agreement with the
// Alliance. The structure and organization of this software are the valuable  
// trade secrets of the Alliance and its suppliers. The software is also 
// protected by copyright law and international treaty provisions. Application  
// programs incorporating this software must include the following statement 
// with their copyright notices:
//   
//   This application incorporates Teigha(R) software pursuant to a license 
//   agreement with Open Design Alliance.
//   Teigha(R) Copyright (C) 2002-2016 by Open Design Alliance. 
//   All rights reserved.
//
// By use of this software, its documentation or related materials, you 
// acknowledge and accept the above terms.
///////////////////////////////////////////////////////////////////////////////

#ifndef ODDGNLS_DBLSCOMPOUNDCOMPONENT_H
#define ODDGNLS_DBLSCOMPOUNDCOMPONENT_H

#include "DbLSComponent.h"

#include "TD_PackPush.h"

/** \details
    Dgn Line Style Compound Component.
    \sa
    TD_Db
    <group OdDbLS_Classes> 
*/
class ODDGNLS_EXPORT OdDbLSCompoundComponent : public OdDbLSComponent
{
  public:
    ODDB_DECLARE_MEMBERS(OdDbLSCompoundComponent);

    OdDbLSCompoundComponent();

    /** \details
      Append new component to compound component.

      \param comId [in]  Identifier of component to add.
      \param compOffset [in]  Component offset to add.
    */
    void appendComponent(const OdDbObjectId &compId, double compOffset = 0.0);
    /** \details
      Remove existing component from this compound component.

      \param nComponent [in]  Index of component to remove.
    */
    void deleteComponent(OdUInt32 nComponent);

    /** \details
      Returns count of components in this compound component.
    */
    OdUInt32 numberComponents() const;

    /** \details
      Returns component identifier from this compound component.

      \param nComponent [in]  Index of component to retreive identifier.
    */
    OdDbObjectId component(OdUInt32 nComponent) const;

    /** \details
      Returns component offset from this compound component.

      \param nComponent [in]  Index of component to retreive offset.
    */
    double offsetToComponent(OdUInt32 nComponent) const;
    /** \details
      Reset component offset of existing component in this compound component.

      \param nComponent [in]  Index of component to reset offset.
      \param newOffset [in]  New component offset.
    */
    void setOffsetToComponent(OdUInt32 nComponent, double newOffset);
};

/** \details
    This template class is a specialization of the OdSmartPtr class for OdDbLSCompoundComponent object pointers.
*/
typedef OdSmartPtr<OdDbLSCompoundComponent> OdDbLSCompoundComponentPtr;

#include "TD_PackPop.h"

#endif // ODDGNLS_DBLSCOMPOUNDCOMPONENT_H