MvdXmlConceptTemplate.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_ODMVDXMLCONCEPTTEMPLATE_H_INCLUDED_)
#define ODA_ODMVDXMLCONCEPTTEMPLATE_H_INCLUDED_
 
#if _MSC_VER > 1000
#pragma once
#endif // _MSC_VER > 1000
 
#include "StringArray.h"
#include "IfcEntity.h"
#include "MvdXmlRule.h"
#include "MvdXmlIdentity.h"

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

  class MVDXML_EXPORT OdMvdXmlConceptTemplate : public OdMvdXmlIdentityDefinitions
  {
    ODRX_DECLARE_MEMBERS(OdMvdXmlConceptTemplate);
 
  public:
    OdMvdXmlConceptTemplate();

    const OdAnsiString& getApplicableSchema() const { return m_applicableSchema; };
    
    void setApplicableSchema(const OdAnsiString &value) { m_applicableSchema = value; };
    
    OdAnsiString& getApplicableEntity() { return m_applicableEntities; };
    
    void setApplicableEntity(const OdAnsiString& value) { m_applicableEntities = value; };
    
    const bool getIsPartial() const { return m_isPartial; };
    
    void setIsPartial(const bool value) { m_isPartial = value; };

    const OdMvdXmlAttributeRulePtrArray& getRules() const { return m_rules; };
    
    const OdMvdXmlConceptTemplatePtrArray& getSubTemplates() const { return m_subTemplates; };

    OdMvdXmlAttributeRule* getAttributeRuleByID(const char* ruleId);
    
    OdMvdXmlEntityRule* getEntityRuleByID(const char* ruleId);
        
    OdMvdXmlRule* getRuleByID(const char* ruleId);

    OdResult checkInstance(const OdDAI::ApplicationInstance* pInstance, bool& result) const;

    void cleanInstance();

    OdMvdXmlConceptTemplate& operator=(const OdMvdXmlConceptTemplate& other);
 
  protected:
    void assign(const OdMvdXmlConceptTemplate* 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;
 
  private:
    // TODO: In future change to OdStringArray
    OdAnsiString                    m_applicableSchema;

    OdAnsiString                    m_applicableEntities;

    bool                            m_isPartial;

    OdMvdXmlConceptTemplatePtrArray m_subTemplates;

    OdMvdXmlAttributeRulePtrArray   m_rules;
  };
}
 
#endif // !defined(ODA_ODMVDXMLCONCEPTTEMPLATE_H_INCLUDED_)