dtk_override.hpp

Go to the documentation of this file.

#ifndef __UTIL_DTK_OVERRIDE_HPP__
#define __UTIL_DTK_OVERRIDE_HPP__
#include "util/BaseTypes/dtk_object.hpp"
#include "util/BaseTypes/dtk_string.hpp"
#include "def/define.h"
#include "util/dtk_maindoc_ptr.hpp"
#include "util/dtk_override_ptr.hpp"
#include "util/error_dtk.hpp"
#include "struct/str_feat_dtk.hpp"
#include "util/util_ptr_dtk.hpp"
#include "util/util_stl_dtk.hpp"
#include <memory>
 
/////////////////////////////////////////////////////////////////////////////
//! \ingroup DtkAPIGroup
//! \class Dtk_OverrideInfo 
//! \brief This is the Override Information Class.\n
//! The Dtk_OverridePtr object is used as override information into an assembly tree.\n
//! \SmartPtr{Dtk_OverrideInfo}
class Dtk_OverrideInfo : public Dtk_Object
{
     friend class Dtk_SmartPtr<Dtk_OverrideInfo>;
protected: 
    enum { _typeID = DTK_TYPE_OVERRIDE }; 
    struct Dtk_Handle;       // Not defined here
    std::unique_ptr<Dtk_Handle> _Private;   // Handle
private:
     Dtk_OverrideInfo(Dtk_string inName, Dtk_InfoPtr inNewAttributes, Dtk_transfoPtr inNewTransformationMatrix, Dtk_FeaturePtr inAssemblyFeature);
    //! \BaseDestructor 
    ~Dtk_OverrideInfo();
public:
     Dtk_OverrideInfo(const Dtk_OverrideInfo& inToBeCopied);
public:
    //! \DtkDynamicCast
    static Dtk_OverrideInfo* DtkDynamicCast(Dtk_Object *s);
     static Dtk_OverrideInfoPtr Create( Dtk_string inName, Dtk_InfoPtr inNewAttributes, Dtk_transfoPtr inNewTransformationMatrix, Dtk_FeaturePtr inAssemblyFeature);
public:
     //! \DtkDynamicType
    Dtk_Int32 DtkDynamicType(const int& inId);
     //! \brief Set the connectors to the component or entities affected by override.
    //! \return dtkNoError if ok.
     Dtk_ErrorStatus SetConnectors(Dtk_tab<Dtk_NodeConnectorPtr> inConnectedEntities);
     //! \brief Retrieves the connectors to the component or entities affected by override.
     //! \return the connectors.
    Dtk_tab<Dtk_NodeConnectorPtr> const & GetConnectors() const;
     //! \brief Retrieves the name.
     //! \return the name if succeeds, empty string otherwise.
     const Dtk_string& GetName() const;
     //! \brief Retrieves the position.
     //! \return the position if succeeds, nullptr otherwise.
     const Dtk_transfoPtr& GetPosition() const;
     //! \brief Retrieves the Dtk_InfoPtr.
     //! \return the Dtk_InfoPtr if succeeds, nullptr otherwise.
     const Dtk_InfoPtr& GetInfos() const;
     //! \brief Retrieves the Dtk_FeaturePtr.
     //! \return the Dtk_FeaturePtr if succeeds, nullptr otherwise.
     const Dtk_FeaturePtr& GetAssemblyFeature() const;
};
/////////////////////////////////////////////////////////////////////////////
 
/////////////////////////////////////////////////////////////////////////////
//! \ingroup DtkAPIGroup
//! \class Dtk_OverrideSet 
//! \brief This is the Override Set Class.\n
//! The Dtk_OverrideSetPtr object is used as override set into an assembly tree.\n
//! \SmartPtr{Dtk_OverrideSet}
class Dtk_OverrideSet : public Dtk_Object
{
public:
     enum SemanticType
     {
          //InitialState
          DefaultType = 0,
          // [Catia V5]
          CatiaV5_Scene,
          // [Catia V6]
          CatiaV6_Scene,
          // [Creo]
          CREO_Explosion,
          CREO_SimplifiedRepresentation,
          // [Inventor]
          INV_ModelState,
          // [NX]
          NX_Arrangement,
          NX_Explosion,
          // [Solid Edge]
          SE_DisplayConfiguration,
          SE_ExplodedView,
          // [SOLIDWORKS]
          SW_Configuration,
          SW_Explosion,
          // [ZW3D]
          ZW3D_Configuration
     };
     static Dtk_string Dtk_OverrideSetEnumToString(const SemanticType& inEnum)
     {
          switch (inEnum)
          {
          case DefaultType: return L"DefaultState";
          case CatiaV5_Scene: return L"CatiaV5_Scene";
          case CatiaV6_Scene: return L"CatiaV6_Scene";
          case CREO_Explosion: return L"CREO_Explosion";
          case CREO_SimplifiedRepresentation: return L"CREO_SimplifiedRepresentation";
          case INV_ModelState: return L"INV_ModelState";
          case NX_Arrangement: return L"NX_Arrangement";
          case NX_Explosion: return L"NX_Explosion";
          case SE_DisplayConfiguration: return L"SE_DisplayConfiguration";
          case SE_ExplodedView: return L"SE_ExplodedView";
          case SW_Configuration: return L"SW_Configuration";
          case SW_Explosion: return L"SW_Explosion";
          case ZW3D_Configuration: return "ZW3D_Configuration";
          default: return L"Unknown";
          }
     }
 
     friend class Dtk_SmartPtr<Dtk_OverrideSet>;
protected:
     enum { _typeID = DTK_TYPE_OVERRIDE_SET };
     struct Dtk_Handle;       // Not defined here
     std::unique_ptr<Dtk_Handle> _Private;   // Handle
private:
     Dtk_OverrideSet( );
     Dtk_OverrideSet( Dtk_string inName, SemanticType inType, Dtk_string inTargetName, Dtk_string inDisplayName );
     //! \BaseDestructor 
     ~Dtk_OverrideSet();
public:
     Dtk_OverrideSet(const Dtk_OverrideSet& inToBeCopied);
 
 
     //! \DtkDynamicCast
     static Dtk_OverrideSet* DtkDynamicCast(Dtk_Object *s);
     static Dtk_OverrideSetPtr Create( Dtk_string inName, SemanticType inType, Dtk_string inTargetName = Dtk_string(), Dtk_string inDisplayName = Dtk_string() );
public:
     //! \brief Set the connectors to the component or entities affected by override.
     //! \return dtkNoError if ok.
     Dtk_ErrorStatus SetOverrideInfoListOnComponent(Dtk_tab<Dtk_OverrideInfoPtr> inOverrideInfoList);
     Dtk_ErrorStatus SetOverrideInfoListOnNode(Dtk_tab<Dtk_OverrideInfoPtr> inOverrideInfoList);
     Dtk_ErrorStatus AddOverrideInfoOnComponent(Dtk_OverrideInfoPtr inOverrideInfo);
     Dtk_ErrorStatus AddOverrideInfoOnNode(Dtk_OverrideInfoPtr inOverrideInfo);
 
 
public:
     //! \DtkDynamicType
     Dtk_Int32 DtkDynamicType(const int& inId);
     //! \brief Retrieves the overrides.
     //! \return the overrides.
     Dtk_tab<Dtk_OverrideInfoPtr> const & GetOverrideInfoListOnComponent() const;
     Dtk_tab<Dtk_OverrideInfoPtr> const & GetOverrideInfoListOnNode() const;
 
     //! \brief Retrieves the name .
     //! \return the name if succeeds, empty string otherwise.
     const Dtk_string& GetName() const;
     //! \brief Retrieves the target name
     //! indicates child node used in node catalog.
    //! \return the target name if succeeds, empty string otherwise.
     const Dtk_string& GetTargetName() const;
     //! \brief Retrieves the display name 
     //! indicates display used
     //! \return the display name if succeeds, empty string otherwise.
     const Dtk_string& GetDisplayName() const;
 
     //! \brief Retrieves Semantic Type in the original software.
     //! \return type of information stored in the original software.
     SemanticType GetSemanticType() const;
 
     //! \brief Get activation flag.
    //! \return DTK_TRUE if this override set is activated, DTK_FALSE otherwise.
     Dtk_bool IsActivated();
     void SetActivated(Dtk_bool inActivationFlag);
     //! \brief Set the connectors to the component or entities affected by override.
     //! \return dtkNoError if ok.
     Dtk_ErrorStatus SetConnectors( Dtk_tab<Dtk_NodeConnectorPtr> inConnectedEntities );
     //! \brief Retrieves the connectors to the component or entities affected by override.
     //! \return the connectors.
     Dtk_tab<Dtk_NodeConnectorPtr> const & GetConnectors() const;
     //! \brief Clear Volatile Override Infos.
     //! \return dtkNoError if ok.
     Dtk_ErrorStatus ClearVolatileInfos();
 
 
};
/////////////////////////////////////////////////////////////////////////////
 
 
#endif