Teamcenter C++ API Reference  2312
Cfg0ConfiguratorPerspective.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, Cfg0ConfiguratorPerspective
12  Filename: Cfg0ConfiguratorPerspective.hxx
13  Module: Cfg0configurator
14  @BMIDE autogenerated
15 ==================================================================================================*/
16 
17 #ifndef TEAMCENTER__CFG0CONFIGURATOR__CFG0CONFIGURATORPERSPECTIVE__HXX
18 #define TEAMCENTER__CFG0CONFIGURATOR__CFG0CONFIGURATORPERSPECTIVE__HXX
19 
20 #include <vector>
21 #include <unidefs.h>
22 #include <string>
23 #include <common/tc_deprecation_macros.h>
25 
26 #include <Cfg0configurator/libcfg0configurator_exports.h>
27 
28 namespace Teamcenter
29 {
30  namespace Cfg0configurator
31  {
32  class Cfg0ConfiguratorPerspective;
33  }
34 }
35 namespace Teamcenter
36 {
37  namespace Cfg0configurator
38  {
39  class Cfg0ConfiguratorPerspectiveImpl;
40  }
41 }
42 namespace Teamcenter
43 {
44  namespace Cfg0configurator
45  {
46  class Cfg0ConfiguratorPerspectiveDelegate;
47  }
48 }
49 namespace Teamcenter
50 {
51  namespace Cfg0configurator
52  {
53  class Cfg0ConfiguratorPerspectiveDispatch;
54  }
55 }
56 namespace Teamcenter
57 {
58  namespace Cfg0configurator
59  {
60  class Cfg0ConfiguratorPerspectiveGenImpl;
61  }
62 }
63 namespace Teamcenter
64 {
65  class RootObjectImpl;
66 }
67 
68 class CFG0CONFIGURATOR_API Teamcenter::Cfg0configurator::Cfg0ConfiguratorPerspective
70 {
71 public:
72 
77  static const std::string& getInterfaceName();
78 
79 
87  int getCfg0AvailabilityRules( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
88 
96  int getCfg0ConfigurationModules( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
97 
105  int getCfg0DefaultRules( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
106 
114  int getCfg0EditContext( tag_t &value, bool &isNull ) const;
115 
123  int getCfg0EffectivityFamilies( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
124 
132  int getCfg0EffectivityIntents( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
133 
141  int getCfg0ExceptionRules( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
142 
150  int getCfg0ExcludeRules( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
151 
159  int getCfg0FamilyGroups( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
160 
168  int getCfg0FeatureFamilies( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
169 
177  int getCfg0Features( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
178 
186  int getCfg0FeatureSets( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
187 
195  int getCfg0IncludeRules( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
196 
204  int getCfg0ModelFamilies( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
205 
213  int getCfg0Models( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
214 
222  int getCfg0OptionFamilies( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
223 
231  int getCfg0OptionValues( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
232 
240  int getCfg0PackageRules( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
241 
249  int getCfg0PrivateFamilies( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
250 
258  int getCfg0PrivateValues( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
259 
267  int getCfg0ProductHierarchyDepth( int &value, bool &isNull ) const;
268 
276  int getCfg0ProductItems( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
277 
285  int getCfg0PublicFamilies( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
286 
294  int getCfg0PublicValues( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
295 
303  int getCfg0RevisionRule( tag_t &value, bool &isNull ) const;
304 
312  int getCfg0RuleSetCompileDate( date_t &value, bool &isNull ) const;
313 
321  int getCfg0RuleSetEffectivity( std::string &value, bool &isNull ) const;
322 
329  int getCfg0RuleSetEffectivityDisplayableValues( std::vector< std::string > &values );
330 
338  int getCfg0SavedVariantRules( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
339 
347  int getCfg0VariantCriteria( tag_t &value, bool &isNull ) const;
348 
356  int setCfg0EditContext( const tag_t &value, bool isNull=false );
357 
365  int setCfg0ProductHierarchyDepth( int value, bool isNull=false );
366 
374  int setCfg0ProductItems( const std::vector< tag_t > &values, const std::vector< int > *isNull=0 );
375 
383  int setCfg0RevisionRule( const tag_t &value, bool isNull=false );
384 
392  int setCfg0RuleSetCompileDate( const date_t &value, bool isNull=false );
393 
401  int setCfg0RuleSetEffectivity( const std::string &value, bool isNull=false );
402 
410  int setCfg0VariantCriteria( const tag_t &value, bool isNull=false );
411 protected:
412  // Method to initialize
413  virtual void initialize( ::Teamcenter::RootObjectImpl* impl );
414 
419 
424 
425 private:
426  // Getter method for the Implementation Object
427  Cfg0ConfiguratorPerspectiveImpl* getCfg0ConfiguratorPerspectiveImpl() const;
428  // Setter method for the Implementation Object
429  ::Teamcenter::RootObjectImpl* setCfg0ConfiguratorPerspectiveImpl( ::Teamcenter::RootObjectImpl* impl );
430 
431  // Method to set the delete impl boolean
432  void setDeleteImpl( bool del );
433 
434  // Pointer to the Implementation object
435  Cfg0ConfiguratorPerspectiveImpl* m_cfg0configuratorperspectiveImpl;
436 
437  // Flag to indicate if Implementation object needs to be deleted
439 
443  static std::string name;
444 
451 
452  friend class Cfg0ConfiguratorPerspectiveDelegate;
453  friend class Cfg0ConfiguratorPerspectiveGenImpl;
454 };
455 
456 #include <Cfg0configurator/libcfg0configurator_undef.h>
457 #endif // TEAMCENTER__CFG0CONFIGURATOR__CFG0CONFIGURATORPERSPECTIVE__HXX