/////////////////////////////////////////////////////////////////////////////// 
// 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 __TNW_BINARYATTRIBUTE_H__
#define __TNW_BINARYATTRIBUTE_H__

#include "NwAttribute.h"

class OdBinaryData;

class OdNwBinaryAttribute;

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

/** \details
  This class represents an attribute with binary data object.

  <group OdNw_Classes>
*/
class NWDBEXPORT OdNwBinaryAttribute : public OdNwAttribute
{
  //DOM-IGNORE-BEGIN
  ODRX_DECLARE_MEMBERS(OdNwBinaryAttribute);
  //DOM-IGNORE-END

public:
  /** \details
    Default constructor. Creates a new object of the OdNwBinaryAttribute
    class.
  */
  OdNwBinaryAttribute();

  /** \details
    Constructor for objects of the OdNwBinaryAttribute class. Creates a new
    OdNwBinaryAttribute object for the specified item.

    \param pImpl [in] Item to create am OdNwBinaryAttribute object for.
  */
  explicit OdNwBinaryAttribute(OdNwObjectImpl* pImpl);

public:
  /** \details
    Virtual destructor. Frees allocated resources.
  */
  virtual ~OdNwBinaryAttribute();

public:
  /** \details
  Gets the binary data of the attribute.

  \param aBinData [out] OdBinaryData with attribute's data.

  \returns eOk if the operation is successful, or an appropriate error code otherwise.
*/
  OdResult getData(OdBinaryData& aBinData) const;

  /** \details
    Creates binary attribute object.

    \param aBinData [in] binary data value for the attribute.

    \returns Smart pointer to the OdNwBinaryAttribute object, or an empty
    smart pointer if creation fails.
  */
  static OdNwBinaryAttributePtr createObject(const OdBinaryData& aBinData);
};

#endif //__TNW_BINARYATTRIBUTE_H__