summaryrefslogtreecommitdiff
path: root/inc/TObj_Partition.hxx
blob: f624bb2f988f2f4405db4d2ca5cd24404975d69c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
// File:        TObj_Partition.hxx
// Created:     Thu Nov 23 11:26:54 2004
// Author:      Pavel TELKOV
// Copyright:   Open CASCADE  2007
// The original implementation Copyright: (C) RINA S.p.A

#ifndef TObj_Partition_HeaderFile
#define TObj_Partition_HeaderFile

#include <TObj_Object.hxx>
#include <TObj_Persistence.hxx>

class Handle(TCollection_HExtendedString);
class Handle(TObj_Partition);

/**
* This class privides tool handling one of partitions (the set of
* homogenious elements) in the OCAF based model`s data structure
*/

class TObj_Partition : public TObj_Object
{
 protected:
  enum DataTag 
  {
    DataTag_First = TObj_Object::DataTag_Last,
    DataTag_LastIndex,
    DataTag_Last = DataTag_First + 100
  };

 protected:
  /**
  * Constructor
  */

  //! Constructor is protected; 
  //! static methods are used for creation of this type of objects
  Standard_EXPORT TObj_Partition (const TDF_Label& theLabel);
  
 public:
  /**
  * Method for create partition
  */
  
  //! Creates a new partition on given label.
  static Standard_EXPORT Handle(TObj_Partition) Create
                        (const TDF_Label& theLabel);
  
 public:
  /**
  * Methods hanling name of the object
  */

  //! Sets name of the object. partition does not check unique of own name
  virtual Standard_EXPORT Standard_Boolean SetName
                        (const Handle(TCollection_HExtendedString)& theName) const;

 public:
  /**
  * Method for updating object afrer restoring
  */

  //! Preforms updating the links and dependances of the object which are not
  //! stored in persistence. Does not register the partition name
  virtual Standard_EXPORT void AfterRetrieval();

 public:
  /**
  * Methods handling of the objects in partition
  */
  
  //! Creates and Returns label for new object in partition.
  Standard_EXPORT TDF_Label NewLabel() const;
  
  //! Sets prefix for names of the objects in partition.
  Standard_EXPORT void SetNamePrefix
                        (const Handle(TCollection_HExtendedString)& thePrefix);

  //! Returns prefix for names of the objects in partition.
  Standard_EXPORT Handle(TCollection_HExtendedString) GetNamePrefix() const
  { return myPrefix; }
  
  //! Generates and returns name for new object in partition.
  //! if theIsToChangeCount is true partition icrease own counter
  //!  to generate new name next time starting from new counter value
  Standard_EXPORT Handle(TCollection_HExtendedString) GetNewName
    ( const Standard_Boolean theIsToChangeCount = Standard_True );
  
  //! Return Last index in partition (reserved);
  Standard_EXPORT Standard_Integer GetLastIndex() const;
  
  //! Sets Last index in partition (reserved);
  Standard_EXPORT void SetLastIndex(const Standard_Integer theIndex);

 public:
  /**
  * Methods to define partition by object
  */
  
  //! Returns the partition in which object is stored. Null partition
  //! returned if not found
  static Standard_EXPORT Handle(TObj_Partition) GetPartition
                        (const Handle(TObj_Object)& theObject);
  
 public:
  /**
  * Methods for updating the object
  */
  
  //! Does nothing in the partition.
  virtual Standard_EXPORT Standard_Boolean Update()
  {return Standard_True;}

 protected:
  /**
  * protected redefined methods
  */

  //! Coping the data of me to Target object.
  //! return Standard_False is Target object is different type
  Standard_EXPORT virtual Standard_Boolean copyData
                        (const Handle(TObj_Object)& theTargetObject);
 
 private:
  /**
  * fields
  */
  
  //! prefix for naming of objects in the partition
  Handle(TCollection_HExtendedString) myPrefix; 

 protected:
  //! Persistence of TObj object
  DECLARE_TOBJOCAF_PERSISTENCE(TObj_Partition,TObj_Object)

 public:
  //! CASCADE RTTI
  DEFINE_STANDARD_RTTI(TObj_Partition)

 public:
  friend class TObj_Model;

};

//! Define handle class for TObj_Partition
DEFINE_STANDARD_HANDLE(TObj_Partition,TObj_Object)

#endif

#ifdef _MSC_VER
#pragma once
#endif