NCBI C++ ToolKit
Cn3d_style_settings_.hpp
Go to the documentation of this file.

Go to the SVN repository for this file.

1 /* $Id$
2  * ===========================================================================
3  *
4  * PUBLIC DOMAIN NOTICE
5  * National Center for Biotechnology Information
6  *
7  * This software/database is a "United States Government Work" under the
8  * terms of the United States Copyright Act. It was written as part of
9  * the author's official duties as a United States Government employee and
10  * thus cannot be copyrighted. This software/database is freely available
11  * to the public for use. The National Library of Medicine and the U.S.
12  * Government have not placed any restriction on its use or reproduction.
13  *
14  * Although all reasonable efforts have been taken to ensure the accuracy
15  * and reliability of the software and data, the NLM and the U.S.
16  * Government do not and cannot warrant the performance or results that
17  * may be obtained by using this software or data. The NLM and the U.S.
18  * Government disclaim all warranties, express or implied, including
19  * warranties of performance, merchantability or fitness for any particular
20  * purpose.
21  *
22  * Please cite the author in any work or product based on this material.
23  *
24  * ===========================================================================
25  *
26  */
27 
28 /// @file Cn3d_style_settings_.hpp
29 /// Data storage class.
30 ///
31 /// This file was generated by application DATATOOL
32 /// using the following specifications:
33 /// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/objects/cn3d/cn3d.asn">cn3d.asn</a>
34 /// and additional tune-up parameters:
35 /// <a href="/IEB/ToolBox/CPP_DOC/lxr/source/src/objects/cn3d/cn3d.def">cn3d.def</a>
36 ///
37 /// ATTENTION:
38 /// Don't edit or commit this file into CVS as this file will
39 /// be overridden (by DATATOOL) without warning!
40 
41 #ifndef OBJECTS_CN3D_CN3D_STYLE_SETTINGS_BASE_HPP
42 #define OBJECTS_CN3D_CN3D_STYLE_SETTINGS_BASE_HPP
43 
44 // standard includes
45 #include <serial/serialbase.hpp>
46 
47 // generated includes
48 #include <string>
49 
51 
52 #ifndef BEGIN_objects_SCOPE
53 # define BEGIN_objects_SCOPE BEGIN_SCOPE(objects)
54 # define END_objects_SCOPE END_SCOPE(objects)
55 #endif
56 BEGIN_objects_SCOPE // namespace ncbi::objects::
57 
58 
59 // forward declarations
62 class CCn3d_color;
64 
65 
66 // generated classes
67 
68 
69 /** @addtogroup dataspec_NCBI_Cn3d
70  *
71  * @{
72  */
73 
74 /////////////////////////////////////////////////////////////////////////////
75 /// rendering settings for Cn3D (mirrors StyleSettings class)
76 ///
77 /// CCn3d_style_settings_Base --
78 ///
79 
81 {
83 public:
84  // constructor
86  // destructor
87  virtual ~CCn3d_style_settings_Base(void);
88 
89  // type info
91 
92  // types
93  typedef string TName;
105  typedef bool THydrogens_on;
107  typedef int TScale_factor;
109  typedef int TBall_radius;
110  typedef int TStick_radius;
111  typedef int TTube_radius;
112  typedef int TTube_worm_radius;
113  typedef int THelix_radius;
114  typedef int TStrand_width;
115  typedef int TStrand_thickness;
118  typedef bool TIon_labels;
119 
120  // member index
121  enum class E_memberIndex {
122  e__allMandatory = 0,
123  e_name,
124  e_protein_backbone,
125  e_nucleotide_backbone,
126  e_protein_sidechains,
127  e_nucleotide_sidechains,
128  e_heterogens,
129  e_solvents,
130  e_connections,
131  e_helix_objects,
132  e_strand_objects,
133  e_virtual_disulfides_on,
134  e_virtual_disulfide_color,
135  e_hydrogens_on,
136  e_background_color,
137  e_scale_factor,
138  e_space_fill_proportion,
139  e_ball_radius,
140  e_stick_radius,
141  e_tube_radius,
142  e_tube_worm_radius,
143  e_helix_radius,
144  e_strand_width,
145  e_strand_thickness,
146  e_protein_labels,
147  e_nucleotide_labels,
148  e_ion_labels
149  };
151 
152  // getters
153  // setters
154 
155  /// a name (for favorites)
156  /// Check if a value has been assigned to Name data member.
157  ///
158  /// Data member Name is optional;
159  /// its type is defined as 'typedef string TName'
160  /// @return
161  /// - true, if a value has been assigned.
162  /// - false, otherwise.
163  bool IsSetName(void) const;
164 
165  /// Check if it is safe to call GetName method.
166  ///
167  /// @return
168  /// - true, if the data member is getatable.
169  /// - false, otherwise.
170  bool CanGetName(void) const;
171 
172  /// Reset Name data member.
173  void ResetName(void);
174 
175  /// Get the Name member data.
176  ///
177  /// @return
178  /// Reference to the member data.
179  const TName& GetName(void) const;
180 
181  /// Assign a value to Name data member.
182  ///
183  /// @param value
184  /// Value to assign
185  void SetName(const TName& value);
186  void SetName(TName&& value);
187 
188  /// Assign a value to Name data member.
189  ///
190  /// @return
191  /// Reference to the data value.
192  TName& SetName(void);
193 
194  /// backbone styles
195  /// Check if a value has been assigned to Protein_backbone data member.
196  ///
197  /// Data member Protein_backbone is mandatory;
198  /// its type is defined as 'typedef CCn3d_backbone_style TProtein_backbone'
199  /// @return
200  /// - true, if a value has been assigned.
201  /// - false, otherwise.
202  bool IsSetProtein_backbone(void) const;
203 
204  /// Check if it is safe to call GetProtein_backbone method.
205  ///
206  /// @return
207  /// - true, if the data member is getatable.
208  /// - false, otherwise.
209  bool CanGetProtein_backbone(void) const;
210 
211  /// Reset Protein_backbone data member.
212  void ResetProtein_backbone(void);
213 
214  /// Get the Protein_backbone member data.
215  ///
216  /// @return
217  /// Reference to the member data.
218  const TProtein_backbone& GetProtein_backbone(void) const;
219 
220  /// Assign a value to Protein_backbone data member.
221  ///
222  /// @param value
223  /// Reference to value.
224  void SetProtein_backbone(TProtein_backbone& value);
225 
226  /// Assign a value to Protein_backbone data member.
227  ///
228  /// @return
229  /// Reference to the data value.
230  TProtein_backbone& SetProtein_backbone(void);
231 
232  /// Check if a value has been assigned to Nucleotide_backbone data member.
233  ///
234  /// Data member Nucleotide_backbone is mandatory;
235  /// its type is defined as 'typedef CCn3d_backbone_style TNucleotide_backbone'
236  /// @return
237  /// - true, if a value has been assigned.
238  /// - false, otherwise.
239  bool IsSetNucleotide_backbone(void) const;
240 
241  /// Check if it is safe to call GetNucleotide_backbone method.
242  ///
243  /// @return
244  /// - true, if the data member is getatable.
245  /// - false, otherwise.
246  bool CanGetNucleotide_backbone(void) const;
247 
248  /// Reset Nucleotide_backbone data member.
249  void ResetNucleotide_backbone(void);
250 
251  /// Get the Nucleotide_backbone member data.
252  ///
253  /// @return
254  /// Reference to the member data.
255  const TNucleotide_backbone& GetNucleotide_backbone(void) const;
256 
257  /// Assign a value to Nucleotide_backbone data member.
258  ///
259  /// @param value
260  /// Reference to value.
261  void SetNucleotide_backbone(TNucleotide_backbone& value);
262 
263  /// Assign a value to Nucleotide_backbone data member.
264  ///
265  /// @return
266  /// Reference to the data value.
267  TNucleotide_backbone& SetNucleotide_backbone(void);
268 
269  /// styles for other stuff
270  /// Check if a value has been assigned to Protein_sidechains data member.
271  ///
272  /// Data member Protein_sidechains is mandatory;
273  /// its type is defined as 'typedef CCn3d_general_style TProtein_sidechains'
274  /// @return
275  /// - true, if a value has been assigned.
276  /// - false, otherwise.
277  bool IsSetProtein_sidechains(void) const;
278 
279  /// Check if it is safe to call GetProtein_sidechains method.
280  ///
281  /// @return
282  /// - true, if the data member is getatable.
283  /// - false, otherwise.
284  bool CanGetProtein_sidechains(void) const;
285 
286  /// Reset Protein_sidechains data member.
287  void ResetProtein_sidechains(void);
288 
289  /// Get the Protein_sidechains member data.
290  ///
291  /// @return
292  /// Reference to the member data.
293  const TProtein_sidechains& GetProtein_sidechains(void) const;
294 
295  /// Assign a value to Protein_sidechains data member.
296  ///
297  /// @param value
298  /// Reference to value.
299  void SetProtein_sidechains(TProtein_sidechains& value);
300 
301  /// Assign a value to Protein_sidechains data member.
302  ///
303  /// @return
304  /// Reference to the data value.
305  TProtein_sidechains& SetProtein_sidechains(void);
306 
307  /// Check if a value has been assigned to Nucleotide_sidechains data member.
308  ///
309  /// Data member Nucleotide_sidechains is mandatory;
310  /// its type is defined as 'typedef CCn3d_general_style TNucleotide_sidechains'
311  /// @return
312  /// - true, if a value has been assigned.
313  /// - false, otherwise.
314  bool IsSetNucleotide_sidechains(void) const;
315 
316  /// Check if it is safe to call GetNucleotide_sidechains method.
317  ///
318  /// @return
319  /// - true, if the data member is getatable.
320  /// - false, otherwise.
321  bool CanGetNucleotide_sidechains(void) const;
322 
323  /// Reset Nucleotide_sidechains data member.
324  void ResetNucleotide_sidechains(void);
325 
326  /// Get the Nucleotide_sidechains member data.
327  ///
328  /// @return
329  /// Reference to the member data.
330  const TNucleotide_sidechains& GetNucleotide_sidechains(void) const;
331 
332  /// Assign a value to Nucleotide_sidechains data member.
333  ///
334  /// @param value
335  /// Reference to value.
336  void SetNucleotide_sidechains(TNucleotide_sidechains& value);
337 
338  /// Assign a value to Nucleotide_sidechains data member.
339  ///
340  /// @return
341  /// Reference to the data value.
342  TNucleotide_sidechains& SetNucleotide_sidechains(void);
343 
344  /// Check if a value has been assigned to Heterogens data member.
345  ///
346  /// Data member Heterogens is mandatory;
347  /// its type is defined as 'typedef CCn3d_general_style THeterogens'
348  /// @return
349  /// - true, if a value has been assigned.
350  /// - false, otherwise.
351  bool IsSetHeterogens(void) const;
352 
353  /// Check if it is safe to call GetHeterogens method.
354  ///
355  /// @return
356  /// - true, if the data member is getatable.
357  /// - false, otherwise.
358  bool CanGetHeterogens(void) const;
359 
360  /// Reset Heterogens data member.
361  void ResetHeterogens(void);
362 
363  /// Get the Heterogens member data.
364  ///
365  /// @return
366  /// Reference to the member data.
367  const THeterogens& GetHeterogens(void) const;
368 
369  /// Assign a value to Heterogens data member.
370  ///
371  /// @param value
372  /// Reference to value.
373  void SetHeterogens(THeterogens& value);
374 
375  /// Assign a value to Heterogens data member.
376  ///
377  /// @return
378  /// Reference to the data value.
379  THeterogens& SetHeterogens(void);
380 
381  /// Check if a value has been assigned to Solvents data member.
382  ///
383  /// Data member Solvents is mandatory;
384  /// its type is defined as 'typedef CCn3d_general_style TSolvents'
385  /// @return
386  /// - true, if a value has been assigned.
387  /// - false, otherwise.
388  bool IsSetSolvents(void) const;
389 
390  /// Check if it is safe to call GetSolvents method.
391  ///
392  /// @return
393  /// - true, if the data member is getatable.
394  /// - false, otherwise.
395  bool CanGetSolvents(void) const;
396 
397  /// Reset Solvents data member.
398  void ResetSolvents(void);
399 
400  /// Get the Solvents member data.
401  ///
402  /// @return
403  /// Reference to the member data.
404  const TSolvents& GetSolvents(void) const;
405 
406  /// Assign a value to Solvents data member.
407  ///
408  /// @param value
409  /// Reference to value.
410  void SetSolvents(TSolvents& value);
411 
412  /// Assign a value to Solvents data member.
413  ///
414  /// @return
415  /// Reference to the data value.
416  TSolvents& SetSolvents(void);
417 
418  /// Check if a value has been assigned to Connections data member.
419  ///
420  /// Data member Connections is mandatory;
421  /// its type is defined as 'typedef CCn3d_general_style TConnections'
422  /// @return
423  /// - true, if a value has been assigned.
424  /// - false, otherwise.
425  bool IsSetConnections(void) const;
426 
427  /// Check if it is safe to call GetConnections method.
428  ///
429  /// @return
430  /// - true, if the data member is getatable.
431  /// - false, otherwise.
432  bool CanGetConnections(void) const;
433 
434  /// Reset Connections data member.
435  void ResetConnections(void);
436 
437  /// Get the Connections member data.
438  ///
439  /// @return
440  /// Reference to the member data.
441  const TConnections& GetConnections(void) const;
442 
443  /// Assign a value to Connections data member.
444  ///
445  /// @param value
446  /// Reference to value.
447  void SetConnections(TConnections& value);
448 
449  /// Assign a value to Connections data member.
450  ///
451  /// @return
452  /// Reference to the data value.
453  TConnections& SetConnections(void);
454 
455  /// Check if a value has been assigned to Helix_objects data member.
456  ///
457  /// Data member Helix_objects is mandatory;
458  /// its type is defined as 'typedef CCn3d_general_style THelix_objects'
459  /// @return
460  /// - true, if a value has been assigned.
461  /// - false, otherwise.
462  bool IsSetHelix_objects(void) const;
463 
464  /// Check if it is safe to call GetHelix_objects method.
465  ///
466  /// @return
467  /// - true, if the data member is getatable.
468  /// - false, otherwise.
469  bool CanGetHelix_objects(void) const;
470 
471  /// Reset Helix_objects data member.
472  void ResetHelix_objects(void);
473 
474  /// Get the Helix_objects member data.
475  ///
476  /// @return
477  /// Reference to the member data.
478  const THelix_objects& GetHelix_objects(void) const;
479 
480  /// Assign a value to Helix_objects data member.
481  ///
482  /// @param value
483  /// Reference to value.
484  void SetHelix_objects(THelix_objects& value);
485 
486  /// Assign a value to Helix_objects data member.
487  ///
488  /// @return
489  /// Reference to the data value.
490  THelix_objects& SetHelix_objects(void);
491 
492  /// Check if a value has been assigned to Strand_objects data member.
493  ///
494  /// Data member Strand_objects is mandatory;
495  /// its type is defined as 'typedef CCn3d_general_style TStrand_objects'
496  /// @return
497  /// - true, if a value has been assigned.
498  /// - false, otherwise.
499  bool IsSetStrand_objects(void) const;
500 
501  /// Check if it is safe to call GetStrand_objects method.
502  ///
503  /// @return
504  /// - true, if the data member is getatable.
505  /// - false, otherwise.
506  bool CanGetStrand_objects(void) const;
507 
508  /// Reset Strand_objects data member.
509  void ResetStrand_objects(void);
510 
511  /// Get the Strand_objects member data.
512  ///
513  /// @return
514  /// Reference to the member data.
515  const TStrand_objects& GetStrand_objects(void) const;
516 
517  /// Assign a value to Strand_objects data member.
518  ///
519  /// @param value
520  /// Reference to value.
521  void SetStrand_objects(TStrand_objects& value);
522 
523  /// Assign a value to Strand_objects data member.
524  ///
525  /// @return
526  /// Reference to the data value.
527  TStrand_objects& SetStrand_objects(void);
528 
529  /// virtual disulfides
530  /// Check if a value has been assigned to Virtual_disulfides_on data member.
531  ///
532  /// Data member Virtual_disulfides_on is mandatory;
533  /// its type is defined as 'typedef bool TVirtual_disulfides_on'
534  /// @return
535  /// - true, if a value has been assigned.
536  /// - false, otherwise.
537  bool IsSetVirtual_disulfides_on(void) const;
538 
539  /// Check if it is safe to call GetVirtual_disulfides_on method.
540  ///
541  /// @return
542  /// - true, if the data member is getatable.
543  /// - false, otherwise.
544  bool CanGetVirtual_disulfides_on(void) const;
545 
546  /// Reset Virtual_disulfides_on data member.
547  void ResetVirtual_disulfides_on(void);
548 
549  /// Get the Virtual_disulfides_on member data.
550  ///
551  /// @return
552  /// Copy of the member data.
553  TVirtual_disulfides_on GetVirtual_disulfides_on(void) const;
554 
555  /// Assign a value to Virtual_disulfides_on data member.
556  ///
557  /// @param value
558  /// Value to assign
559  void SetVirtual_disulfides_on(TVirtual_disulfides_on value);
560 
561  /// Assign a value to Virtual_disulfides_on data member.
562  ///
563  /// @return
564  /// Reference to the data value.
565  TVirtual_disulfides_on& SetVirtual_disulfides_on(void);
566 
567  /// Check if a value has been assigned to Virtual_disulfide_color data member.
568  ///
569  /// Data member Virtual_disulfide_color is mandatory;
570  /// its type is defined as 'typedef CCn3d_color TVirtual_disulfide_color'
571  /// @return
572  /// - true, if a value has been assigned.
573  /// - false, otherwise.
574  bool IsSetVirtual_disulfide_color(void) const;
575 
576  /// Check if it is safe to call GetVirtual_disulfide_color method.
577  ///
578  /// @return
579  /// - true, if the data member is getatable.
580  /// - false, otherwise.
581  bool CanGetVirtual_disulfide_color(void) const;
582 
583  /// Reset Virtual_disulfide_color data member.
584  void ResetVirtual_disulfide_color(void);
585 
586  /// Get the Virtual_disulfide_color member data.
587  ///
588  /// @return
589  /// Reference to the member data.
590  const TVirtual_disulfide_color& GetVirtual_disulfide_color(void) const;
591 
592  /// Assign a value to Virtual_disulfide_color data member.
593  ///
594  /// @param value
595  /// Reference to value.
596  void SetVirtual_disulfide_color(TVirtual_disulfide_color& value);
597 
598  /// Assign a value to Virtual_disulfide_color data member.
599  ///
600  /// @return
601  /// Reference to the data value.
602  TVirtual_disulfide_color& SetVirtual_disulfide_color(void);
603 
604  /// hydrogens
605  /// Check if a value has been assigned to Hydrogens_on data member.
606  ///
607  /// Data member Hydrogens_on is mandatory;
608  /// its type is defined as 'typedef bool THydrogens_on'
609  /// @return
610  /// - true, if a value has been assigned.
611  /// - false, otherwise.
612  bool IsSetHydrogens_on(void) const;
613 
614  /// Check if it is safe to call GetHydrogens_on method.
615  ///
616  /// @return
617  /// - true, if the data member is getatable.
618  /// - false, otherwise.
619  bool CanGetHydrogens_on(void) const;
620 
621  /// Reset Hydrogens_on data member.
622  void ResetHydrogens_on(void);
623 
624  /// Get the Hydrogens_on member data.
625  ///
626  /// @return
627  /// Copy of the member data.
628  THydrogens_on GetHydrogens_on(void) const;
629 
630  /// Assign a value to Hydrogens_on data member.
631  ///
632  /// @param value
633  /// Value to assign
634  void SetHydrogens_on(THydrogens_on value);
635 
636  /// Assign a value to Hydrogens_on data member.
637  ///
638  /// @return
639  /// Reference to the data value.
640  THydrogens_on& SetHydrogens_on(void);
641 
642  /// background
643  /// floating point parameters - scale-factor applies to all the following:
644  /// Check if a value has been assigned to Background_color data member.
645  ///
646  /// Data member Background_color is mandatory;
647  /// its type is defined as 'typedef CCn3d_color TBackground_color'
648  /// @return
649  /// - true, if a value has been assigned.
650  /// - false, otherwise.
651  bool IsSetBackground_color(void) const;
652 
653  /// Check if it is safe to call GetBackground_color method.
654  ///
655  /// @return
656  /// - true, if the data member is getatable.
657  /// - false, otherwise.
658  bool CanGetBackground_color(void) const;
659 
660  /// Reset Background_color data member.
661  void ResetBackground_color(void);
662 
663  /// Get the Background_color member data.
664  ///
665  /// @return
666  /// Reference to the member data.
667  const TBackground_color& GetBackground_color(void) const;
668 
669  /// Assign a value to Background_color data member.
670  ///
671  /// @param value
672  /// Reference to value.
673  void SetBackground_color(TBackground_color& value);
674 
675  /// Assign a value to Background_color data member.
676  ///
677  /// @return
678  /// Reference to the data value.
679  TBackground_color& SetBackground_color(void);
680 
681  /// Check if a value has been assigned to Scale_factor data member.
682  ///
683  /// Data member Scale_factor is mandatory;
684  /// its type is defined as 'typedef int TScale_factor'
685  /// @return
686  /// - true, if a value has been assigned.
687  /// - false, otherwise.
688  bool IsSetScale_factor(void) const;
689 
690  /// Check if it is safe to call GetScale_factor method.
691  ///
692  /// @return
693  /// - true, if the data member is getatable.
694  /// - false, otherwise.
695  bool CanGetScale_factor(void) const;
696 
697  /// Reset Scale_factor data member.
698  void ResetScale_factor(void);
699 
700  /// Get the Scale_factor member data.
701  ///
702  /// @return
703  /// Copy of the member data.
704  TScale_factor GetScale_factor(void) const;
705 
706  /// Assign a value to Scale_factor data member.
707  ///
708  /// @param value
709  /// Value to assign
710  void SetScale_factor(TScale_factor value);
711 
712  /// Assign a value to Scale_factor data member.
713  ///
714  /// @return
715  /// Reference to the data value.
716  TScale_factor& SetScale_factor(void);
717 
718  /// Check if a value has been assigned to Space_fill_proportion data member.
719  ///
720  /// Data member Space_fill_proportion is mandatory;
721  /// its type is defined as 'typedef int TSpace_fill_proportion'
722  /// @return
723  /// - true, if a value has been assigned.
724  /// - false, otherwise.
725  bool IsSetSpace_fill_proportion(void) const;
726 
727  /// Check if it is safe to call GetSpace_fill_proportion method.
728  ///
729  /// @return
730  /// - true, if the data member is getatable.
731  /// - false, otherwise.
732  bool CanGetSpace_fill_proportion(void) const;
733 
734  /// Reset Space_fill_proportion data member.
735  void ResetSpace_fill_proportion(void);
736 
737  /// Get the Space_fill_proportion member data.
738  ///
739  /// @return
740  /// Copy of the member data.
741  TSpace_fill_proportion GetSpace_fill_proportion(void) const;
742 
743  /// Assign a value to Space_fill_proportion data member.
744  ///
745  /// @param value
746  /// Value to assign
747  void SetSpace_fill_proportion(TSpace_fill_proportion value);
748 
749  /// Assign a value to Space_fill_proportion data member.
750  ///
751  /// @return
752  /// Reference to the data value.
753  TSpace_fill_proportion& SetSpace_fill_proportion(void);
754 
755  /// Check if a value has been assigned to Ball_radius data member.
756  ///
757  /// Data member Ball_radius is mandatory;
758  /// its type is defined as 'typedef int TBall_radius'
759  /// @return
760  /// - true, if a value has been assigned.
761  /// - false, otherwise.
762  bool IsSetBall_radius(void) const;
763 
764  /// Check if it is safe to call GetBall_radius method.
765  ///
766  /// @return
767  /// - true, if the data member is getatable.
768  /// - false, otherwise.
769  bool CanGetBall_radius(void) const;
770 
771  /// Reset Ball_radius data member.
772  void ResetBall_radius(void);
773 
774  /// Get the Ball_radius member data.
775  ///
776  /// @return
777  /// Copy of the member data.
778  TBall_radius GetBall_radius(void) const;
779 
780  /// Assign a value to Ball_radius data member.
781  ///
782  /// @param value
783  /// Value to assign
784  void SetBall_radius(TBall_radius value);
785 
786  /// Assign a value to Ball_radius data member.
787  ///
788  /// @return
789  /// Reference to the data value.
790  TBall_radius& SetBall_radius(void);
791 
792  /// Check if a value has been assigned to Stick_radius data member.
793  ///
794  /// Data member Stick_radius is mandatory;
795  /// its type is defined as 'typedef int TStick_radius'
796  /// @return
797  /// - true, if a value has been assigned.
798  /// - false, otherwise.
799  bool IsSetStick_radius(void) const;
800 
801  /// Check if it is safe to call GetStick_radius method.
802  ///
803  /// @return
804  /// - true, if the data member is getatable.
805  /// - false, otherwise.
806  bool CanGetStick_radius(void) const;
807 
808  /// Reset Stick_radius data member.
809  void ResetStick_radius(void);
810 
811  /// Get the Stick_radius member data.
812  ///
813  /// @return
814  /// Copy of the member data.
815  TStick_radius GetStick_radius(void) const;
816 
817  /// Assign a value to Stick_radius data member.
818  ///
819  /// @param value
820  /// Value to assign
821  void SetStick_radius(TStick_radius value);
822 
823  /// Assign a value to Stick_radius data member.
824  ///
825  /// @return
826  /// Reference to the data value.
827  TStick_radius& SetStick_radius(void);
828 
829  /// Check if a value has been assigned to Tube_radius data member.
830  ///
831  /// Data member Tube_radius is mandatory;
832  /// its type is defined as 'typedef int TTube_radius'
833  /// @return
834  /// - true, if a value has been assigned.
835  /// - false, otherwise.
836  bool IsSetTube_radius(void) const;
837 
838  /// Check if it is safe to call GetTube_radius method.
839  ///
840  /// @return
841  /// - true, if the data member is getatable.
842  /// - false, otherwise.
843  bool CanGetTube_radius(void) const;
844 
845  /// Reset Tube_radius data member.
846  void ResetTube_radius(void);
847 
848  /// Get the Tube_radius member data.
849  ///
850  /// @return
851  /// Copy of the member data.
852  TTube_radius GetTube_radius(void) const;
853 
854  /// Assign a value to Tube_radius data member.
855  ///
856  /// @param value
857  /// Value to assign
858  void SetTube_radius(TTube_radius value);
859 
860  /// Assign a value to Tube_radius data member.
861  ///
862  /// @return
863  /// Reference to the data value.
864  TTube_radius& SetTube_radius(void);
865 
866  /// Check if a value has been assigned to Tube_worm_radius data member.
867  ///
868  /// Data member Tube_worm_radius is mandatory;
869  /// its type is defined as 'typedef int TTube_worm_radius'
870  /// @return
871  /// - true, if a value has been assigned.
872  /// - false, otherwise.
873  bool IsSetTube_worm_radius(void) const;
874 
875  /// Check if it is safe to call GetTube_worm_radius method.
876  ///
877  /// @return
878  /// - true, if the data member is getatable.
879  /// - false, otherwise.
880  bool CanGetTube_worm_radius(void) const;
881 
882  /// Reset Tube_worm_radius data member.
883  void ResetTube_worm_radius(void);
884 
885  /// Get the Tube_worm_radius member data.
886  ///
887  /// @return
888  /// Copy of the member data.
889  TTube_worm_radius GetTube_worm_radius(void) const;
890 
891  /// Assign a value to Tube_worm_radius data member.
892  ///
893  /// @param value
894  /// Value to assign
895  void SetTube_worm_radius(TTube_worm_radius value);
896 
897  /// Assign a value to Tube_worm_radius data member.
898  ///
899  /// @return
900  /// Reference to the data value.
901  TTube_worm_radius& SetTube_worm_radius(void);
902 
903  /// Check if a value has been assigned to Helix_radius data member.
904  ///
905  /// Data member Helix_radius is mandatory;
906  /// its type is defined as 'typedef int THelix_radius'
907  /// @return
908  /// - true, if a value has been assigned.
909  /// - false, otherwise.
910  bool IsSetHelix_radius(void) const;
911 
912  /// Check if it is safe to call GetHelix_radius method.
913  ///
914  /// @return
915  /// - true, if the data member is getatable.
916  /// - false, otherwise.
917  bool CanGetHelix_radius(void) const;
918 
919  /// Reset Helix_radius data member.
920  void ResetHelix_radius(void);
921 
922  /// Get the Helix_radius member data.
923  ///
924  /// @return
925  /// Copy of the member data.
926  THelix_radius GetHelix_radius(void) const;
927 
928  /// Assign a value to Helix_radius data member.
929  ///
930  /// @param value
931  /// Value to assign
932  void SetHelix_radius(THelix_radius value);
933 
934  /// Assign a value to Helix_radius data member.
935  ///
936  /// @return
937  /// Reference to the data value.
938  THelix_radius& SetHelix_radius(void);
939 
940  /// Check if a value has been assigned to Strand_width data member.
941  ///
942  /// Data member Strand_width is mandatory;
943  /// its type is defined as 'typedef int TStrand_width'
944  /// @return
945  /// - true, if a value has been assigned.
946  /// - false, otherwise.
947  bool IsSetStrand_width(void) const;
948 
949  /// Check if it is safe to call GetStrand_width method.
950  ///
951  /// @return
952  /// - true, if the data member is getatable.
953  /// - false, otherwise.
954  bool CanGetStrand_width(void) const;
955 
956  /// Reset Strand_width data member.
957  void ResetStrand_width(void);
958 
959  /// Get the Strand_width member data.
960  ///
961  /// @return
962  /// Copy of the member data.
963  TStrand_width GetStrand_width(void) const;
964 
965  /// Assign a value to Strand_width data member.
966  ///
967  /// @param value
968  /// Value to assign
969  void SetStrand_width(TStrand_width value);
970 
971  /// Assign a value to Strand_width data member.
972  ///
973  /// @return
974  /// Reference to the data value.
975  TStrand_width& SetStrand_width(void);
976 
977  /// Check if a value has been assigned to Strand_thickness data member.
978  ///
979  /// Data member Strand_thickness is mandatory;
980  /// its type is defined as 'typedef int TStrand_thickness'
981  /// @return
982  /// - true, if a value has been assigned.
983  /// - false, otherwise.
984  bool IsSetStrand_thickness(void) const;
985 
986  /// Check if it is safe to call GetStrand_thickness method.
987  ///
988  /// @return
989  /// - true, if the data member is getatable.
990  /// - false, otherwise.
991  bool CanGetStrand_thickness(void) const;
992 
993  /// Reset Strand_thickness data member.
994  void ResetStrand_thickness(void);
995 
996  /// Get the Strand_thickness member data.
997  ///
998  /// @return
999  /// Copy of the member data.
1000  TStrand_thickness GetStrand_thickness(void) const;
1001 
1002  /// Assign a value to Strand_thickness data member.
1003  ///
1004  /// @param value
1005  /// Value to assign
1006  void SetStrand_thickness(TStrand_thickness value);
1007 
1008  /// Assign a value to Strand_thickness data member.
1009  ///
1010  /// @return
1011  /// Reference to the data value.
1012  TStrand_thickness& SetStrand_thickness(void);
1013 
1014  /// backbone labels (no labels if not present)
1015  /// Check if a value has been assigned to Protein_labels data member.
1016  ///
1017  /// Data member Protein_labels is optional;
1018  /// its type is defined as 'typedef CCn3d_backbone_label_style TProtein_labels'
1019  /// @return
1020  /// - true, if a value has been assigned.
1021  /// - false, otherwise.
1022  bool IsSetProtein_labels(void) const;
1023 
1024  /// Check if it is safe to call GetProtein_labels method.
1025  ///
1026  /// @return
1027  /// - true, if the data member is getatable.
1028  /// - false, otherwise.
1029  bool CanGetProtein_labels(void) const;
1030 
1031  /// Reset Protein_labels data member.
1032  void ResetProtein_labels(void);
1033 
1034  /// Get the Protein_labels member data.
1035  ///
1036  /// @return
1037  /// Reference to the member data.
1038  const TProtein_labels& GetProtein_labels(void) const;
1039 
1040  /// Assign a value to Protein_labels data member.
1041  ///
1042  /// @param value
1043  /// Reference to value.
1044  void SetProtein_labels(TProtein_labels& value);
1045 
1046  /// Assign a value to Protein_labels data member.
1047  ///
1048  /// @return
1049  /// Reference to the data value.
1050  TProtein_labels& SetProtein_labels(void);
1051 
1052  /// Check if a value has been assigned to Nucleotide_labels data member.
1053  ///
1054  /// Data member Nucleotide_labels is optional;
1055  /// its type is defined as 'typedef CCn3d_backbone_label_style TNucleotide_labels'
1056  /// @return
1057  /// - true, if a value has been assigned.
1058  /// - false, otherwise.
1059  bool IsSetNucleotide_labels(void) const;
1060 
1061  /// Check if it is safe to call GetNucleotide_labels method.
1062  ///
1063  /// @return
1064  /// - true, if the data member is getatable.
1065  /// - false, otherwise.
1066  bool CanGetNucleotide_labels(void) const;
1067 
1068  /// Reset Nucleotide_labels data member.
1069  void ResetNucleotide_labels(void);
1070 
1071  /// Get the Nucleotide_labels member data.
1072  ///
1073  /// @return
1074  /// Reference to the member data.
1075  const TNucleotide_labels& GetNucleotide_labels(void) const;
1076 
1077  /// Assign a value to Nucleotide_labels data member.
1078  ///
1079  /// @param value
1080  /// Reference to value.
1081  void SetNucleotide_labels(TNucleotide_labels& value);
1082 
1083  /// Assign a value to Nucleotide_labels data member.
1084  ///
1085  /// @return
1086  /// Reference to the data value.
1087  TNucleotide_labels& SetNucleotide_labels(void);
1088 
1089  /// ion labels
1090  /// Check if a value has been assigned to Ion_labels data member.
1091  ///
1092  /// Data member Ion_labels is optional;
1093  /// its type is defined as 'typedef bool TIon_labels'
1094  /// @return
1095  /// - true, if a value has been assigned.
1096  /// - false, otherwise.
1097  bool IsSetIon_labels(void) const;
1098 
1099  /// Check if it is safe to call GetIon_labels method.
1100  ///
1101  /// @return
1102  /// - true, if the data member is getatable.
1103  /// - false, otherwise.
1104  bool CanGetIon_labels(void) const;
1105 
1106  /// Reset Ion_labels data member.
1107  void ResetIon_labels(void);
1108 
1109  /// Get the Ion_labels member data.
1110  ///
1111  /// @return
1112  /// Copy of the member data.
1113  TIon_labels GetIon_labels(void) const;
1114 
1115  /// Assign a value to Ion_labels data member.
1116  ///
1117  /// @param value
1118  /// Value to assign
1119  void SetIon_labels(TIon_labels value);
1120 
1121  /// Assign a value to Ion_labels data member.
1122  ///
1123  /// @return
1124  /// Reference to the data value.
1125  TIon_labels& SetIon_labels(void);
1126 
1127  /// Reset the whole object
1128  virtual void Reset(void);
1129 
1130 
1131 private:
1132  // Prohibit copy constructor and assignment operator
1135 
1136  // data
1137  Uint4 m_set_State[2];
1138  string m_Name;
1164 };
1165 
1166 /* @} */
1167 
1168 
1169 
1170 
1171 
1172 ///////////////////////////////////////////////////////////
1173 ///////////////////// inline methods //////////////////////
1174 ///////////////////////////////////////////////////////////
1175 inline
1177 {
1178  return ((m_set_State[0] & 0x3) != 0);
1179 }
1180 
1181 inline
1183 {
1184  return IsSetName();
1185 }
1186 
1187 inline
1189 {
1190  if (!CanGetName()) {
1191  ThrowUnassigned(0);
1192  }
1193  return m_Name;
1194 }
1195 
1196 inline
1198 {
1199  m_Name = value;
1200  m_set_State[0] |= 0x3;
1201 }
1202 
1203 inline
1205 {
1206  m_Name = std::forward<CCn3d_style_settings_Base::TName>(value);
1207  m_set_State[0] |= 0x3;
1208 }
1209 
1210 inline
1212 {
1213 #ifdef _DEBUG
1214  if (!IsSetName()) {
1216  }
1217 #endif
1218  m_set_State[0] |= 0x1;
1219  return m_Name;
1220 }
1221 
1222 inline
1224 {
1225  return m_Protein_backbone.NotEmpty();
1226 }
1227 
1228 inline
1230 {
1231  return true;
1232 }
1233 
1234 inline
1236 {
1237  if ( !m_Protein_backbone ) {
1238  const_cast<CCn3d_style_settings_Base*>(this)->ResetProtein_backbone();
1239  }
1240  return (*m_Protein_backbone);
1241 }
1242 
1243 inline
1245 {
1246  if ( !m_Protein_backbone ) {
1248  }
1249  return (*m_Protein_backbone);
1250 }
1251 
1252 inline
1254 {
1255  return m_Nucleotide_backbone.NotEmpty();
1256 }
1257 
1258 inline
1260 {
1261  return true;
1262 }
1263 
1264 inline
1266 {
1267  if ( !m_Nucleotide_backbone ) {
1269  }
1270  return (*m_Nucleotide_backbone);
1271 }
1272 
1273 inline
1275 {
1276  if ( !m_Nucleotide_backbone ) {
1278  }
1279  return (*m_Nucleotide_backbone);
1280 }
1281 
1282 inline
1284 {
1285  return m_Protein_sidechains.NotEmpty();
1286 }
1287 
1288 inline
1290 {
1291  return true;
1292 }
1293 
1294 inline
1296 {
1297  if ( !m_Protein_sidechains ) {
1298  const_cast<CCn3d_style_settings_Base*>(this)->ResetProtein_sidechains();
1299  }
1300  return (*m_Protein_sidechains);
1301 }
1302 
1303 inline
1305 {
1306  if ( !m_Protein_sidechains ) {
1308  }
1309  return (*m_Protein_sidechains);
1310 }
1311 
1312 inline
1314 {
1315  return m_Nucleotide_sidechains.NotEmpty();
1316 }
1317 
1318 inline
1320 {
1321  return true;
1322 }
1323 
1324 inline
1326 {
1327  if ( !m_Nucleotide_sidechains ) {
1329  }
1330  return (*m_Nucleotide_sidechains);
1331 }
1332 
1333 inline
1335 {
1336  if ( !m_Nucleotide_sidechains ) {
1338  }
1339  return (*m_Nucleotide_sidechains);
1340 }
1341 
1342 inline
1344 {
1345  return m_Heterogens.NotEmpty();
1346 }
1347 
1348 inline
1350 {
1351  return true;
1352 }
1353 
1354 inline
1356 {
1357  if ( !m_Heterogens ) {
1358  const_cast<CCn3d_style_settings_Base*>(this)->ResetHeterogens();
1359  }
1360  return (*m_Heterogens);
1361 }
1362 
1363 inline
1365 {
1366  if ( !m_Heterogens ) {
1367  ResetHeterogens();
1368  }
1369  return (*m_Heterogens);
1370 }
1371 
1372 inline
1374 {
1375  return m_Solvents.NotEmpty();
1376 }
1377 
1378 inline
1380 {
1381  return true;
1382 }
1383 
1384 inline
1386 {
1387  if ( !m_Solvents ) {
1388  const_cast<CCn3d_style_settings_Base*>(this)->ResetSolvents();
1389  }
1390  return (*m_Solvents);
1391 }
1392 
1393 inline
1395 {
1396  if ( !m_Solvents ) {
1397  ResetSolvents();
1398  }
1399  return (*m_Solvents);
1400 }
1401 
1402 inline
1404 {
1405  return m_Connections.NotEmpty();
1406 }
1407 
1408 inline
1410 {
1411  return true;
1412 }
1413 
1414 inline
1416 {
1417  if ( !m_Connections ) {
1418  const_cast<CCn3d_style_settings_Base*>(this)->ResetConnections();
1419  }
1420  return (*m_Connections);
1421 }
1422 
1423 inline
1425 {
1426  if ( !m_Connections ) {
1427  ResetConnections();
1428  }
1429  return (*m_Connections);
1430 }
1431 
1432 inline
1434 {
1435  return m_Helix_objects.NotEmpty();
1436 }
1437 
1438 inline
1440 {
1441  return true;
1442 }
1443 
1444 inline
1446 {
1447  if ( !m_Helix_objects ) {
1448  const_cast<CCn3d_style_settings_Base*>(this)->ResetHelix_objects();
1449  }
1450  return (*m_Helix_objects);
1451 }
1452 
1453 inline
1455 {
1456  if ( !m_Helix_objects ) {
1458  }
1459  return (*m_Helix_objects);
1460 }
1461 
1462 inline
1464 {
1465  return m_Strand_objects.NotEmpty();
1466 }
1467 
1468 inline
1470 {
1471  return true;
1472 }
1473 
1474 inline
1476 {
1477  if ( !m_Strand_objects ) {
1478  const_cast<CCn3d_style_settings_Base*>(this)->ResetStrand_objects();
1479  }
1480  return (*m_Strand_objects);
1481 }
1482 
1483 inline
1485 {
1486  if ( !m_Strand_objects ) {
1488  }
1489  return (*m_Strand_objects);
1490 }
1491 
1492 inline
1494 {
1495  return ((m_set_State[0] & 0x300000) != 0);
1496 }
1497 
1498 inline
1500 {
1501  return IsSetVirtual_disulfides_on();
1502 }
1503 
1504 inline
1506 {
1508  m_set_State[0] &= ~0x300000;
1509 }
1510 
1511 inline
1513 {
1514  if (!CanGetVirtual_disulfides_on()) {
1515  ThrowUnassigned(10);
1516  }
1517  return m_Virtual_disulfides_on;
1518 }
1519 
1520 inline
1522 {
1524  m_set_State[0] |= 0x300000;
1525 }
1526 
1527 inline
1529 {
1530 #ifdef _DEBUG
1531  if (!IsSetVirtual_disulfides_on()) {
1533  }
1534 #endif
1535  m_set_State[0] |= 0x100000;
1536  return m_Virtual_disulfides_on;
1537 }
1538 
1539 inline
1541 {
1542  return m_Virtual_disulfide_color.NotEmpty();
1543 }
1544 
1545 inline
1547 {
1548  return true;
1549 }
1550 
1551 inline
1553 {
1554  if ( !m_Virtual_disulfide_color ) {
1556  }
1557  return (*m_Virtual_disulfide_color);
1558 }
1559 
1560 inline
1562 {
1563  if ( !m_Virtual_disulfide_color ) {
1565  }
1566  return (*m_Virtual_disulfide_color);
1567 }
1568 
1569 inline
1571 {
1572  return ((m_set_State[0] & 0x3000000) != 0);
1573 }
1574 
1575 inline
1577 {
1578  return IsSetHydrogens_on();
1579 }
1580 
1581 inline
1583 {
1584  m_Hydrogens_on = 0;
1585  m_set_State[0] &= ~0x3000000;
1586 }
1587 
1588 inline
1590 {
1591  if (!CanGetHydrogens_on()) {
1592  ThrowUnassigned(12);
1593  }
1594  return m_Hydrogens_on;
1595 }
1596 
1597 inline
1599 {
1601  m_set_State[0] |= 0x3000000;
1602 }
1603 
1604 inline
1606 {
1607 #ifdef _DEBUG
1608  if (!IsSetHydrogens_on()) {
1609  memset(&m_Hydrogens_on,UnassignedByte(),sizeof(m_Hydrogens_on));
1610  }
1611 #endif
1612  m_set_State[0] |= 0x1000000;
1613  return m_Hydrogens_on;
1614 }
1615 
1616 inline
1618 {
1619  return m_Background_color.NotEmpty();
1620 }
1621 
1622 inline
1624 {
1625  return true;
1626 }
1627 
1628 inline
1630 {
1631  if ( !m_Background_color ) {
1632  const_cast<CCn3d_style_settings_Base*>(this)->ResetBackground_color();
1633  }
1634  return (*m_Background_color);
1635 }
1636 
1637 inline
1639 {
1640  if ( !m_Background_color ) {
1642  }
1643  return (*m_Background_color);
1644 }
1645 
1646 inline
1648 {
1649  return ((m_set_State[0] & 0x30000000) != 0);
1650 }
1651 
1652 inline
1654 {
1655  return IsSetScale_factor();
1656 }
1657 
1658 inline
1660 {
1661  m_Scale_factor = 0;
1662  m_set_State[0] &= ~0x30000000;
1663 }
1664 
1665 inline
1667 {
1668  if (!CanGetScale_factor()) {
1669  ThrowUnassigned(14);
1670  }
1671  return m_Scale_factor;
1672 }
1673 
1674 inline
1676 {
1678  m_set_State[0] |= 0x30000000;
1679 }
1680 
1681 inline
1683 {
1684 #ifdef _DEBUG
1685  if (!IsSetScale_factor()) {
1686  memset(&m_Scale_factor,UnassignedByte(),sizeof(m_Scale_factor));
1687  }
1688 #endif
1689  m_set_State[0] |= 0x10000000;
1690  return m_Scale_factor;
1691 }
1692 
1693 inline
1695 {
1696  return ((m_set_State[0] & 0xc0000000) != 0);
1697 }
1698 
1699 inline
1701 {
1702  return IsSetSpace_fill_proportion();
1703 }
1704 
1705 inline
1707 {
1709  m_set_State[0] &= ~0xc0000000;
1710 }
1711 
1712 inline
1714 {
1715  if (!CanGetSpace_fill_proportion()) {
1716  ThrowUnassigned(15);
1717  }
1718  return m_Space_fill_proportion;
1719 }
1720 
1721 inline
1723 {
1725  m_set_State[0] |= 0xc0000000;
1726 }
1727 
1728 inline
1730 {
1731 #ifdef _DEBUG
1732  if (!IsSetSpace_fill_proportion()) {
1734  }
1735 #endif
1736  m_set_State[0] |= 0x40000000;
1737  return m_Space_fill_proportion;
1738 }
1739 
1740 inline
1742 {
1743  return ((m_set_State[1] & 0x3) != 0);
1744 }
1745 
1746 inline
1748 {
1749  return IsSetBall_radius();
1750 }
1751 
1752 inline
1754 {
1755  m_Ball_radius = 0;
1756  m_set_State[1] &= ~0x3;
1757 }
1758 
1759 inline
1761 {
1762  if (!CanGetBall_radius()) {
1763  ThrowUnassigned(16);
1764  }
1765  return m_Ball_radius;
1766 }
1767 
1768 inline
1770 {
1771  m_Ball_radius = value;
1772  m_set_State[1] |= 0x3;
1773 }
1774 
1775 inline
1777 {
1778 #ifdef _DEBUG
1779  if (!IsSetBall_radius()) {
1780  memset(&m_Ball_radius,UnassignedByte(),sizeof(m_Ball_radius));
1781  }
1782 #endif
1783  m_set_State[1] |= 0x1;
1784  return m_Ball_radius;
1785 }
1786 
1787 inline
1789 {
1790  return ((m_set_State[1] & 0xc) != 0);
1791 }
1792 
1793 inline
1795 {
1796  return IsSetStick_radius();
1797 }
1798 
1799 inline
1801 {
1802  m_Stick_radius = 0;
1803  m_set_State[1] &= ~0xc;
1804 }
1805 
1806 inline
1808 {
1809  if (!CanGetStick_radius()) {
1810  ThrowUnassigned(17);
1811  }
1812  return m_Stick_radius;
1813 }
1814 
1815 inline
1817 {
1819  m_set_State[1] |= 0xc;
1820 }
1821 
1822 inline
1824 {
1825 #ifdef _DEBUG
1826  if (!IsSetStick_radius()) {
1827  memset(&m_Stick_radius,UnassignedByte(),sizeof(m_Stick_radius));
1828  }
1829 #endif
1830  m_set_State[1] |= 0x4;
1831  return m_Stick_radius;
1832 }
1833 
1834 inline
1836 {
1837  return ((m_set_State[1] & 0x30) != 0);
1838 }
1839 
1840 inline
1842 {
1843  return IsSetTube_radius();
1844 }
1845 
1846 inline
1848 {
1849  m_Tube_radius = 0;
1850  m_set_State[1] &= ~0x30;
1851 }
1852 
1853 inline
1855 {
1856  if (!CanGetTube_radius()) {
1857  ThrowUnassigned(18);
1858  }
1859  return m_Tube_radius;
1860 }
1861 
1862 inline
1864 {
1865  m_Tube_radius = value;
1866  m_set_State[1] |= 0x30;
1867 }
1868 
1869 inline
1871 {
1872 #ifdef _DEBUG
1873  if (!IsSetTube_radius()) {
1874  memset(&m_Tube_radius,UnassignedByte(),sizeof(m_Tube_radius));
1875  }
1876 #endif
1877  m_set_State[1] |= 0x10;
1878  return m_Tube_radius;
1879 }
1880 
1881 inline
1883 {
1884  return ((m_set_State[1] & 0xc0) != 0);
1885 }
1886 
1887 inline
1889 {
1890  return IsSetTube_worm_radius();
1891 }
1892 
1893 inline
1895 {
1896  m_Tube_worm_radius = 0;
1897  m_set_State[1] &= ~0xc0;
1898 }
1899 
1900 inline
1902 {
1903  if (!CanGetTube_worm_radius()) {
1904  ThrowUnassigned(19);
1905  }
1906  return m_Tube_worm_radius;
1907 }
1908 
1909 inline
1911 {
1913  m_set_State[1] |= 0xc0;
1914 }
1915 
1916 inline
1918 {
1919 #ifdef _DEBUG
1920  if (!IsSetTube_worm_radius()) {
1922  }
1923 #endif
1924  m_set_State[1] |= 0x40;
1925  return m_Tube_worm_radius;
1926 }
1927 
1928 inline
1930 {
1931  return ((m_set_State[1] & 0x300) != 0);
1932 }
1933 
1934 inline
1936 {
1937  return IsSetHelix_radius();
1938 }
1939 
1940 inline
1942 {
1943  m_Helix_radius = 0;
1944  m_set_State[1] &= ~0x300;
1945 }
1946 
1947 inline
1949 {
1950  if (!CanGetHelix_radius()) {
1951  ThrowUnassigned(20);
1952  }
1953  return m_Helix_radius;
1954 }
1955 
1956 inline
1958 {
1960  m_set_State[1] |= 0x300;
1961 }
1962 
1963 inline
1965 {
1966 #ifdef _DEBUG
1967  if (!IsSetHelix_radius()) {
1968  memset(&m_Helix_radius,UnassignedByte(),sizeof(m_Helix_radius));
1969  }
1970 #endif
1971  m_set_State[1] |= 0x100;
1972  return m_Helix_radius;
1973 }
1974 
1975 inline
1977 {
1978  return ((m_set_State[1] & 0xc00) != 0);
1979 }
1980 
1981 inline
1983 {
1984  return IsSetStrand_width();
1985 }
1986 
1987 inline
1989 {
1990  m_Strand_width = 0;
1991  m_set_State[1] &= ~0xc00;
1992 }
1993 
1994 inline
1996 {
1997  if (!CanGetStrand_width()) {
1998  ThrowUnassigned(21);
1999  }
2000  return m_Strand_width;
2001 }
2002 
2003 inline
2005 {
2007  m_set_State[1] |= 0xc00;
2008 }
2009 
2010 inline
2012 {
2013 #ifdef _DEBUG
2014  if (!IsSetStrand_width()) {
2015  memset(&m_Strand_width,UnassignedByte(),sizeof(m_Strand_width));
2016  }
2017 #endif
2018  m_set_State[1] |= 0x400;
2019  return m_Strand_width;
2020 }
2021 
2022 inline
2024 {
2025  return ((m_set_State[1] & 0x3000) != 0);
2026 }
2027 
2028 inline
2030 {
2031  return IsSetStrand_thickness();
2032 }
2033 
2034 inline
2036 {
2037  m_Strand_thickness = 0;
2038  m_set_State[1] &= ~0x3000;
2039 }
2040 
2041 inline
2043 {
2044  if (!CanGetStrand_thickness()) {
2045  ThrowUnassigned(22);
2046  }
2047  return m_Strand_thickness;
2048 }
2049 
2050 inline
2052 {
2054  m_set_State[1] |= 0x3000;
2055 }
2056 
2057 inline
2059 {
2060 #ifdef _DEBUG
2061  if (!IsSetStrand_thickness()) {
2063  }
2064 #endif
2065  m_set_State[1] |= 0x1000;
2066  return m_Strand_thickness;
2067 }
2068 
2069 inline
2071 {
2072  return m_Protein_labels.NotEmpty();
2073 }
2074 
2075 inline
2077 {
2078  return IsSetProtein_labels();
2079 }
2080 
2081 inline
2083 {
2084  if (!CanGetProtein_labels()) {
2085  ThrowUnassigned(23);
2086  }
2087  return (*m_Protein_labels);
2088 }
2089 
2090 inline
2092 {
2093  return m_Nucleotide_labels.NotEmpty();
2094 }
2095 
2096 inline
2098 {
2099  return IsSetNucleotide_labels();
2100 }
2101 
2102 inline
2104 {
2105  if (!CanGetNucleotide_labels()) {
2106  ThrowUnassigned(24);
2107  }
2108  return (*m_Nucleotide_labels);
2109 }
2110 
2111 inline
2113 {
2114  return ((m_set_State[1] & 0xc0000) != 0);
2115 }
2116 
2117 inline
2119 {
2120  return IsSetIon_labels();
2121 }
2122 
2123 inline
2125 {
2126  m_Ion_labels = 0;
2127  m_set_State[1] &= ~0xc0000;
2128 }
2129 
2130 inline
2132 {
2133  if (!CanGetIon_labels()) {
2134  ThrowUnassigned(25);
2135  }
2136  return m_Ion_labels;
2137 }
2138 
2139 inline
2141 {
2142  m_Ion_labels = value;
2143  m_set_State[1] |= 0xc0000;
2144 }
2145 
2146 inline
2148 {
2149 #ifdef _DEBUG
2150  if (!IsSetIon_labels()) {
2151  memset(&m_Ion_labels,UnassignedByte(),sizeof(m_Ion_labels));
2152  }
2153 #endif
2154  m_set_State[1] |= 0x40000;
2155  return m_Ion_labels;
2156 }
2157 
2158 ///////////////////////////////////////////////////////////
2159 ////////////////// end of inline methods //////////////////
2160 ///////////////////////////////////////////////////////////
2161 
2162 
2163 
2164 
2165 
2166 END_objects_SCOPE // namespace ncbi::objects::
2167 
2169 
2170 
2171 #endif // OBJECTS_CN3D_CN3D_STYLE_SETTINGS_BASE_HPP
CCn3d_backbone_label_style –.
CCn3d_backbone_style –.
CCn3d_color –.
Definition: Cn3d_color.hpp:66
CCn3d_general_style –.
rendering settings for Cn3D (mirrors StyleSettings class)
CRef –.
Definition: ncbiobj.hpp:618
Base class for all serializable objects.
Definition: serialbase.hpp:150
char value[7]
Definition: config.c:431
static char UnassignedByte(void)
Definition: serialbase.hpp:181
void ThrowUnassigned(TMemberIndex index) const
static string UnassignedString(void)
Definition: serialbase.hpp:175
uint32_t Uint4
4-byte (32-bit) unsigned integer
Definition: ncbitype.h:103
#define END_NCBI_SCOPE
End previously defined NCBI scope.
Definition: ncbistl.hpp:103
#define BEGIN_NCBI_SCOPE
Define ncbi namespace.
Definition: ncbistl.hpp:100
#define NCBI_CN3D_EXPORT
Definition: ncbi_export.h:384
TConnections & SetConnections(void)
Assign a value to Connections data member.
THeterogens & SetHeterogens(void)
Assign a value to Heterogens data member.
bool IsSetConnections(void) const
Check if a value has been assigned to Connections data member.
bool IsSetTube_radius(void) const
Check if a value has been assigned to Tube_radius data member.
bool CanGetIon_labels(void) const
Check if it is safe to call GetIon_labels method.
void ResetNucleotide_backbone(void)
Reset Nucleotide_backbone data member.
TProtein_backbone & SetProtein_backbone(void)
Assign a value to Protein_backbone data member.
THelix_radius & SetHelix_radius(void)
Assign a value to Helix_radius data member.
void ResetTube_worm_radius(void)
Reset Tube_worm_radius data member.
THydrogens_on GetHydrogens_on(void) const
Get the Hydrogens_on member data.
const TNucleotide_backbone & GetNucleotide_backbone(void) const
Get the Nucleotide_backbone member data.
bool IsSetBall_radius(void) const
Check if a value has been assigned to Ball_radius data member.
const TName & GetName(void) const
Get the Name member data.
const TConnections & GetConnections(void) const
Get the Connections member data.
bool IsSetProtein_sidechains(void) const
styles for other stuff Check if a value has been assigned to Protein_sidechains data member.
bool IsSetProtein_backbone(void) const
backbone styles Check if a value has been assigned to Protein_backbone data member.
CCn3d_backbone_style TNucleotide_backbone
CRef< TConnections > m_Connections
void ResetScale_factor(void)
Reset Scale_factor data member.
TNucleotide_backbone & SetNucleotide_backbone(void)
Assign a value to Nucleotide_backbone data member.
void ResetVirtual_disulfides_on(void)
Reset Virtual_disulfides_on data member.
const TNucleotide_labels & GetNucleotide_labels(void) const
Get the Nucleotide_labels member data.
Tparent::CMemberIndex< E_memberIndex, 27 > TmemberIndex
bool IsSetHelix_radius(void) const
Check if a value has been assigned to Helix_radius data member.
TScale_factor & SetScale_factor(void)
Assign a value to Scale_factor data member.
CRef< THelix_objects > m_Helix_objects
bool CanGetProtein_labels(void) const
Check if it is safe to call GetProtein_labels method.
void ResetStick_radius(void)
Reset Stick_radius data member.
CRef< TNucleotide_sidechains > m_Nucleotide_sidechains
const TNucleotide_sidechains & GetNucleotide_sidechains(void) const
Get the Nucleotide_sidechains member data.
CRef< TProtein_labels > m_Protein_labels
bool IsSetSolvents(void) const
Check if a value has been assigned to Solvents data member.
CCn3d_backbone_label_style TNucleotide_labels
bool CanGetHelix_radius(void) const
Check if it is safe to call GetHelix_radius method.
bool IsSetScale_factor(void) const
Check if a value has been assigned to Scale_factor data member.
CCn3d_general_style THelix_objects
CCn3d_general_style TStrand_objects
const TProtein_backbone & GetProtein_backbone(void) const
Get the Protein_backbone member data.
CRef< TNucleotide_labels > m_Nucleotide_labels
void ResetProtein_sidechains(void)
Reset Protein_sidechains data member.
bool CanGetNucleotide_labels(void) const
Check if it is safe to call GetNucleotide_labels method.
TTube_worm_radius & SetTube_worm_radius(void)
Assign a value to Tube_worm_radius data member.
void ResetTube_radius(void)
Reset Tube_radius data member.
void ResetHeterogens(void)
Reset Heterogens data member.
CRef< TBackground_color > m_Background_color
CRef< TStrand_objects > m_Strand_objects
bool IsSetStrand_width(void) const
Check if a value has been assigned to Strand_width data member.
TSolvents & SetSolvents(void)
Assign a value to Solvents data member.
CCn3d_general_style TProtein_sidechains
bool IsSetNucleotide_backbone(void) const
Check if a value has been assigned to Nucleotide_backbone data member.
const TVirtual_disulfide_color & GetVirtual_disulfide_color(void) const
Get the Virtual_disulfide_color member data.
bool IsSetStrand_objects(void) const
Check if a value has been assigned to Strand_objects data member.
TVirtual_disulfides_on & SetVirtual_disulfides_on(void)
Assign a value to Virtual_disulfides_on data member.
TNucleotide_sidechains & SetNucleotide_sidechains(void)
Assign a value to Nucleotide_sidechains data member.
void ResetConnections(void)
Reset Connections data member.
CCn3d_backbone_label_style TProtein_labels
void ResetSolvents(void)
Reset Solvents data member.
const TSolvents & GetSolvents(void) const
Get the Solvents member data.
TProtein_sidechains & SetProtein_sidechains(void)
Assign a value to Protein_sidechains data member.
bool IsSetNucleotide_sidechains(void) const
Check if a value has been assigned to Nucleotide_sidechains data member.
TTube_radius & SetTube_radius(void)
Assign a value to Tube_radius data member.
void ResetStrand_objects(void)
Reset Strand_objects data member.
bool CanGetVirtual_disulfides_on(void) const
Check if it is safe to call GetVirtual_disulfides_on method.
bool CanGetName(void) const
Check if it is safe to call GetName method.
bool IsSetHelix_objects(void) const
Check if a value has been assigned to Helix_objects data member.
TSpace_fill_proportion & SetSpace_fill_proportion(void)
Assign a value to Space_fill_proportion data member.
bool IsSetTube_worm_radius(void) const
Check if a value has been assigned to Tube_worm_radius data member.
bool IsSetSpace_fill_proportion(void) const
Check if a value has been assigned to Space_fill_proportion data member.
bool IsSetStick_radius(void) const
Check if a value has been assigned to Stick_radius data member.
bool IsSetBackground_color(void) const
background floating point parameters - scale-factor applies to all the following: Check if a value ha...
bool IsSetHeterogens(void) const
Check if a value has been assigned to Heterogens data member.
const TProtein_labels & GetProtein_labels(void) const
Get the Protein_labels member data.
void ResetHelix_objects(void)
Reset Helix_objects data member.
TBall_radius GetBall_radius(void) const
Get the Ball_radius member data.
TIon_labels GetIon_labels(void) const
Get the Ion_labels member data.
const THeterogens & GetHeterogens(void) const
Get the Heterogens member data.
void ResetNucleotide_sidechains(void)
Reset Nucleotide_sidechains data member.
const THelix_objects & GetHelix_objects(void) const
Get the Helix_objects member data.
TStrand_width GetStrand_width(void) const
Get the Strand_width member data.
void ResetSpace_fill_proportion(void)
Reset Space_fill_proportion data member.
void ResetIon_labels(void)
Reset Ion_labels data member.
bool CanGetStrand_objects(void) const
Check if it is safe to call GetStrand_objects method.
bool IsSetVirtual_disulfides_on(void) const
virtual disulfides Check if a value has been assigned to Virtual_disulfides_on data member.
TTube_worm_radius GetTube_worm_radius(void) const
Get the Tube_worm_radius member data.
bool CanGetProtein_sidechains(void) const
Check if it is safe to call GetProtein_sidechains method.
bool CanGetHydrogens_on(void) const
Check if it is safe to call GetHydrogens_on method.
bool CanGetVirtual_disulfide_color(void) const
Check if it is safe to call GetVirtual_disulfide_color method.
bool IsSetNucleotide_labels(void) const
Check if a value has been assigned to Nucleotide_labels data member.
TStick_radius GetStick_radius(void) const
Get the Stick_radius member data.
bool IsSetProtein_labels(void) const
backbone labels (no labels if not present) Check if a value has been assigned to Protein_labels data ...
TVirtual_disulfide_color & SetVirtual_disulfide_color(void)
Assign a value to Virtual_disulfide_color data member.
TTube_radius GetTube_radius(void) const
Get the Tube_radius member data.
bool CanGetNucleotide_backbone(void) const
Check if it is safe to call GetNucleotide_backbone method.
bool CanGetProtein_backbone(void) const
Check if it is safe to call GetProtein_backbone method.
bool CanGetTube_worm_radius(void) const
Check if it is safe to call GetTube_worm_radius method.
TStrand_thickness & SetStrand_thickness(void)
Assign a value to Strand_thickness data member.
TBackground_color & SetBackground_color(void)
Assign a value to Background_color data member.
TStrand_width & SetStrand_width(void)
Assign a value to Strand_width data member.
CRef< TProtein_sidechains > m_Protein_sidechains
bool CanGetHelix_objects(void) const
Check if it is safe to call GetHelix_objects method.
TSpace_fill_proportion GetSpace_fill_proportion(void) const
Get the Space_fill_proportion member data.
bool CanGetStrand_thickness(void) const
Check if it is safe to call GetStrand_thickness method.
bool IsSetIon_labels(void) const
ion labels Check if a value has been assigned to Ion_labels data member.
void ResetStrand_thickness(void)
Reset Strand_thickness data member.
const TBackground_color & GetBackground_color(void) const
Get the Background_color member data.
bool CanGetSolvents(void) const
Check if it is safe to call GetSolvents method.
void ResetHelix_radius(void)
Reset Helix_radius data member.
bool CanGetStrand_width(void) const
Check if it is safe to call GetStrand_width method.
TVirtual_disulfides_on GetVirtual_disulfides_on(void) const
Get the Virtual_disulfides_on member data.
CRef< TVirtual_disulfide_color > m_Virtual_disulfide_color
void ResetProtein_backbone(void)
Reset Protein_backbone data member.
bool CanGetBall_radius(void) const
Check if it is safe to call GetBall_radius method.
THelix_radius GetHelix_radius(void) const
Get the Helix_radius member data.
bool IsSetVirtual_disulfide_color(void) const
Check if a value has been assigned to Virtual_disulfide_color data member.
bool IsSetName(void) const
a name (for favorites) Check if a value has been assigned to Name data member.
void ResetStrand_width(void)
Reset Strand_width data member.
TStrand_thickness GetStrand_thickness(void) const
Get the Strand_thickness member data.
const TStrand_objects & GetStrand_objects(void) const
Get the Strand_objects member data.
bool CanGetScale_factor(void) const
Check if it is safe to call GetScale_factor method.
TName & SetName(void)
Assign a value to Name data member.
bool CanGetSpace_fill_proportion(void) const
Check if it is safe to call GetSpace_fill_proportion method.
bool CanGetBackground_color(void) const
Check if it is safe to call GetBackground_color method.
void ResetVirtual_disulfide_color(void)
Reset Virtual_disulfide_color data member.
CRef< TProtein_backbone > m_Protein_backbone
bool CanGetNucleotide_sidechains(void) const
Check if it is safe to call GetNucleotide_sidechains method.
bool CanGetHeterogens(void) const
Check if it is safe to call GetHeterogens method.
CCn3d_style_settings_Base(const CCn3d_style_settings_Base &)
TStrand_objects & SetStrand_objects(void)
Assign a value to Strand_objects data member.
CCn3d_style_settings_Base & operator=(const CCn3d_style_settings_Base &)
bool IsSetStrand_thickness(void) const
Check if a value has been assigned to Strand_thickness data member.
void ResetBackground_color(void)
Reset Background_color data member.
void ResetBall_radius(void)
Reset Ball_radius data member.
TScale_factor GetScale_factor(void) const
Get the Scale_factor member data.
const TProtein_sidechains & GetProtein_sidechains(void) const
Get the Protein_sidechains member data.
THelix_objects & SetHelix_objects(void)
Assign a value to Helix_objects data member.
CCn3d_backbone_style TProtein_backbone
bool CanGetConnections(void) const
Check if it is safe to call GetConnections method.
bool IsSetHydrogens_on(void) const
hydrogens Check if a value has been assigned to Hydrogens_on data member.
CCn3d_general_style TNucleotide_sidechains
bool CanGetTube_radius(void) const
Check if it is safe to call GetTube_radius method.
TBall_radius & SetBall_radius(void)
Assign a value to Ball_radius data member.
CRef< TNucleotide_backbone > m_Nucleotide_backbone
bool CanGetStick_radius(void) const
Check if it is safe to call GetStick_radius method.
TIon_labels & SetIon_labels(void)
Assign a value to Ion_labels data member.
THydrogens_on & SetHydrogens_on(void)
Assign a value to Hydrogens_on data member.
TStick_radius & SetStick_radius(void)
Assign a value to Stick_radius data member.
void ResetHydrogens_on(void)
Reset Hydrogens_on data member.
Modified on Thu Feb 29 12:23:16 2024 by modify_doxy.py rev. 669887