Teamcenter C++ API Reference  2312
Ptn0Partition.hxx
Go to the documentation of this file.
1 //Copyright 2022 Siemens Digital Industries Software
2 //==================================================
3 //Copyright $2023.
4 //Siemens Product Lifecycle Management Software Inc.
5 //All Rights Reserved.
6 //==================================================
7 //Copyright 2022 Siemens Digital Industries Software
8 
9 /*==================================================================================================
10 File description:
11  This file contains the declaration for the Business Object, Ptn0Partition
12  Filename: Ptn0Partition.hxx
13  Module: ptn0partition
14  @BMIDE autogenerated
15 ==================================================================================================*/
16 
17 #ifndef TEAMCENTER__PARTITION__PTN0PARTITION__HXX
18 #define TEAMCENTER__PARTITION__PTN0PARTITION__HXX
19 
20 #include <unidefs.h>
21 #include <vector>
22 #include <string>
23 #include <common/tc_deprecation_macros.h>
25 
26 #include <ptn0partition/libptn0partition_exports.h>
27 
28 namespace Teamcenter
29 {
30  namespace Partition
31  {
32  class Ptn0Partition;
33  }
34 }
35 namespace Teamcenter
36 {
37  namespace Partition
38  {
39  class Ptn0PartitionImpl;
40  }
41 }
42 namespace Teamcenter
43 {
44  namespace Partition
45  {
46  class Ptn0PartitionDelegate;
47  }
48 }
49 namespace Teamcenter
50 {
51  namespace Partition
52  {
53  class Ptn0PartitionDispatch;
54  }
55 }
56 namespace Teamcenter
57 {
58  namespace Partition
59  {
60  class Ptn0PartitionGenImpl;
61  }
62 }
63 namespace Teamcenter
64 {
65  class RootObjectImpl;
66 }
67 
68 class PTN0PARTITION_API Teamcenter::Partition::Ptn0Partition
70 {
71 public:
72 
77  static const std::string& getInterfaceName();
78 
79 
87  int getPtn0AggregatePtnRecipe( std::string &value, bool &isNull ) const;
88 
96  int getPtn0allows_add_content( bool &value, bool &isNull ) const;
97 
105  int getPtn0allows_remove_content( bool &value, bool &isNull ) const;
106 
114  int getPtn0BoxZone( tag_t &value, bool &isNull ) const;
115 
123  int getPtn0IsActive( bool &value, bool &isNull ) const;
124 
132  int getPtn0membership_objects( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
133 
141  int getPtn0Operator( std::string &value, bool &isNull ) const;
142 
150  int getPtn0partition_id( std::string &value, bool &isNull ) const;
151 
159  int getPtn0partition_recipe( tag_t &value, bool &isNull ) const;
160 
168  int getPtn0partition_scheme_type( tag_t &value, bool &isNull ) const;
169 
177  int getPtn0reference_designators( std::vector< std::string > &values, std::vector< int > &isNull ) const;
178 
186  int getPtn0scheme_object( tag_t &value, bool &isNull ) const;
187 
195  int getPtn0source_object( tag_t &value, bool &isNull ) const;
196 
204  int getPtn0source_partition( tag_t &value, bool &isNull ) const;
205 
213  int setPtn0BoxZone( const tag_t &value, bool isNull=false );
214 
222  int setPtn0IsActive( bool value, bool isNull=false );
223 
231  int setPtn0Operator( const std::string &value, bool isNull=false );
232 
240  int setPtn0partition_id( const std::string &value, bool isNull=false );
241 
249  int setPtn0partition_recipe( const tag_t &value, bool isNull=false );
250 
258  int setPtn0partition_scheme_type( const tag_t &value, bool isNull=false );
259 
267  int setPtn0reference_designators( const std::vector< std::string > &values, const std::vector< int > *isNull=0 );
268 
276  int setPtn0source_object( const tag_t &value, bool isNull=false );
277 
285  int ptn0getChildren( const tag_t &configurationContext, std::vector< tag_t > &childPartitions );
286 
295  int ptn0getMembers( const tag_t &configurationContext, std::vector< tag_t > &members, const int contentPersistenceMode );
296 
304  int ptn0getParents( const tag_t &configurationContext, std::vector< tag_t > &parentPartitions );
305 
312  int ptn0persistDynamicMembers( const tag_t &configurationContext );
313 
325  int ptn0reparentPartition( const std::vector< tag_t > &children, const int actionCode, const tag_t targetParent, std::vector< tag_t > &failedChildren, std::vector< int > &errorCodes, std::vector< std::string > &errorMessages );
326 
335  int ptn0updateChildren( const std::vector< tag_t > &children, const int actionCode, std::vector< tag_t > &failedChildren );
336 
348  int ptn0updateMembers( const std::vector< tag_t > &members, const int actionCode, const int contentPersistenceMode, const tag_t &configurationContext, std::vector< tag_t > &failedMembers, std::vector< int > &errorCode );
349 
358  int ptn0updateParents( const std::vector< tag_t > &parents, const int actionCode, std::vector< tag_t > &failedParents );
359 protected:
360  // Method to initialize
361  virtual void initialize( ::Teamcenter::RootObjectImpl* impl );
362 
366  Ptn0Partition();
367 
371  virtual ~Ptn0Partition();
372 
373 private:
374  // Getter method for the Implementation Object
375  Ptn0PartitionImpl* getPtn0PartitionImpl() const;
376  // Setter method for the Implementation Object
377  ::Teamcenter::RootObjectImpl* setPtn0PartitionImpl( ::Teamcenter::RootObjectImpl* impl );
378 
379  // Method to set the delete impl boolean
380  void setDeleteImpl( bool del );
381 
382  // Pointer to the Implementation object
383  Ptn0PartitionImpl* m_ptn0partitionImpl;
384 
385  // Flag to indicate if Implementation object needs to be deleted
387 
391  static std::string name;
392 
397  Ptn0Partition( const Ptn0Partition& );
399 
400  friend class Ptn0PartitionDelegate;
401  friend class Ptn0PartitionGenImpl;
402 };
403 
404 #include <ptn0partition/libptn0partition_undef.h>
405 #endif // TEAMCENTER__PARTITION__PTN0PARTITION__HXX