NCBI C++ ToolKit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Private Attributes | List of all members
NAutomation::SNetStorageObject Struct Reference

Search Toolkit Book for NAutomation::SNetStorageObject

#include "nst_automation.hpp"
(Private to src/app/grid/grid_cli.)

+ Inheritance diagram for NAutomation::SNetStorageObject:
+ Collaboration diagram for NAutomation::SNetStorageObject:

Public Types

using TSelf = SNetStorageObject
 
- 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

 SNetStorageObject (CAutomationProc *automation_proc, CNetStorageObject::TInstance object)
 
virtual const stringGetType () const override
 
void ExecInfo (const TArguments &args, SInputOutput &io)
 
void ExecAttrList (const TArguments &args, SInputOutput &io)
 
void ExecGetAttr (const TArguments &args, SInputOutput &io)
 
- Public Member Functions inherited from NAutomation::CAutomationObject
 CAutomationObject (CAutomationProc *automation_proc)
 
void SetID (TObjectID object_id)
 
TObjectID GetID () const
 
- 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...
 
virtual void DebugDump (CDebugDumpContext ddc, unsigned int depth) const
 Define method for dumping debug information. 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
 

Static Public Member Functions

static CCommand CallCommand ()
 
static TCommands CallCommands ()
 
- Static Public Member Functions inherited from NAutomation::CAutomationObject
template<class TDerived >
static void * CheckCall (const string &name, SInputOutput &io, void *data)
 
template<class TDerived >
static void ExecNew (const TArguments &args, SInputOutput &io, void *data)
 
template<class TClass , void(TClass::*)(const TArguments &, SInputOutput &io) Method>
static void ExecMethod (const TArguments &args, SInputOutput &io, void *data)
 
- 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

static const string kName = "nstobj"
 
- 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...
 

Private Attributes

CNetStorageObject m_Object
 

Additional Inherited Members

- Public Attributes inherited from NAutomation::CAutomationObject
CAutomationProcm_AutomationProc
 
- Protected Member Functions inherited from CObject
virtual void DeleteThis (void)
 Virtual method "deleting" this object. More...
 
- Protected Attributes inherited from NAutomation::CAutomationObject
TObjectID m_Id
 

Detailed Description

Definition at line 97 of file nst_automation.hpp.

Member Typedef Documentation

◆ TSelf

Definition at line 99 of file nst_automation.hpp.

Constructor & Destructor Documentation

◆ SNetStorageObject()

SNetStorageObject::SNetStorageObject ( CAutomationProc automation_proc,
CNetStorageObject::TInstance  object 
)

Definition at line 322 of file nst_automation.cpp.

Member Function Documentation

◆ CallCommand()

CCommand SNetStorageObject::CallCommand ( )
static

Definition at line 329 of file nst_automation.cpp.

References CallCommands(), and kName.

Referenced by NAutomation::CAutomationProc::CallCommands().

◆ CallCommands()

TCommands SNetStorageObject::CallCommands ( )
static

Definition at line 334 of file nst_automation.cpp.

References CJsonNode::eString.

Referenced by CallCommand().

◆ ExecAttrList()

void SNetStorageObject::ExecAttrList ( const TArguments args,
SInputOutput io 
)

◆ ExecGetAttr()

void SNetStorageObject::ExecGetAttr ( const TArguments args,
SInputOutput io 
)

◆ ExecInfo()

void SNetStorageObject::ExecInfo ( const TArguments args,
SInputOutput io 
)

◆ GetType()

virtual const string& NAutomation::SNetStorageObject::GetType ( void  ) const
inlineoverridevirtual

Implements NAutomation::CAutomationObject.

Definition at line 104 of file nst_automation.hpp.

References kName.

Member Data Documentation

◆ kName

const string SNetStorageObject::kName = "nstobj"
static

Definition at line 113 of file nst_automation.hpp.

Referenced by CallCommand(), and GetType().

◆ m_Object

CNetStorageObject NAutomation::SNetStorageObject::m_Object
private

Definition at line 116 of file nst_automation.hpp.

Referenced by ExecAttrList(), ExecGetAttr(), and ExecInfo().


The documentation for this struct was generated from the following files:
Modified on Sun May 19 04:45:36 2024 by modify_doxy.py rev. 669887