///////////////////////////////////////////////////////////////////////////////
// Copyright (C) 2002-2025, 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 Open Design Alliance software pursuant to a license
//   agreement with Open Design Alliance.
//   Open Design Alliance Copyright (C) 2002-2025 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 __NW_TIME_LINER_FIELD_H__
#define __NW_TIME_LINER_FIELD_H__

#include "NwObject.h"

/**
 This class represents timeliner data source field.
 
 <group OdNw_Classes>
*/
class NWDBEXPORT OdNwTimeLinerField : public OdNwObject
{
  //DOM-IGNORE-BEGIN
  ODRX_DECLARE_MEMBERS(OdNwTimeLinerField);
  //DOM-IGNORE-END
public:
  /** \details
    Default constructor.
  */
  OdNwTimeLinerField();

  /** \details
    Virtual destructor. Frees allocated resources.
  */
  virtual ~OdNwTimeLinerField();

  /** \details
    Returns the identifier used by the data source provider.
   
    \returns Identifier as an OdString value.
  */
  OdString getId() const;

  /** \details
    Returns the display name used when displaying field in the UI.
   
    \returns The displaying name as an OdString value.
  */
  OdString getName() const;
};

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

/** \details
  This template class is a specialization of the OdArray class for OdNwTimeLinerFieldPtr array.
*/
typedef OdArray<OdNwTimeLinerFieldPtr> OdNwTimeLinerFieldListType;

#endif /* __NW_TIME_LINER_FIELD_H__ */