MvdXmlEntityRule.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.
 
#if !defined(ODA_ODMVDXMLENTITYRULE_H_INCLUDED_)
#define ODA_ODMVDXMLENTITYRULE_H_INCLUDED_
 
#if _MSC_VER > 1000
#pragma once
#endif // _MSC_VER > 1000
 
#include "IfcEntity.h"
#include "MvdXmlRule.h"
#include "MvdXmlTemplateRef.h"

namespace OdMvdXml
{
  SMARTPTR(OdMvdXmlEntityRule);
  SMARTPTR(OdMvdXmlAttributeRule);
  SMARTPTR(OdMvdXmlConceptTemplate);

  class MVDXML_EXPORT OdMvdXmlEntityRule : public OdMvdXmlRule
  {
    ODRX_DECLARE_MEMBERS(OdMvdXmlEntityRule);
 
  public:
    const OdAnsiString& getEntityName() const { return m_entityName; };
    
    void setEntityName(const OdAnsiString &value) { m_entityName = value; };
    
    const OdAnsiString& getRuleID() const { return m_ruleID; };
    
    void setRuleID(const OdAnsiString &value) { m_ruleID = value; };
    
    const OdString& getDescription() const { return m_description; };
    
    void setDescription(const OdString &value) { m_description = value; };
    
    const OdMvdXmlTemplateRefPtr getTemplateRef() { return m_pTemplateRef; };
    
    void setTemplateRef(OdMvdXmlTemplateRefPtr value) { m_pTemplateRef = value; };
    
    const OdMvdXmlAttributeRulePtrArray& getEntityRules() const { return m_rules; };

    OdMvdXmlAttributeRule* getAttributeRuleByID(const char* ruleId);
    
    OdMvdXmlEntityRule* getEntityRuleByID(const char* ruleId);
    
    OdMvdXmlRule* getRuleByID(const char* ruleId);
    
    OdResult execute(const OdMvdXmlConceptTemplate* pTemplate, bool& result) const;

    OdMvdXmlEntityRule& operator=(const OdMvdXmlEntityRule& other);
 
  protected:
    void assign(const OdMvdXmlEntityRule* other);

    virtual OdAnsiString getElementName();

    virtual OdResult inAttributes(TiXmlElement* pItem) override;

    virtual OdResult inChildNode(const char *nodeName, TiXmlElement* pChild) override;

    virtual OdResult outAttributes(TiXmlElement* pItem) override;

    virtual OdResult outChildNodes(TiXmlNode* pParent) override;

    virtual OdResult doCheckInstance(const OdDAI::ApplicationInstance* pInstance, bool& result) override;

    virtual void doCleanInstance() override;
 
  private:
    OdAnsiString m_entityName;
    OdMvdXmlTemplateRefPtr m_pTemplateRef;
    OdMvdXmlAttributeRulePtrArray m_rules;
  }; 
}
 
#endif // !defined(ODA_ODMVDXMLENTITYRULE_H_INCLUDED_)