Teamcenter C++ API Reference  2312
Schedule.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, Schedule
12  Filename: Schedule.hxx
13  Module: schmgt
14  @BMIDE autogenerated
15 ==================================================================================================*/
16 
17 #ifndef TEAMCENTER__SCHEDULE__HXX
18 #define TEAMCENTER__SCHEDULE__HXX
19 
20 #include <unidefs.h>
21 #include <string>
22 #include <vector>
23 #include <common/tc_deprecation_macros.h>
25 
26 #include <schmgt/libschmgt_exports.h>
27 
28 namespace Teamcenter
29 {
30  class Schedule;
31 }
32 namespace Teamcenter
33 {
34  class ScheduleImpl;
35 }
36 namespace Teamcenter
37 {
38  class ScheduleDelegate;
39 }
40 namespace Teamcenter
41 {
42  class ScheduleDispatch;
43 }
44 namespace Teamcenter
45 {
46  class ScheduleGenImpl;
47 }
48 namespace Teamcenter
49 {
50  class RootObjectImpl;
51 }
52 
53 class SCHMGT_API Teamcenter::Schedule
55 {
56 public:
57 
62  static const std::string& getInterfaceName();
63 
64 
72  int getActiveschbaseline_tag( tag_t &value, bool &isNull ) const;
73 
81  int getCustomer_name( std::string &value, bool &isNull ) const;
82 
90  int getCustomer_number( std::string &value, bool &isNull ) const;
91 
99  int getDates_linked( bool &value, bool &isNull ) const;
100 
108  int getEarliest_finish_date( date_t &value, bool &isNull ) const;
109 
117  int getEnd_date_scheduling( bool &value, bool &isNull ) const;
118 
126  int getFinish_date( date_t &value, bool &isNull ) const;
127 
135  int getFnd0allowExecUpdates( bool &value, bool &isNull ) const;
136 
144  int getFnd0BudgetedEffortInt( int &value, bool &isNull ) const;
145 
153  int getFnd0ForecastEndDate( date_t &value, bool &isNull ) const;
154 
162  int getFnd0ForecastStartDate( date_t &value, bool &isNull ) const;
163 
171  int getFnd0IsExternal( bool &value, bool &isNull ) const;
172 
180  int getFnd0IsLegacy( bool &value, bool &isNull ) const;
181 
189  int getFnd0master_sched( tag_t &value, bool &isNull ) const;
190 
198  int getFnd0ProxyTasks( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
199 
207  int getFnd0ScheduleAuditLogs( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
208 
216  int getFnd0Schedulemember_taglist( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
217 
225  int getFnd0ScheduleTemplate( std::string &value, bool &isNull ) const;
226 
234  int getFnd0Schmgt_Lock( tag_t &value, bool &isNull ) const;
235 
243  int getFnd0ShiftDate( date_t &value, bool &isNull ) const;
244 
252  int getFnd0state( std::string &value, bool &isNull ) const;
253 
261  int getFnd0status( std::string &value, bool &isNull ) const;
262 
270  int getFnd0SummaryTask( tag_t &value, bool &isNull ) const;
271 
279  int getFnd0user_priv( int &value, bool &isNull ) const;
280 
288  int getFnd0WhatIfMode( int &value, bool &isNull ) const;
289 
297  int getIs_baseline( bool &value, bool &isNull ) const;
298 
306  int getIs_public( bool &value, bool &isNull ) const;
307 
315  int getIs_template( bool &value, bool &isNull ) const;
316 
324  int getItem_id( std::string &value, bool &isNull ) const;
325 
333  int getLatest_start_date( date_t &value, bool &isNull ) const;
334 
342  int getLinks_allowed( bool &value, bool &isNull ) const;
343 
351  int getNotifications_enabled( bool &value, bool &isNull ) const;
352 
360  int getPercent_linked( bool &value, bool &isNull ) const;
361 
369  int getPriority( int &value, bool &isNull ) const;
370 
378  int getPublished( bool &value, bool &isNull ) const;
379 
387  int getRecalc_type( int &value, bool &isNull ) const;
388 
396  int getRights_mask( int &value, bool &isNull ) const;
397 
405  int getSchedule_deliverable_list( std::vector< tag_t > &values, std::vector< int > &isNull ) const;
406 
414  int getSchedule_type( int &value, bool &isNull ) const;
415 
423  int getStart_date( date_t &value, bool &isNull ) const;
424 
432  int getWbsformat( std::string &value, bool &isNull ) const;
433 
441  int getWbsvalue( std::string &value, bool &isNull ) const;
442 
450  int setActiveschbaseline_tag( const tag_t &value, bool isNull=false );
451 
459  int setDates_linked( bool value, bool isNull=false );
460 
468  int setEarliest_finish_date( const date_t &value, bool isNull=false );
469 
477  int setEnd_date_scheduling( bool value, bool isNull=false );
478 
486  int setFinish_date( const date_t &value, bool isNull=false );
487 
495  int setFnd0allowExecUpdates( bool value, bool isNull=false );
496 
504  int setFnd0BudgetedEffortInt( int value, bool isNull=false );
505 
513  int setFnd0ForecastEndDate( const date_t &value, bool isNull=false );
514 
522  int setFnd0ForecastStartDate( const date_t &value, bool isNull=false );
523 
531  int setFnd0IsExternal( bool value, bool isNull=false );
532 
540  int setFnd0IsLegacy( bool value, bool isNull=false );
541 
549  int setFnd0master_sched( const tag_t &value, bool isNull=false );
550 
558  int setFnd0Schedulemember_taglist( const std::vector< tag_t > &values, const std::vector< int > *isNull=0 );
559 
567  int setFnd0ScheduleTemplate( const std::string &value, bool isNull=false );
568 
576  int setFnd0Schmgt_Lock( const tag_t &value, bool isNull=false );
577 
585  int setFnd0ShiftDate( const date_t &value, bool isNull=false );
586 
594  int setFnd0state( const std::string &value, bool isNull=false );
595 
603  int setFnd0status( const std::string &value, bool isNull=false );
604 
612  int setFnd0SummaryTask( const tag_t &value, bool isNull=false );
613 
621  int setFnd0user_priv( int value, bool isNull=false );
622 
630  int setFnd0WhatIfMode( int value, bool isNull=false );
631 
639  int setIs_baseline( bool value, bool isNull=false );
640 
648  int setIs_public( bool value, bool isNull=false );
649 
657  int setIs_template( bool value, bool isNull=false );
658 
666  int setItem_id( const std::string &value, bool isNull=false );
667 
675  int setLatest_start_date( const date_t &value, bool isNull=false );
676 
684  int setLinks_allowed( bool value, bool isNull=false );
685 
693  int setNotifications_enabled( bool value, bool isNull=false );
694 
702  int setPercent_linked( bool value, bool isNull=false );
703 
711  int setPriority( int value, bool isNull=false );
712 
720  int setPublished( bool value, bool isNull=false );
721 
729  int setRecalc_type( int value, bool isNull=false );
730 
738  int setRights_mask( int value, bool isNull=false );
739 
747  int setSchedule_deliverable_list( const std::vector< tag_t > &values, const std::vector< int > *isNull=0 );
748 
756  int setSchedule_type( int value, bool isNull=false );
757 
765  int setStart_date( const date_t &value, bool isNull=false );
766 
774  int setWbsformat( const std::string &value, bool isNull=false );
775 
783  int setWbsvalue( const std::string &value, bool isNull=false );
784 protected:
785  // Method to initialize
786  virtual void initialize( ::Teamcenter::RootObjectImpl* impl );
787 
791  Schedule();
792 
796  virtual ~Schedule();
797 
798 private:
799  // Getter method for the Implementation Object
800  ScheduleImpl* getScheduleImpl() const;
801  // Setter method for the Implementation Object
802  ::Teamcenter::RootObjectImpl* setScheduleImpl( ::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  ScheduleImpl* m_scheduleImpl;
809 
810  // Flag to indicate if Implementation object needs to be deleted
812 
816  static std::string name;
817 
822  Schedule( const Schedule& );
823  Schedule& operator=( const Schedule& );
824 
825  friend class ScheduleDelegate;
826  friend class ScheduleGenImpl;
827 };
828 
829 #include <schmgt/libschmgt_undef.h>
830 #endif // TEAMCENTER__SCHEDULE__HXX