Teamcenter C++ API Reference  2312
BOMLine.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, BOMLine
12  Filename: BOMLine.hxx
13  Module: bom
14  @BMIDE autogenerated
15 ==================================================================================================*/
16 
17 #ifndef TEAMCENTER__BOMLINE__HXX
18 #define TEAMCENTER__BOMLINE__HXX
19 
20 #include <unidefs.h>
21 #include <vector>
22 #include <string>
23 #include <metaframework/BulkInput.hxx>
24 #include <metaframework/BulkData.hxx>
25 #include <map>
26 #include <fclasses/error_map.hxx>
27 #include <common/tc_deprecation_macros.h>
28 #include <metaframework/RuntimeBusinessObject.hxx>
29 
30 #include <bom/libbom_exports.h>
31 
32 namespace Teamcenter
33 {
34  class BOMLine;
35 }
36 namespace Teamcenter
37 {
38  class BOMLineImpl;
39 }
40 namespace Teamcenter
41 {
42  class BOMLineDelegate;
43 }
44 namespace Teamcenter
45 {
46  class BOMLineDispatch;
47 }
48 namespace Teamcenter
49 {
50  class BOMLineGenImpl;
51 }
52 namespace Teamcenter
53 {
54  class RootObjectImpl;
55 }
56 
57 class BOM_API Teamcenter::BOMLine
58  : public ::Teamcenter::RuntimeBusinessObject
59 {
60 public:
61 
66  static const std::string& getInterfaceName();
67 
68 
76  int getBl_has_attached_notes( bool &value, bool &isNull ) const;
77 
85  int getBl_jt_hint_contents( std::string &value, bool &isNull ) const;
86 
94  int getBl_occ_int_order_no( int &value, bool &isNull ) const;
95 
103  int getBl_physical_attach_children( std::vector< std::string > &values, std::vector< int > &isNull ) const;
104 
112  int getBl_physical_attach_mfg0BiDirectional( std::vector< std::string > &values, std::vector< int > &isNull ) const;
113 
121  int getBl_physical_attach_mfg0RelationTypeName( std::vector< std::string > &values, std::vector< int > &isNull ) const;
122 
130  int getBl_physical_attach_mfg0RelToOrigin( std::vector< std::string > &values, std::vector< int > &isNull ) const;
131 
139  int getBl_physical_attach_mfg0SourceID( std::vector< std::string > &values, std::vector< int > &isNull ) const;
140 
148  int getBl_physical_attach_mfg0SourceIDFormatType( std::vector< std::string > &values, std::vector< int > &isNull ) const;
149 
157  int getBl_physical_attach_mfg0TargetID( std::vector< std::string > &values, std::vector< int > &isNull ) const;
158 
166  int getBl_physical_attach_mfg0TargetIDFormatType( std::vector< std::string > &values, std::vector< int > &isNull ) const;
167 
175  int getBl_physical_attach_mfg0TCPFPosition( std::vector< std::string > &values, std::vector< int > &isNull ) const;
176 
184  int getBl_resource_color( std::vector< int > &values, std::vector< int > &isNull ) const;
185 
193  int getBl_window_is_BOPWin( bool &value, bool &isNull ) const;
194 
202  int getFnd0AssignedToProcess( std::vector< std::string > &values, std::vector< int > &isNull ) const;
203 
211  int getFnd0bl_ac_check_result( std::string &value, bool &isNull ) const;
212 
220  int getFnd0bl_active_changes( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
221 
229  int getFnd0bl_active_markup( tag_t &value, bool &isNull ) const;
230 
238  int getFnd0bl_alternate_groups( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
239 
247  int getFnd0bl_assigned_as( std::vector< std::string > &values, std::vector< int > &isNull ) const;
248 
256  int getFnd0bl_closurerule_state( int &value, bool &isNull ) const;
257 
265  int getFnd0bl_complying_objects( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
266 
274  int getFnd0bl_configured_out( int &value, bool &isNull ) const;
275 
283  int getFnd0bl_defining_objects( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
284 
292  int getFnd0bl_has_active_markup( bool &value, bool &isNull ) const;
293 
301  int getFnd0bl_has_alternate_group( bool &value, bool &isNull ) const;
302 
310  int getFnd0bl_has_trace_link( int &value, bool &isNull ) const;
311 
319  int getFnd0bl_is_mono_override( int &value, bool &isNull ) const;
320 
328  int getFnd0bl_is_mono_present( bool &value, bool &isNull ) const;
329 
337  int getFnd0bl_is_substitute( bool &value, bool &isNull ) const;
338 
346  int getFnd0bl_markup_add_objs( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
347 
355  int getFnd0bl_markup_prop_names( std::vector< std::string > &values, std::vector< int > &isNull ) const;
356 
364  int getFnd0bl_markup_prop_values( std::vector< std::string > &values, std::vector< int > &isNull ) const;
365 
373  int getFnd0bl_markup_replace_obj( tag_t &value, bool &isNull ) const;
374 
382  int getFnd0bl_markup_subs_objs_add( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
383 
391  int getFnd0bl_markup_subs_objs_del( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
392 
400  int getFnd0bl_markup_type( int &value, bool &isNull ) const;
401 
409  int getFnd0bl_real_quantity( std::string &value, bool &isNull ) const;
410 
418  int getFnd0bl_sub_id_compare( std::string &value, bool &isNull ) const;
419 
427  int getFnd0bl_sub_name_compare( std::string &value, bool &isNull ) const;
428 
436  int getFnd0bl_substitute_groups( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
437 
445  int getFnd0HasReflection( bool &value, bool &isNull ) const;
446 
454  int getFnd0IsConfiguredForNetEff( bool &value, bool &isNull ) const;
455 
463  int getFnd0OccurrenceRevision( tag_t &value, bool &isNull ) const;
464 
472  int getFnd0QuantityManaged( int &value, bool &isNull ) const;
473 
481  int getFnd0RelativeTransform( std::string &value, bool &isNull ) const;
482 
490  int getFnd0RelativeTransformOverride( std::string &value, bool &isNull ) const;
491 
499  int getFnd0UnitNetEffectivity( std::string &value, bool &isNull ) const;
500 
508  int setBl_occ_effectivity( const std::vector< tag_t > &values, const std::vector< int > *isNull=0 );
509 
517  int setBl_occ_int_order_no( int value, bool isNull=false );
518 
526  int setBl_physical_attach_children( const std::vector< std::string > &values, const std::vector< int > *isNull=0 );
527 
535  int setBl_physical_attach_mfg0BiDirectional( const std::vector< std::string > &values, const std::vector< int > *isNull=0 );
536 
544  int setBl_physical_attach_mfg0RelationTypeName( const std::vector< std::string > &values, const std::vector< int > *isNull=0 );
545 
553  int setBl_physical_attach_mfg0RelToOrigin( const std::vector< std::string > &values, const std::vector< int > *isNull=0 );
554 
562  int setBl_physical_attach_mfg0SourceID( const std::vector< std::string > &values, const std::vector< int > *isNull=0 );
563 
571  int setBl_physical_attach_mfg0SourceIDFormatType( const std::vector< std::string > &values, const std::vector< int > *isNull=0 );
572 
580  int setBl_physical_attach_mfg0TargetID( const std::vector< std::string > &values, const std::vector< int > *isNull=0 );
581 
589  int setBl_physical_attach_mfg0TargetIDFormatType( const std::vector< std::string > &values, const std::vector< int > *isNull=0 );
590 
598  int setBl_physical_attach_mfg0TCPFPosition( const std::vector< std::string > &values, const std::vector< int > *isNull=0 );
599 
607  int setBl_quantity( const std::string &value, bool isNull=false );
608 
616  int setBl_resource_color( const std::vector< int > &values, const std::vector< int > *isNull=0 );
617 
625  int setBl_sequence_no( const std::string &value, bool isNull=false );
626 
634  int setFnd0bl_ac_check_result( const std::string &value, bool isNull=false );
635 
643  int setFnd0bl_active_changes( const std::vector< tag_t > &values, const std::vector< int > *isNull=0 );
644 
652  int setFnd0bl_active_markup( const tag_t &value, bool isNull=false );
653 
661  int setFnd0bl_alternate_groups( const std::vector< tag_t > &values, const std::vector< int > *isNull=0 );
662 
670  int setFnd0bl_has_active_markup( bool value, bool isNull=false );
671 
679  int setFnd0bl_is_mono_override( int value, bool isNull=false );
680 
688  int setFnd0bl_substitute_groups( const std::vector< tag_t > &values, const std::vector< int > *isNull=0 );
689 
698  int fnd0assignChildLine( tag_t sourceLine, char *occType, tag_t *newChildLine );
699 
709  int fnd0bomline_move( tag_t parent_tag, const int count, tag_t *source_bomlines, tag_t **target_bomlines );
710 
719  int fnd0CopyLine( tag_t lineToCopy, tag_t viewType, tag_t *newLine );
720 
733  int fnd0Duplicate( const tag_t *topLine, tag_t *topLineResult );
734 
746  int fnd0DuplicateExpandOrUpdate( const std::vector< tag_t > *bomlines, const std::vector< tag_t > *itemRevisions, const std::vector< std::string > *cadOptions, const int *selectionOption, std::vector< tag_t > *updatedObjects, std::vector< tag_t > *cadDependencies );
747 
760  static int fnd0ExpandLines( std::vector< ::Teamcenter::BulkInput* > *bulkInput, ::Teamcenter::BulkData *bd, int expansionCriteria, std::vector< tag_t > *occurenceThreads, std::vector< tag_t > *occurenceThreadParents, std::map< tag_t,std::vector< tag_t > > *parentLinesToChildLinesMap, ::Teamcenter::ErrorMap *errorMap );
761 
773  static int fnd0InsertLevel( std::vector< ::Teamcenter::BulkInput* > *bulkInput, ::Teamcenter::BulkData *bd, tag_t newLevelObject, tag_t viewType, tag_t *insertedLine, std::vector< tag_t > *newChildLines );
774 
783  static int fnd0RemoveLevel( std::vector< ::Teamcenter::BulkInput* > *bulkInput, ::Teamcenter::BulkData *bd, std::vector< tag_t > *newChildLines );
784 protected:
785  // Method to initialize
786  virtual void initialize( ::Teamcenter::RootObjectImpl* impl );
787 
791  BOMLine();
792 
796  virtual ~BOMLine();
797 
798 private:
799  // Getter method for the Implementation Object
800  BOMLineImpl* getBOMLineImpl() const;
801  // Setter method for the Implementation Object
802  ::Teamcenter::RootObjectImpl* setBOMLineImpl( ::Teamcenter::RootObjectImpl* impl );
803 
804  // Method to set the delete impl boolean
805  void setDeleteImpl( bool del );
806 
807  // Pointer to the Implementation object
808  BOMLineImpl* m_bomlineImpl;
809 
810  // Flag to indicate if Implementation object needs to be deleted
811  bool m_deleteImpl;
812 
816  static std::string name;
817 
822  BOMLine( const BOMLine& );
823  BOMLine& operator=( const BOMLine& );
824 
825  friend class BOMLineDelegate;
826  friend class BOMLineGenImpl;
827 };
828 
829 #include <bom/libbom_undef.h>
830 #endif // TEAMCENTER__BOMLINE__HXX