IfcPsdQto.h

Go to the documentation of this file.

// Copyright (C) 2002-2024, 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-2024 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 _IFC_PSD_QTO_H
#define _IFC_PSD_QTO_H
 
#include "IfcBuildOptions.h"
#include "daiModel.h"
#include "OdArray.h"
 
class PSDQTOImpl;

class IFCCORETOOLS_EXPORT PSDQTO final
{
public:

  PSDQTO(const char* applicableVersion = nullptr);

  ~PSDQTO();

  OdDAI::SchemaPtr getSchema() const;

  OdDAI::ModelPtr getModel() const;

  const OdAnsiString& getName() const;

  const OdAnsiString& getComment() const;

  void setName(const OdAnsiString& value);

  void setComment(const OdAnsiString& value);

  void Clear();

  OdResult importFromXML(const char* fileName);

  OdResult exportToXML(const OdDAI::ApplicationInstance* psdqtoInstance, const char* fileName);

  bool getApplicablePSD(const OdDAI::ApplicationInstance* ifcInstance, OdDAIObjectIds& ids) const;

  bool getApplicableQTO(const OdDAI::ApplicationInstance* ifcInstance, OdDAIObjectIds& ids) const;

  bool getApplicable(const OdDAI::ApplicationInstance* ifcInstance, OdDAIObjectIds& ids) const;

  bool getApplicable(const char* applicableClassName, OdDAIObjectIds& ids) const;

  bool getApplicable(const OdDAI::Entity* ifcEntity, const char* predefinedType, OdDAIObjectIds& ids) const;

  bool isApplicablePSD(const OdDAI::ApplicationInstance* ifcInstance) const;

  bool isApplicableQTO(const OdDAI::ApplicationInstance* ifcInstance) const;

  OdResult readFile(const OdString& fileName);

  OdResult writeFile(const OdString& fileName);
 
private:
  PSDQTOImpl* m_pImpl;
};
 
typedef OdSharedPtr<PSDQTO> PSDQTOPtr;
 
/* PSDQTOList */
 
class IFCCORETOOLS_EXPORT PSDQTOList
{
public:
  using size_type = OdArray<PSDQTOPtr>::size_type;

  PSDQTOList();

  ~PSDQTOList();
 
  void clear();

  size_type length() const
  {
    return m_psdqto.length();
  }

  bool isEmpty() const
  {
    return m_psdqto.isEmpty();
  }

  PSDQTO* operator [](size_type index)
  {
    return m_psdqto[index].get();
  }

  const PSDQTO* operator [](size_type index) const
  {
    return m_psdqto[index].get();
  }

  PSDQTO* at(size_type index)
  {
    return m_psdqto.at(index).get();
  }

  const PSDQTO* at(size_type index) const
  {
    return m_psdqto.at(index).get();
  }

  void setAt(size_type index, PSDQTO* value)
  {
    m_psdqto.setAt(index, value);
  }

  const PSDQTO* getAt(size_type index) const
  {
    return m_psdqto.getAt(index).get();
  }
    
  size_type append(PSDQTO* value)
  {
    return m_psdqto.append(value);
  }

  void insertAt(size_type index, PSDQTO* value)
  {
    m_psdqto.insertAt(index, value);
  }

  void removeAt(size_type index)
  {
    m_psdqto.removeAt(index);
  }

  void swap(size_type firstIndex, size_type secondIndex)
  {
    m_psdqto.swap(firstIndex, secondIndex);
  }

  PSDQTO* loadFromFile(
    const OdString& fileName, 
    const char* name = nullptr,
    const char* comment = nullptr,
    const char* applicableVersion = nullptr);
 
private:
  OdArray<PSDQTOPtr> m_psdqto;
};

typedef OdSharedPtr<PSDQTOList> PSDQTOListPtr;
 
#endif //_IFC_PSD_QTO_H