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

#include "daiSectionItem.h"
#include <SharedPtr.h>
#include <daiUtils/daiUnset.h>

#include "TD_PackPush.h"

/** \details
Implements the Data Access Interface (DAI) that provides functionality for manipulating data that is defined within the EXPRESS SCHEMA format.
*/
namespace OdDAI {

  class Select;
  class Boolean;
  class Logical;
  class Aggr;
  class Select;
  class AttributeDataBlock;
  class Enum;
  class Anchor;
  class Number;
  class Binary;
  struct EnumValueInfo;

  /** \details 
  A data type that represents a smart pointer to an <link OdDAI::Anchor, Anchor> object.
  */
  using AnchorPtr = OdSharedPtr<Anchor>;
  
  /** \details 
  A data type that represents an <link OdDAI::Anchor, Anchor> section represented with a <link OdDAI::SimpleSectionBase@classTItem, SimpleSectionBase> class instance.
  */
  using AnchorSection = SimpleSectionBase<Anchor>;

  /** \details
  The class that implements working with anchor objects.
  */
  class DAI_EXPORT Anchor
    : public SectionItem<AnchorSection>
  {
    friend class SimpleSectionBase<Anchor>;
  public:

    using SectionItem::getValue;
    using SectionItem::setValue;


    /** \details
    Sets a new integer value for the Anchor instance.
    \param newValue [in] An integer value to be set.
    */
    void setTypedValue(int newValue);
    
    /** \details
    Retrieves the integer value of the Anchor instance.
    \param valueToGet [out] A placeholder for the requested value.
    \returns true if the anchor value was successfully converted to the integer data type; otherwise, the method returns false.
    */
    bool getTypedValue(int& valueToGet) const;

    /** \details
    Sets a new double value for the Anchor instance.
    \param newValue [in] A double value to be set.
    */
    void setTypedValue(double newValue);

    /** \details
    Retrieves the double value of the Anchor instance.
    \param valueToGet [out] A placeholder for the requested value.
    \returns true if the anchor value was successfully converted to the double data type; otherwise, the method returns false.
    */
    bool getTypedValue(double& valueToGet) const;

    /** \details
    Sets a new <link OdDAI::Boolean, Boolean> value for the Anchor instance.
    \param newValue [in] A <link OdDAI::Boolean, Boolean> value to be set.
    */
    void setTypedValue(const Boolean& newValue);

    /** \details
    Retrieves the <link OdDAI::Boolean, Boolean> value of the Anchor instance.
    \param valueToGet [out] A placeholder for the requested value.
    \returns true if the anchor value was successfully converted to the <link OdDAI::Boolean, Boolean> data type; otherwise, the method returns false.
    */
    bool getTypedValue(Boolean& valueToGet) const;

    /** \details
    Sets a new <link OdDAI::Logical, Logical> value for the Anchor instance.
    \param newValue [in] A <link OdDAI::Logical, Logical> value to be set.
    */
    void setTypedValue(const Logical& newValue);

    /** \details
    Retrieves the <link OdDAI::Logical, Logical> value of the Anchor instance.
    \param valueToGet [out] A placeholder for the requested value.
    \returns true if the anchor value was successfully converted to the <link OdDAI::Logical, Logical> data type; otherwise, the method returns false.
    */
    bool getTypedValue(Logical& valueToGet) const;

    /** \details
    Sets a new <exref target="../tkernel_api_cpp/OdAnsiString.html">OdAnsiString</exref> value for the Anchor instance.
    \param newValue [in] An <exref target="../tkernel_api_cpp/OdAnsiString.html">OdAnsiString</exref> value to be set.
    */
    void setTypedValue(const OdAnsiString& newValue);

    /** \details
    Retrieves the <exref target="../tkernel_api_cpp/OdAnsiString.html">OdAnsiString</exref> value of the Anchor instance.
    \param valueToGet [out] A placeholder for the requested value.
    \returns true if the anchor value was successfully converted to the <exref target="../tkernel_api_cpp/OdAnsiString.html">OdAnsiString</exref> data type; otherwise, the method returns false.
    */
    bool getTypedValue(OdAnsiString& valueToGet) const;

    /** \details
    Sets a new <link OdDAIObjectId, OdDAIObjectId> value for the Anchor instance.
    \param newValue [in] A <link OdDAIObjectId, OdDAIObjectId> value to be set.
    */
    void setTypedValue(const OdDAIObjectId& newValue);

    /** \details
    Retrieves the <link OdDAIObjectId, OdDAIObjectId> value of the Anchor instance.
    \param valueToGet [out] A placeholder for the requested value.
    \returns true if the anchor value was successfully converted to the <link OdDAIObjectId, OdDAIObjectId> data type; otherwise, the method returns false.
    */
    bool getTypedValue(OdDAIObjectId& valueToGet) const;

    /** \details
    Sets a new value of the Anchor instance represented with a pointer to an <link OdDAI::Aggr, Aggr> object.
    \param newValue [in] An <link OdDAI::Aggr, Aggr> object to be set.
    */
    void setTypedValue(const OdDAI::Aggr* newValue);

    /** \details
    Retrieves the Anchor instance represented with a pointer to an <link OdDAI::Aggr, Aggr> object.
    \param valueToGet [out] A placeholder for the requested value.
    \returns true if the anchor value was successfully converted to a pointer to an <link OdDAI::Aggr, Aggr> object; otherwise, the method returns false.
    */
    bool getTypedValue(OdDAI::Aggr* valueToGet) const;

    /** \details
    Sets a new <link OdDAI::AttributeDataBlock, AttributeDataBlock> value for the Anchor instance.
    \param newValue [in] A <link OdDAI::AttributeDataBlock, AttributeDataBlock> value to be set.
    */
    void setTypedValue(const OdDAI::AttributeDataBlock& newValue);

    /** \details
    Retrieves the <link OdDAI::AttributeDataBlock, AttributeDataBlock> value of the Anchor instance.
    \param valueToGet [out] A placeholder for the requested value.
    \returns true if the anchor value was successfully converted to the <link OdDAI::AttributeDataBlock, AttributeDataBlock> data type; otherwise, the method returns false.
    */
    bool getTypedValue(OdDAI::AttributeDataBlock& valueToGet) const;

    /** \details
    Sets a new <link OdDAI::EnumValueInfo, EnumValueInfo> value for the Anchor instance.
    \param newValue [in] A <link OdDAI::EnumValueInfo, EnumValueInfo> value to be set.
    */
    void setTypedValue(const OdDAI::EnumValueInfo& newValue);

    /** \details
    Retrieves the <link OdDAI::EnumValueInfo, EnumValueInfo> value of the Anchor instance.
    \param valueToGet [out] A placeholder for the requested value.
    \returns true if the anchor value was successfully converted to the <link OdDAI::EnumValueInfo, EnumValueInfo> data type; otherwise, the method returns false.
    */
    bool getTypedValue(OdDAI::EnumValueInfo& valueToGet) const;

    /** \details
    Sets a new <link OdDAI::Number, Number> value for the Anchor instance.
    \param newValue [in] A <link OdDAI::Number, Number> value to be set.
    */
    void setTypedValue(const Number& newValue);

    /** \details
    Retrieves the <link OdDAI::Number, Number> value of the Anchor instance.
    \param valueToGet [out] A placeholder for the requested value.
    \returns true if the anchor value was successfully converted to the <link OdDAI::Number, Number> data type; otherwise, the method returns false.
    */
    bool getTypedValue(Number& valueToGet) const;

    /** \details
    Sets a new <link OdDAI::Binary, Binary> value for the Anchor instance.
    \param newValue [in] A <link OdDAI::Binary, Binary> value to be set.
    */
    void setTypedValue(const Binary& newValue);

    /** \details
    Retrieves the <link OdDAI::Binary, Binary> value of the Anchor instance.
    \param valueToGet [out] A placeholder for the requested value.
    \returns true if the anchor value was successfully converted to the <link OdDAI::Binary, Binary> data type; otherwise, the method returns false.
    */
    bool getTypedValue(Binary& valueToGet) const;

  protected:
    Anchor(const OdAnsiString& name, const OdAnsiString& value, AnchorSection* section);

  };

}

#include "TD_PackPop.h"

#endif // _DAI_ANCHOR_H