CCn3d_style_settings Class Reference

Search Toolkit Book for CCn3d_style_settings

CCn3d_style_settings –. More...

#include <objects/cn3d/Cn3d_style_settings.hpp>

Inheritance diagram for CCn3d_style_settings:

Collaboration diagram for CCn3d_style_settings:

Public Member Functions
	CCn3d_style_settings (void)
	~CCn3d_style_settings (void)
Public Member Functions inherited from CCn3d_style_settings_Base
	CCn3d_style_settings_Base (void)
virtual	~CCn3d_style_settings_Base (void)
	DECLARE_INTERNAL_TYPE_INFO ()
bool	IsSetName (void) const
	a name (for favorites) Check if a value has been assigned to Name data member. More...
bool	CanGetName (void) const
	Check if it is safe to call GetName method. More...
void	ResetName (void)
	Reset Name data member. More...
const TName &	GetName (void) const
	Get the Name member data. More...
void	SetName (const TName &value)
	Assign a value to Name data member. More...
void	SetName (TName &&value)
TName &	SetName (void)
	Assign a value to Name data member. More...
bool	IsSetProtein_backbone (void) const
	backbone styles Check if a value has been assigned to Protein_backbone data member. More...
bool	CanGetProtein_backbone (void) const
	Check if it is safe to call GetProtein_backbone method. More...
void	ResetProtein_backbone (void)
	Reset Protein_backbone data member. More...
const TProtein_backbone &	GetProtein_backbone (void) const
	Get the Protein_backbone member data. More...
void	SetProtein_backbone (TProtein_backbone &value)
	Assign a value to Protein_backbone data member. More...
TProtein_backbone &	SetProtein_backbone (void)
	Assign a value to Protein_backbone data member. More...
bool	IsSetNucleotide_backbone (void) const
	Check if a value has been assigned to Nucleotide_backbone data member. More...
bool	CanGetNucleotide_backbone (void) const
	Check if it is safe to call GetNucleotide_backbone method. More...
void	ResetNucleotide_backbone (void)
	Reset Nucleotide_backbone data member. More...
const TNucleotide_backbone &	GetNucleotide_backbone (void) const
	Get the Nucleotide_backbone member data. More...
void	SetNucleotide_backbone (TNucleotide_backbone &value)
	Assign a value to Nucleotide_backbone data member. More...
TNucleotide_backbone &	SetNucleotide_backbone (void)
	Assign a value to Nucleotide_backbone data member. More...
bool	IsSetProtein_sidechains (void) const
	styles for other stuff Check if a value has been assigned to Protein_sidechains data member. More...
bool	CanGetProtein_sidechains (void) const
	Check if it is safe to call GetProtein_sidechains method. More...
void	ResetProtein_sidechains (void)
	Reset Protein_sidechains data member. More...
const TProtein_sidechains &	GetProtein_sidechains (void) const
	Get the Protein_sidechains member data. More...
void	SetProtein_sidechains (TProtein_sidechains &value)
	Assign a value to Protein_sidechains data member. More...
TProtein_sidechains &	SetProtein_sidechains (void)
	Assign a value to Protein_sidechains data member. More...
bool	IsSetNucleotide_sidechains (void) const
	Check if a value has been assigned to Nucleotide_sidechains data member. More...
bool	CanGetNucleotide_sidechains (void) const
	Check if it is safe to call GetNucleotide_sidechains method. More...
void	ResetNucleotide_sidechains (void)
	Reset Nucleotide_sidechains data member. More...
const TNucleotide_sidechains &	GetNucleotide_sidechains (void) const
	Get the Nucleotide_sidechains member data. More...
void	SetNucleotide_sidechains (TNucleotide_sidechains &value)
	Assign a value to Nucleotide_sidechains data member. More...
TNucleotide_sidechains &	SetNucleotide_sidechains (void)
	Assign a value to Nucleotide_sidechains data member. More...
bool	IsSetHeterogens (void) const
	Check if a value has been assigned to Heterogens data member. More...
bool	CanGetHeterogens (void) const
	Check if it is safe to call GetHeterogens method. More...
void	ResetHeterogens (void)
	Reset Heterogens data member. More...
const THeterogens &	GetHeterogens (void) const
	Get the Heterogens member data. More...
void	SetHeterogens (THeterogens &value)
	Assign a value to Heterogens data member. More...
THeterogens &	SetHeterogens (void)
	Assign a value to Heterogens data member. More...
bool	IsSetSolvents (void) const
	Check if a value has been assigned to Solvents data member. More...
bool	CanGetSolvents (void) const
	Check if it is safe to call GetSolvents method. More...
void	ResetSolvents (void)
	Reset Solvents data member. More...
const TSolvents &	GetSolvents (void) const
	Get the Solvents member data. More...
void	SetSolvents (TSolvents &value)
	Assign a value to Solvents data member. More...
TSolvents &	SetSolvents (void)
	Assign a value to Solvents data member. More...
bool	IsSetConnections (void) const
	Check if a value has been assigned to Connections data member. More...
bool	CanGetConnections (void) const
	Check if it is safe to call GetConnections method. More...
void	ResetConnections (void)
	Reset Connections data member. More...
const TConnections &	GetConnections (void) const
	Get the Connections member data. More...
void	SetConnections (TConnections &value)
	Assign a value to Connections data member. More...
TConnections &	SetConnections (void)
	Assign a value to Connections data member. More...
bool	IsSetHelix_objects (void) const
	Check if a value has been assigned to Helix_objects data member. More...
bool	CanGetHelix_objects (void) const
	Check if it is safe to call GetHelix_objects method. More...
void	ResetHelix_objects (void)
	Reset Helix_objects data member. More...
const THelix_objects &	GetHelix_objects (void) const
	Get the Helix_objects member data. More...
void	SetHelix_objects (THelix_objects &value)
	Assign a value to Helix_objects data member. More...
THelix_objects &	SetHelix_objects (void)
	Assign a value to Helix_objects data member. More...
bool	IsSetStrand_objects (void) const
	Check if a value has been assigned to Strand_objects data member. More...
bool	CanGetStrand_objects (void) const
	Check if it is safe to call GetStrand_objects method. More...
void	ResetStrand_objects (void)
	Reset Strand_objects data member. More...
const TStrand_objects &	GetStrand_objects (void) const
	Get the Strand_objects member data. More...
void	SetStrand_objects (TStrand_objects &value)
	Assign a value to Strand_objects data member. More...
TStrand_objects &	SetStrand_objects (void)
	Assign a value to Strand_objects data member. More...
bool	IsSetVirtual_disulfides_on (void) const
	virtual disulfides Check if a value has been assigned to Virtual_disulfides_on data member. More...
bool	CanGetVirtual_disulfides_on (void) const
	Check if it is safe to call GetVirtual_disulfides_on method. More...
void	ResetVirtual_disulfides_on (void)
	Reset Virtual_disulfides_on data member. More...
TVirtual_disulfides_on	GetVirtual_disulfides_on (void) const
	Get the Virtual_disulfides_on member data. More...
void	SetVirtual_disulfides_on (TVirtual_disulfides_on value)
	Assign a value to Virtual_disulfides_on data member. More...
TVirtual_disulfides_on &	SetVirtual_disulfides_on (void)
	Assign a value to Virtual_disulfides_on data member. More...
bool	IsSetVirtual_disulfide_color (void) const
	Check if a value has been assigned to Virtual_disulfide_color data member. More...
bool	CanGetVirtual_disulfide_color (void) const
	Check if it is safe to call GetVirtual_disulfide_color method. More...
void	ResetVirtual_disulfide_color (void)
	Reset Virtual_disulfide_color data member. More...
const TVirtual_disulfide_color &	GetVirtual_disulfide_color (void) const
	Get the Virtual_disulfide_color member data. More...
void	SetVirtual_disulfide_color (TVirtual_disulfide_color &value)
	Assign a value to Virtual_disulfide_color data member. More...
TVirtual_disulfide_color &	SetVirtual_disulfide_color (void)
	Assign a value to Virtual_disulfide_color data member. More...
bool	IsSetHydrogens_on (void) const
	hydrogens Check if a value has been assigned to Hydrogens_on data member. More...
bool	CanGetHydrogens_on (void) const
	Check if it is safe to call GetHydrogens_on method. More...
void	ResetHydrogens_on (void)
	Reset Hydrogens_on data member. More...
THydrogens_on	GetHydrogens_on (void) const
	Get the Hydrogens_on member data. More...
void	SetHydrogens_on (THydrogens_on value)
	Assign a value to Hydrogens_on data member. More...
THydrogens_on &	SetHydrogens_on (void)
	Assign a value to Hydrogens_on data member. More...
bool	IsSetBackground_color (void) const
	background floating point parameters - scale-factor applies to all the following: Check if a value has been assigned to Background_color data member. More...
bool	CanGetBackground_color (void) const
	Check if it is safe to call GetBackground_color method. More...
void	ResetBackground_color (void)
	Reset Background_color data member. More...
const TBackground_color &	GetBackground_color (void) const
	Get the Background_color member data. More...
void	SetBackground_color (TBackground_color &value)
	Assign a value to Background_color data member. More...
TBackground_color &	SetBackground_color (void)
	Assign a value to Background_color data member. More...
bool	IsSetScale_factor (void) const
	Check if a value has been assigned to Scale_factor data member. More...
bool	CanGetScale_factor (void) const
	Check if it is safe to call GetScale_factor method. More...
void	ResetScale_factor (void)
	Reset Scale_factor data member. More...
TScale_factor	GetScale_factor (void) const
	Get the Scale_factor member data. More...
void	SetScale_factor (TScale_factor value)
	Assign a value to Scale_factor data member. More...
TScale_factor &	SetScale_factor (void)
	Assign a value to Scale_factor data member. More...
bool	IsSetSpace_fill_proportion (void) const
	Check if a value has been assigned to Space_fill_proportion data member. More...
bool	CanGetSpace_fill_proportion (void) const
	Check if it is safe to call GetSpace_fill_proportion method. More...
void	ResetSpace_fill_proportion (void)
	Reset Space_fill_proportion data member. More...
TSpace_fill_proportion	GetSpace_fill_proportion (void) const
	Get the Space_fill_proportion member data. More...
void	SetSpace_fill_proportion (TSpace_fill_proportion value)
	Assign a value to Space_fill_proportion data member. More...
TSpace_fill_proportion &	SetSpace_fill_proportion (void)
	Assign a value to Space_fill_proportion data member. More...
bool	IsSetBall_radius (void) const
	Check if a value has been assigned to Ball_radius data member. More...
bool	CanGetBall_radius (void) const
	Check if it is safe to call GetBall_radius method. More...
void	ResetBall_radius (void)
	Reset Ball_radius data member. More...
TBall_radius	GetBall_radius (void) const
	Get the Ball_radius member data. More...
void	SetBall_radius (TBall_radius value)
	Assign a value to Ball_radius data member. More...
TBall_radius &	SetBall_radius (void)
	Assign a value to Ball_radius data member. More...
bool	IsSetStick_radius (void) const
	Check if a value has been assigned to Stick_radius data member. More...
bool	CanGetStick_radius (void) const
	Check if it is safe to call GetStick_radius method. More...
void	ResetStick_radius (void)
	Reset Stick_radius data member. More...
TStick_radius	GetStick_radius (void) const
	Get the Stick_radius member data. More...
void	SetStick_radius (TStick_radius value)
	Assign a value to Stick_radius data member. More...
TStick_radius &	SetStick_radius (void)
	Assign a value to Stick_radius data member. More...
bool	IsSetTube_radius (void) const
	Check if a value has been assigned to Tube_radius data member. More...
bool	CanGetTube_radius (void) const
	Check if it is safe to call GetTube_radius method. More...
void	ResetTube_radius (void)
	Reset Tube_radius data member. More...
TTube_radius	GetTube_radius (void) const
	Get the Tube_radius member data. More...
void	SetTube_radius (TTube_radius value)
	Assign a value to Tube_radius data member. More...
TTube_radius &	SetTube_radius (void)
	Assign a value to Tube_radius data member. More...
bool	IsSetTube_worm_radius (void) const
	Check if a value has been assigned to Tube_worm_radius data member. More...
bool	CanGetTube_worm_radius (void) const
	Check if it is safe to call GetTube_worm_radius method. More...
void	ResetTube_worm_radius (void)
	Reset Tube_worm_radius data member. More...
TTube_worm_radius	GetTube_worm_radius (void) const
	Get the Tube_worm_radius member data. More...
void	SetTube_worm_radius (TTube_worm_radius value)
	Assign a value to Tube_worm_radius data member. More...
TTube_worm_radius &	SetTube_worm_radius (void)
	Assign a value to Tube_worm_radius data member. More...
bool	IsSetHelix_radius (void) const
	Check if a value has been assigned to Helix_radius data member. More...
bool	CanGetHelix_radius (void) const
	Check if it is safe to call GetHelix_radius method. More...
void	ResetHelix_radius (void)
	Reset Helix_radius data member. More...
THelix_radius	GetHelix_radius (void) const
	Get the Helix_radius member data. More...
void	SetHelix_radius (THelix_radius value)
	Assign a value to Helix_radius data member. More...
THelix_radius &	SetHelix_radius (void)
	Assign a value to Helix_radius data member. More...
bool	IsSetStrand_width (void) const
	Check if a value has been assigned to Strand_width data member. More...
bool	CanGetStrand_width (void) const
	Check if it is safe to call GetStrand_width method. More...
void	ResetStrand_width (void)
	Reset Strand_width data member. More...
TStrand_width	GetStrand_width (void) const
	Get the Strand_width member data. More...
void	SetStrand_width (TStrand_width value)
	Assign a value to Strand_width data member. More...
TStrand_width &	SetStrand_width (void)
	Assign a value to Strand_width data member. More...
bool	IsSetStrand_thickness (void) const
	Check if a value has been assigned to Strand_thickness data member. More...
bool	CanGetStrand_thickness (void) const
	Check if it is safe to call GetStrand_thickness method. More...
void	ResetStrand_thickness (void)
	Reset Strand_thickness data member. More...
TStrand_thickness	GetStrand_thickness (void) const
	Get the Strand_thickness member data. More...
void	SetStrand_thickness (TStrand_thickness value)
	Assign a value to Strand_thickness data member. More...
TStrand_thickness &	SetStrand_thickness (void)
	Assign a value to Strand_thickness data member. More...
bool	IsSetProtein_labels (void) const
	backbone labels (no labels if not present) Check if a value has been assigned to Protein_labels data member. More...
bool	CanGetProtein_labels (void) const
	Check if it is safe to call GetProtein_labels method. More...
void	ResetProtein_labels (void)
	Reset Protein_labels data member. More...
const TProtein_labels &	GetProtein_labels (void) const
	Get the Protein_labels member data. More...
void	SetProtein_labels (TProtein_labels &value)
	Assign a value to Protein_labels data member. More...
TProtein_labels &	SetProtein_labels (void)
	Assign a value to Protein_labels data member. More...
bool	IsSetNucleotide_labels (void) const
	Check if a value has been assigned to Nucleotide_labels data member. More...
bool	CanGetNucleotide_labels (void) const
	Check if it is safe to call GetNucleotide_labels method. More...
void	ResetNucleotide_labels (void)
	Reset Nucleotide_labels data member. More...
const TNucleotide_labels &	GetNucleotide_labels (void) const
	Get the Nucleotide_labels member data. More...
void	SetNucleotide_labels (TNucleotide_labels &value)
	Assign a value to Nucleotide_labels data member. More...
TNucleotide_labels &	SetNucleotide_labels (void)
	Assign a value to Nucleotide_labels data member. More...
bool	IsSetIon_labels (void) const
	ion labels Check if a value has been assigned to Ion_labels data member. More...
bool	CanGetIon_labels (void) const
	Check if it is safe to call GetIon_labels method. More...
void	ResetIon_labels (void)
	Reset Ion_labels data member. More...
TIon_labels	GetIon_labels (void) const
	Get the Ion_labels member data. More...
void	SetIon_labels (TIon_labels value)
	Assign a value to Ion_labels data member. More...
TIon_labels &	SetIon_labels (void)
	Assign a value to Ion_labels data member. More...
virtual void	Reset (void)
	Reset the whole object. More...
Public Member Functions inherited from CSerialObject
	CSerialObject (void)
virtual	~CSerialObject (void)
virtual const CTypeInfo *	GetThisTypeInfo (void) const =0
virtual void	Assign (const CSerialObject &source, ESerialRecursionMode how=eRecursive)
	Set object to copy of another one. More...
virtual bool	Equals (const CSerialObject &object, ESerialRecursionMode how=eRecursive) const
	Check if both objects contain the same values. More...
virtual void	DebugDump (CDebugDumpContext ddc, unsigned int depth) const
	Define method for dumping debug information. More...
void	ThrowUnassigned (TMemberIndex index) const
void	ThrowUnassigned (TMemberIndex index, const char *file_name, int file_line) const
bool	HasNamespaceName (void) const
	Check if object data type has namespace name. More...
const string &	GetNamespaceName (void) const
	Get namespace name. More...
bool	HasNamespacePrefix (void) const
	Check if data type has namespace prefix. More...
const string &	GetNamespacePrefix (void) const
	Get namespace prefix. More...
Public Member Functions inherited from CObject
	CObject (void)
	Constructor. More...
	CObject (const CObject &src)
	Copy constructor. More...
virtual	~CObject (void)
	Destructor. More...
CObject &	operator= (const CObject &src) THROWS_NONE
	Assignment operator. More...
bool	CanBeDeleted (void) const THROWS_NONE
	Check if object can be deleted. More...
bool	IsAllocatedInPool (void) const THROWS_NONE
	Check if object is allocated in memory pool (not system heap) More...
bool	Referenced (void) const THROWS_NONE
	Check if object is referenced. More...
bool	ReferencedOnlyOnce (void) const THROWS_NONE
	Check if object is referenced only once. More...
void	AddReference (void) const
	Add reference to object. More...
void	RemoveReference (void) const
	Remove reference to object. More...
void	ReleaseReference (void) const
	Remove reference without deleting object. More...
virtual void	DoNotDeleteThisObject (void)
	Mark this object as not allocated in heap – do not delete this object. More...
virtual void	DoDeleteThisObject (void)
	Mark this object as allocated in heap – object can be deleted. More...
void *	operator new (size_t size)
	Define new operator for memory allocation. More...
void *	operator new[] (size_t size)
	Define new[] operator for 'array' memory allocation. More...
void	operator delete (void *ptr)
	Define delete operator for memory deallocation. More...
void	operator delete[] (void *ptr)
	Define delete[] operator for memory deallocation. More...
void *	operator new (size_t size, void *place)
	Define new operator. More...
void	operator delete (void *ptr, void *place)
	Define delete operator. More...
void *	operator new (size_t size, CObjectMemoryPool *place)
	Define new operator using memory pool. More...
void	operator delete (void *ptr, CObjectMemoryPool *place)
	Define delete operator. More...
Public Member Functions inherited from CDebugDumpable
	CDebugDumpable (void)
virtual	~CDebugDumpable (void)
void	DebugDumpText (ostream &out, const string &bundle, unsigned int depth) const
void	DebugDumpFormat (CDebugDumpFormatter &ddf, const string &bundle, unsigned int depth) const
void	DumpToConsole (void) const

Private Types
typedef CCn3d_style_settings_Base	Tparent

Private Member Functions
	CCn3d_style_settings (const CCn3d_style_settings &value)
CCn3d_style_settings &	operator= (const CCn3d_style_settings &value)

Additional Inherited Members
Public Types inherited from CCn3d_style_settings_Base
enum class	E_memberIndex {   e__allMandatory = 0 , e_name , e_protein_backbone , e_nucleotide_backbone ,   e_protein_sidechains , e_nucleotide_sidechains , e_heterogens , e_solvents ,   e_connections , e_helix_objects , e_strand_objects , e_virtual_disulfides_on ,   e_virtual_disulfide_color , e_hydrogens_on , e_background_color , e_scale_factor ,   e_space_fill_proportion , e_ball_radius , e_stick_radius , e_tube_radius ,   e_tube_worm_radius , e_helix_radius , e_strand_width , e_strand_thickness ,   e_protein_labels , e_nucleotide_labels , e_ion_labels }
typedef string	TName
typedef CCn3d_backbone_style	TProtein_backbone
typedef CCn3d_backbone_style	TNucleotide_backbone
typedef CCn3d_general_style	TProtein_sidechains
typedef CCn3d_general_style	TNucleotide_sidechains
typedef CCn3d_general_style	THeterogens
typedef CCn3d_general_style	TSolvents
typedef CCn3d_general_style	TConnections
typedef CCn3d_general_style	THelix_objects
typedef CCn3d_general_style	TStrand_objects
typedef bool	TVirtual_disulfides_on
typedef CCn3d_color	TVirtual_disulfide_color
typedef bool	THydrogens_on
typedef CCn3d_color	TBackground_color
typedef int	TScale_factor
typedef int	TSpace_fill_proportion
typedef int	TBall_radius
typedef int	TStick_radius
typedef int	TTube_radius
typedef int	TTube_worm_radius
typedef int	THelix_radius
typedef int	TStrand_width
typedef int	TStrand_thickness
typedef CCn3d_backbone_label_style	TProtein_labels
typedef CCn3d_backbone_label_style	TNucleotide_labels
typedef bool	TIon_labels
typedef Tparent::CMemberIndex< E_memberIndex, 27 >	TmemberIndex
Public Types inherited from CObject
enum	EAllocFillMode { eAllocFillNone = 1 , eAllocFillZero , eAllocFillPattern }
	Control filling of newly allocated memory. More...
typedef CObjectCounterLocker	TLockerType
	Default locker type for CRef. More...
typedef atomic< Uint8 >	TCounter
	Counter type is CAtomiCounter. More...
typedef Uint8	TCount
	Alias for value type of counter. More...
Static Public Member Functions inherited from CSerialObject
static void	SetVerifyDataThread (ESerialVerifyData verify)
static void	SetVerifyDataGlobal (ESerialVerifyData verify)
static string	UnassignedString (void)
static CStringUTF8	UnassignedStringUTF8 (void)
static char	UnassignedByte (void)
Static Public Member Functions inherited from CObject
static NCBI_XNCBI_EXPORT void	ThrowNullPointerException (void)
	Define method to throw null pointer exception. More...
static NCBI_XNCBI_EXPORT void	ThrowNullPointerException (const type_info &type)
static EAllocFillMode	GetAllocFillMode (void)
static void	SetAllocFillMode (EAllocFillMode mode)
static void	SetAllocFillMode (const string &value)
	Set mode from configuration parameter value. More...
Static Public Member Functions inherited from CDebugDumpable
static void	EnableDebugDump (bool on)
Static Public Attributes inherited from CSerialObject
static const char *	ms_UnassignedStr = "<*unassigned*>"
static const char	ms_UnassignedByte = char(0xcd)
Static Public Attributes inherited from CObject
static const TCount	eCounterBitsCanBeDeleted = 1 << 0
	Define possible object states. More...
static const TCount	eCounterBitsInPlainHeap = 1 << 1
	Heap signature was found. More...
static const TCount	eCounterBitsPlaceMask
	Mask for 'in heap' state flags. More...
static const int	eCounterStep = 1 << 2
	Skip over the "in heap" bits. More...
static const TCount	eCounterValid = TCount(1) << (sizeof(TCount) * 8 - 2)
	Minimal value for valid objects (reference counter is zero) Must be a single bit value. More...
static const TCount	eCounterStateMask
	Valid object, and object in heap. More...
Protected Member Functions inherited from CObject
virtual void	DeleteThis (void)
	Virtual method "deleting" this object. More...

Detailed Description

CCn3d_style_settings –.

Definition at line 65 of file Cn3d_style_settings.hpp.

---

The documentation for this class was generated from the following files:

• include/objects/cn3d/Cn3d_style_settings.hpp
• src/objects/cn3d/Cn3d_style_settings.cpp