NCBI C++ ToolKit
Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes | List of all members

Search Toolkit Book for CBiostruc_script_step_Base

CBiostruc_script_step_Base –. More...

#include <objects/mmdb3/Biostruc_script_step_.hpp>

+ Inheritance diagram for CBiostruc_script_step_Base:
+ Collaboration diagram for CBiostruc_script_step_Base:

Public Types

enum class  E_memberIndex {
  e__allMandatory = 0 , e_step_id , e_step_name , e_feature_do ,
  e_camera_move , e_pause , e_waitevent , e_extra ,
  e_jump
}
 
typedef CStep_id TStep_id
 
typedef string TStep_name
 
typedef list< CRef< COther_feature > > TFeature_do
 
typedef CTransform TCamera_move
 
typedef int TPause
 
typedef bool TWaitevent
 
typedef int TExtra
 
typedef CStep_id TJump
 
typedef Tparent::CMemberIndex< E_memberIndex, 9 > 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< Uint8TCounter
 Counter type is CAtomiCounter. More...
 
typedef Uint8 TCount
 Alias for value type of counter. More...
 

Public Member Functions

 CBiostruc_script_step_Base (void)
 
virtual ~CBiostruc_script_step_Base (void)
 
 DECLARE_INTERNAL_TYPE_INFO ()
 
bool IsSetStep_id (void) const
 Check if a value has been assigned to Step_id data member. More...
 
bool CanGetStep_id (void) const
 Check if it is safe to call GetStep_id method. More...
 
void ResetStep_id (void)
 Reset Step_id data member. More...
 
const TStep_idGetStep_id (void) const
 Get the Step_id member data. More...
 
void SetStep_id (const TStep_id &value)
 Assign a value to Step_id data member. More...
 
TStep_idSetStep_id (void)
 Assign a value to Step_id data member. More...
 
bool IsSetStep_name (void) const
 Check if a value has been assigned to Step_name data member. More...
 
bool CanGetStep_name (void) const
 Check if it is safe to call GetStep_name method. More...
 
void ResetStep_name (void)
 Reset Step_name data member. More...
 
const TStep_nameGetStep_name (void) const
 Get the Step_name member data. More...
 
void SetStep_name (const TStep_name &value)
 Assign a value to Step_name data member. More...
 
void SetStep_name (TStep_name &&value)
 
TStep_nameSetStep_name (void)
 Assign a value to Step_name data member. More...
 
bool IsSetFeature_do (void) const
 Check if a value has been assigned to Feature_do data member. More...
 
bool CanGetFeature_do (void) const
 Check if it is safe to call GetFeature_do method. More...
 
void ResetFeature_do (void)
 Reset Feature_do data member. More...
 
const TFeature_doGetFeature_do (void) const
 Get the Feature_do member data. More...
 
TFeature_doSetFeature_do (void)
 Assign a value to Feature_do data member. More...
 
bool IsSetCamera_move (void) const
 Check if a value has been assigned to Camera_move data member. More...
 
bool CanGetCamera_move (void) const
 Check if it is safe to call GetCamera_move method. More...
 
void ResetCamera_move (void)
 Reset Camera_move data member. More...
 
const TCamera_moveGetCamera_move (void) const
 Get the Camera_move member data. More...
 
void SetCamera_move (TCamera_move &value)
 Assign a value to Camera_move data member. More...
 
TCamera_moveSetCamera_move (void)
 Assign a value to Camera_move data member. More...
 
bool IsSetPause (void) const
 Check if a value has been assigned to Pause data member. More...
 
bool CanGetPause (void) const
 Check if it is safe to call GetPause method. More...
 
void ResetPause (void)
 Reset Pause data member. More...
 
void SetDefaultPause (void)
 Assign default value to Pause data member. More...
 
TPause GetPause (void) const
 Get the Pause member data. More...
 
void SetPause (TPause value)
 Assign a value to Pause data member. More...
 
TPauseSetPause (void)
 Assign a value to Pause data member. More...
 
bool IsSetWaitevent (void) const
 Check if a value has been assigned to Waitevent data member. More...
 
bool CanGetWaitevent (void) const
 Check if it is safe to call GetWaitevent method. More...
 
void ResetWaitevent (void)
 Reset Waitevent data member. More...
 
TWaitevent GetWaitevent (void) const
 Get the Waitevent member data. More...
 
void SetWaitevent (TWaitevent value)
 Assign a value to Waitevent data member. More...
 
TWaiteventSetWaitevent (void)
 Assign a value to Waitevent data member. More...
 
bool IsSetExtra (void) const
 Check if a value has been assigned to Extra data member. More...
 
bool CanGetExtra (void) const
 Check if it is safe to call GetExtra method. More...
 
void ResetExtra (void)
 Reset Extra data member. More...
 
TExtra GetExtra (void) const
 Get the Extra member data. More...
 
void SetExtra (TExtra value)
 Assign a value to Extra data member. More...
 
TExtraSetExtra (void)
 Assign a value to Extra data member. More...
 
bool IsSetJump (void) const
 Check if a value has been assigned to Jump data member. More...
 
bool CanGetJump (void) const
 Check if it is safe to call GetJump method. More...
 
void ResetJump (void)
 Reset Jump data member. More...
 
const TJumpGetJump (void) const
 Get the Jump member data. More...
 
void SetJump (const TJump &value)
 Assign a value to Jump data member. More...
 
TJumpSetJump (void)
 Assign a value to Jump 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 CTypeInfoGetThisTypeInfo (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 stringGetNamespaceName (void) const
 Get namespace name. More...
 
bool HasNamespacePrefix (void) const
 Check if data type has namespace prefix. More...
 
const stringGetNamespacePrefix (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...
 
CObjectoperator= (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 CSerialObject Tparent
 

Private Member Functions

 CBiostruc_script_step_Base (const CBiostruc_script_step_Base &)
 
CBiostruc_script_step_Baseoperator= (const CBiostruc_script_step_Base &)
 

Private Attributes

Uint4 m_set_State [1]
 
CStep_id m_Step_id
 
string m_Step_name
 
list< CRef< COther_feature > > m_Feature_do
 
CRef< TCamera_movem_Camera_move
 
int m_Pause
 
bool m_Waitevent
 
int m_Extra
 
CStep_id m_Jump
 

Additional Inherited Members

- 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

CBiostruc_script_step_Base –.

Definition at line 79 of file Biostruc_script_step_.hpp.


The documentation for this class was generated from the following files:
Modified on Fri Sep 20 14:57:34 2024 by modify_doxy.py rev. 669887