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

#include "OdBinaryData.h"

/** \details 
<group PRC_Datatypes_Classes> 

Class implements operations with user defined data. 
*/
class PRC_TOOLKIT OdPrcUserData
{
private:
  OdBitBinaryData m_bitData;

public:
  //DOM-IGNORE-BEGIN
  PRC_DECLARE_CIO(OdPrcUserData)
  //DOM-IGNORE-END

  /** \details
  Requests user-defined binary data.
  \returns An <exref target="https://docs.opendesign.com/tkernel/OdBitBinaryData.html">OdBitBinaryData</exref> object that contains the requested data.
  \remarks 
  The <exref target="https://docs.opendesign.com/tkernel/OdBitBinaryData.html">OdBitBinaryData</exref> object is returned via a reference, and therefore it can be used to set new user-defined binary data.
  To restrict modifications of the <exref target="https://docs.opendesign.com/tkernel/OdBitBinaryData.html">OdBitBinaryData</exref> object outside the <link OdPrcUserData, OdPrcUserData> object, 
  call another <link OdPrcUserData::bitData@const, bitData()> method that returns a constant reference.  
  */
  OdBitBinaryData &bitData();
  
  /** \details
  Requests user-defined binary data.
  \returns An <exref target="https://docs.opendesign.com/tkernel/OdBitBinaryData.html">OdBitBinaryData</exref> object that contains the requested data.
  */
  const OdBitBinaryData &bitData() const;
};

#endif // _PRCUSERDATA_INCLUDED_