/////////////////////////////////////////////////////////////////////////////// 
// 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.
///////////////////////////////////////////////////////////////////////////////

// StepRepresentation.h: interface for the OdStepRepresentation class.
//
//////////////////////////////////////////////////////////////////////

#ifndef _STEP_REPRESENTATION_H_
#define _STEP_REPRESENTATION_H_

#include "StepCachedCompound.h"

/** \details
Contains declarations related to working with STEP file content.
*/
namespace OdStep {

  /** \details
  A base class that implements an interface for working with product representations. 
  */
  class STEPGEOM_EXPORT OdStepRepresentation : public OdStepCachedCompound
  {
    ODRX_DECLARE_MEMBERS(OdStepRepresentation);

  public:
  
    /** \details 
    Composes the representation item object.
    */
    void compose() override;

    /** \details 
    Retrieves the representation identifier.
    \returns A string that contains the representation identifier.
    */
    OdString getName();
    
    /** \details 
    Retrieves the representation items context.
    \returns A <exref target="https://docs.opendesign.com/step_api_cpp/OdDAIObjectId.html>DAI identifier</exref> that refers to the items context object.
    */
    OdDAIObjectId getContextOfItems();
    
    /** \details 
    Retrieves the representation items.
    \returns An array of <exref target="https://docs.opendesign.com/step_api_cpp/OdDAIObjectId.html>DAI identifiers</exref>, which refer to the representation items.
    */
    const OdDAIObjectIds& getItems();

    /** \details
    Sets the values of the representation item's sub-entity traits.
    \param traits [out] A raw pointer to the traits to be filled and returned to a calling subroutine.
    \returns The result of the value setting.
    */
    OdUInt32 subSetAttributes(OdGiDrawableTraits* traits) const override;
  };

  /** \details
  A data type that represents a smart pointer to an <exref target="https://docs.opendesign.com/step_api_cpp/OdStep__OdStepRepresentation.html>OdStepRepresentation</exref> object.
  */
  SMARTPTR(OdStepRepresentation)
}

#endif // _STEP_REPRESENTATION_H_