Teamcenter C++ API Reference  2312
Lis0MediaWriter.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, Lis0MediaWriter
12  Filename: Lis0MediaWriter.hxx
13  Module: Lis0lisfmwrk
14  @BMIDE autogenerated
15 ==================================================================================================*/
16 
17 #ifndef LIS0LISFMWRK__LIS0MEDIAWRITER__HXX
18 #define LIS0LISFMWRK__LIS0MEDIAWRITER__HXX
19 
20 #include <string>
22 #include <common/tc_deprecation_macros.h>
23 #include <tccore/POM_object.hxx>
24 
25 #include <Lis0lisfmwrk/liblis0lisfmwrk_exports.h>
26 
27 namespace lis0lisfmwrk
28 {
29  class Lis0MediaWriter;
30 }
31 namespace lis0lisfmwrk
32 {
33  class Lis0MediaWriterImpl;
34 }
35 namespace lis0lisfmwrk
36 {
37  class Lis0MediaWriterDelegate;
38 }
39 namespace lis0lisfmwrk
40 {
41  class Lis0MediaWriterDispatch;
42 }
43 namespace lis0lisfmwrk
44 {
45  class Lis0MediaWriterGenImpl;
46 }
47 namespace Teamcenter
48 {
49  class RootObjectImpl;
50 }
51 
52 class LIS0LISFMWRK_API lis0lisfmwrk::Lis0MediaWriter
54 {
55 public:
56 
61  static const std::string& getInterfaceName();
62 
63 
71  int lis0IsReadable( const std::string *requiredMediaType, bool *result ) const;
72 
80  int lis0IsWritable( const std::string *requiredMediaType, bool *result ) const;
81 
90  int lis0ReadFrom( const std::string *mediaType, const std::string *document, lis0lisfmwrk::AbstractResource **resourceModel ) const;
91 
100  int lis0WriteTo( const std::string *mediaType, const lis0lisfmwrk::AbstractResource *model, std::string *document ) const;
101 protected:
102  // Method to initialize
103  virtual void initialize( ::Teamcenter::RootObjectImpl* impl );
104 
108  Lis0MediaWriter();
109 
113  virtual ~Lis0MediaWriter();
114 
115 private:
116  // Getter method for the Implementation Object
117  Lis0MediaWriterImpl* getLis0MediaWriterImpl() const;
118  // Setter method for the Implementation Object
119  ::Teamcenter::RootObjectImpl* setLis0MediaWriterImpl( ::Teamcenter::RootObjectImpl* impl );
120 
121  // Method to set the delete impl boolean
122  void setDeleteImpl( bool del );
123 
124  // Pointer to the Implementation object
125  Lis0MediaWriterImpl* m_lis0mediawriterImpl;
126 
127  // Flag to indicate if Implementation object needs to be deleted
129 
133  static std::string name;
134 
141 
142  friend class Lis0MediaWriterDelegate;
143  friend class Lis0MediaWriterGenImpl;
144 };
145 
146 #include <Lis0lisfmwrk/liblis0lisfmwrk_undef.h>
147 #endif // LIS0LISFMWRK__LIS0MEDIAWRITER__HXX