Teamcenter C++ API Reference  2312
OperationInput.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, OperationInput
12  Filename: OperationInput.hxx
13  Module: metaframework
14  @BMIDE autogenerated
15 ==================================================================================================*/
16 
17 #ifndef TEAMCENTER__OPERATIONINPUT__HXX
18 #define TEAMCENTER__OPERATIONINPUT__HXX
19 
20 #include <string>
21 #include <vector>
22 #include <unidefs.h>
23 #include <common/tc_deprecation_macros.h>
25 
26 #include <metaframework/libmetaframework_exports.h>
27 
28 namespace Teamcenter
29 {
30  class OperationInput;
31 }
32 namespace Teamcenter
33 {
34  class OperationInputImpl;
35 }
36 namespace Teamcenter
37 {
38  class OperationInputDelegate;
39 }
40 namespace Teamcenter
41 {
42  class OperationInputDispatch;
43 }
44 namespace Teamcenter
45 {
46  class OperationInputGenImpl;
47 }
48 namespace Teamcenter
49 {
50  class RootObjectImpl;
51 }
52 
53 class METAFRAMEWORK_API Teamcenter::OperationInput
55 {
56 public:
57 
58  using ::Teamcenter::RootObject::getTag;
59  using ::Teamcenter::RootObject::setTag;
60 
65  static const std::string& getInterfaceName();
66 
67 
74  int getBusinessObjectName( std::string &busObjName );
75 
84  int getChar( const std::string &charName, char &charRetValue, bool &isNull );
85 
94  int getCharArray( const std::string &charArrayName, std::vector< char > &vectorCharVals, std::vector< int > &vectorIsNullVals );
95 
104  int getDate( const std::string &dateName, date_t &dateRetValue, bool &isNull );
105 
114  int getDateArray( const std::string &dateArrayName, std::vector< date_t > &dateArrayRetValue, std::vector< int > &isNull );
115 
124  int getDisplayValues( const std::string *stringName, std::vector< std::string > *vectorDispVals, std::vector< int > *vectorIsNullVals );
125 
134  int getDouble( const std::string &doubleName, double &doubleRetValue, bool &isNull );
135 
144  int getDoubleArray( const std::string &doubleArrayName, std::vector< double > &vectorDoubleVals, std::vector< int > &vectorIsNullVals );
145 
154  int getInt( const std::string &intName, int &intRetValue, bool &isNull );
155 
164  int getIntArray( const std::string &intArrayName, std::vector< int > &vectorIntVals, std::vector< int > &vectorIsNullVals );
165 
174  int getLogical( const std::string &logicalName, bool &boolRetValue, bool &isNull );
175 
184  int getLogicalArray( const std::string &logicalArrayName, std::vector< int > &vectorLogicalVals, std::vector< int > &vectorIsNullVals );
185 
194  int getString( const std::string &stringName, std::string &stringRetValue, bool &isNull );
195 
204  int getStringArray( const std::string &stringArrayName, std::vector< std::string > &vectorStringVals, std::vector< int > &vectorIsNullVals );
205 
214  int getTag( const std::string &tagName, tag_t &tagRetValue, bool &isNull );
215 
224  int getTagArray( const std::string &tagArrayName, std::vector< tag_t > &vectorTagVals, std::vector< int > &vectorIsNullVals );
225 
232  int setBusinessObjectName( const std::string &busObjName );
233 
242  int setChar( const std::string &charName, const char &charValue, bool isNull );
243 
252  int setCharArray( const std::string &charArrayName, const std::vector< char > &vectorCharVals, const std::vector< int > *vectorIsNullVals );
253 
262  int setDate( const std::string &dateName, const date_t &dateValue, bool isNull );
263 
272  int setDateArray( const std::string &dateArrayName, const std::vector< date_t > &vectorDateVals, const std::vector< int > *vectorIsNullVals );
273 
281  int setDisplayValue( const std::string &stringName, const std::string &stringValue );
282 
291  int setDouble( const std::string &doubleName, const double &doubleValue, bool isNull );
292 
301  int setDoubleArray( const std::string &doubleArrayName, const std::vector< double > &vectorDoubleVals, const std::vector< int > *vectorIsNullVals );
302 
311  int setInt( const std::string &intName, const int &intValue, bool isNull );
312 
321  int setIntArray( const std::string &intArrayName, const std::vector< int > &vectorIntVals, const std::vector< int > *vectorIsNullVals );
322 
331  int setLogical( const std::string &logicalName, const bool logicalValue, bool isNull );
332 
341  int setLogicalArray( const std::string &boolArrayName, const std::vector< int > &vectorboolVals, const std::vector< int > *vectorIsNullVals );
342 
351  int setString( const std::string &stringName, const std::string &stringValue, bool isNull );
352 
361  int setStringArray( const std::string &stringArrayName, const std::vector< std::string > &vectorStringVals, const std::vector< int > *vectorIsNullVals );
362 
371  int setTag( const std::string &tagName, const tag_t &tagValue, bool isNull );
372 
381  int setTagArray( const std::string &tagArrayName, const std::vector< tag_t > &vectorTagVals, const std::vector< int > *vectorIsNullVals );
382 protected:
383  // Method to initialize
384  virtual void initialize( ::Teamcenter::RootObjectImpl* impl );
385 
389  OperationInput();
390 
394  virtual ~OperationInput();
395 
396 private:
397  // Getter method for the Implementation Object
398  OperationInputImpl* getOperationInputImpl() const;
399  // Setter method for the Implementation Object
400  ::Teamcenter::RootObjectImpl* setOperationInputImpl( ::Teamcenter::RootObjectImpl* impl );
401 
402  // Method to set the delete impl boolean
403  void setDeleteImpl( bool del );
404 
405  // Pointer to the Implementation object
406  OperationInputImpl* m_operationinputImpl;
407 
408  // Flag to indicate if Implementation object needs to be deleted
410 
414  static std::string name;
415 
420  OperationInput( const OperationInput& );
422 
423  friend class OperationInputDelegate;
424  friend class OperationInputGenImpl;
425 };
426 
427 #include <metaframework/libmetaframework_undef.h>
428 #endif // TEAMCENTER__OPERATIONINPUT__HXX