Teamcenter C++ API Reference  2312
Lis0Protocol.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, Lis0Protocol
12  Filename: Lis0Protocol.hxx
13  Module: Lis0lisfmwrk
14  @BMIDE autogenerated
15 ==================================================================================================*/
16 
17 #ifndef LIS0LISFMWRK__LIS0PROTOCOL__HXX
18 #define LIS0LISFMWRK__LIS0PROTOCOL__HXX
19 
20 #include <string>
21 #include <common/tc_deprecation_macros.h>
23 
24 #include <Lis0lisfmwrk/liblis0lisfmwrk_exports.h>
25 
26 namespace lis0lisfmwrk
27 {
28  class Lis0Protocol;
29 }
30 namespace lis0lisfmwrk
31 {
32  class Lis0ProtocolImpl;
33 }
34 namespace lis0lisfmwrk
35 {
36  class Lis0ProtocolDelegate;
37 }
38 namespace lis0lisfmwrk
39 {
40  class Lis0ProtocolDispatch;
41 }
42 namespace lis0lisfmwrk
43 {
44  class Lis0ProtocolGenImpl;
45 }
46 namespace Teamcenter
47 {
48  class RootObjectImpl;
49 }
50 
51 class LIS0LISFMWRK_API lis0lisfmwrk::Lis0Protocol
53 {
54 public:
55 
60  static const std::string& getInterfaceName();
61 
62 
70  int getLis0protocolVersion( std::string &value, bool &isNull ) const;
71 
79  int setLis0protocolVersion( const std::string &value, bool isNull=false );
80 
86  int lis0GetLISDescription( ) const;
87 protected:
88  // Method to initialize
89  virtual void initialize( ::Teamcenter::RootObjectImpl* impl );
90 
94  Lis0Protocol();
95 
99  virtual ~Lis0Protocol();
100 
101 private:
102  // Getter method for the Implementation Object
103  Lis0ProtocolImpl* getLis0ProtocolImpl() const;
104  // Setter method for the Implementation Object
105  ::Teamcenter::RootObjectImpl* setLis0ProtocolImpl( ::Teamcenter::RootObjectImpl* impl );
106 
107  // Method to set the delete impl boolean
108  void setDeleteImpl( bool del );
109 
110  // Pointer to the Implementation object
111  Lis0ProtocolImpl* m_lis0protocolImpl;
112 
113  // Flag to indicate if Implementation object needs to be deleted
115 
119  static std::string name;
120 
125  Lis0Protocol( const Lis0Protocol& );
127 
128  friend class Lis0ProtocolDelegate;
129  friend class Lis0ProtocolGenImpl;
130 };
131 
132 #include <Lis0lisfmwrk/liblis0lisfmwrk_undef.h>
133 #endif // LIS0LISFMWRK__LIS0PROTOCOL__HXX