NCBI C++ ToolKit
Public Member Functions | Private Types | Private Member Functions | List of all members
CPluginArgSet Class Reference

Represents ASN.1 type PluginArgSet defined in file gui_objects.asn

Search Toolkit Book for CPluginArgSet

namespace ncbi::objects:: More...

#include <gui/objects/PluginArgSet.hpp>

+ Inheritance diagram for CPluginArgSet:
+ Collaboration diagram for CPluginArgSet:

Public Member Functions

 CPluginArgSet (void)
 constructor More...
 
 ~CPluginArgSet (void)
 destructor More...
 
const CPluginArgoperator[] (const string &name) const
 operator[] for indexing based on named argument this will throw if the named argument isn't found More...
 
CPluginArgoperator[] (const string &name)
 operator[] for indexing based on named argument (non-const) this will throw if the named argument isn't found More...
 
void ClearObjects ()
 Clear all objects from object-based arguments. More...
 
bool HasArgument (const string &name) const
 HasArgument() verifies that an argument exists. More...
 
void RemoveArgument (const string &arg_name)
 Delete an existing argument. More...
 
CPluginArgAddArgument (const string &name, const string &desc, CPluginArg::EType type, CPluginArg::TData::E_Choice single_or_array=CPluginArg::TData::e_Single)
 add a named argument. More...
 
CPluginArgAddArgument (const string &name, const string &desc, const CTypeInfo *info, CPluginArg::TData::E_Choice single_or_array=CPluginArg::TData::e_Single)
 add a named argument. More...
 
CPluginArgAddFlag (const string &name, const string &desc)
 Add a flag value. More...
 
CPluginArgAddDefaultArgument (const string &name, const string &description, CPluginArg::EType type, const string &val)
 Add a default argument to the set of arguments. More...
 
CPluginArgAddDefaultFlag (const string &name, const string &desc, bool val)
 Add a flag argument with a default value. More...
 
CPluginArgAddOptionalArgument (const string &name, const string &description, CPluginArg::EType type, CPluginArg::TData::E_Choice single_or_array=CPluginArg::TData::e_Single)
 add an optional argument to the set of arguments. More...
 
CPluginArgAddOptionalArgument (const string &name, const string &description, const CTypeInfo *info, CPluginArg::TData::E_Choice single_or_array=CPluginArg::TData::e_Single)
 
void SetConstraint (const string &name, CPluginValueConstraint &constraint)
 Set the constraint of a named argument. More...
 
void AddConstraint (const string &name, CPluginValueConstraint &constraint)
 Add a constraint to a named argument. More...
 
void RemoveConstraint (const string &name)
 Remove the constraint of a named argument. More...
 
- Public Member Functions inherited from CPluginArgSet_Base
 CPluginArgSet_Base (void)
 
virtual ~CPluginArgSet_Base (void)
 
 DECLARE_INTERNAL_TYPE_INFO ()
 
bool IsSet (void) const
 Check if a value has been assigned to data member. More...
 
bool CanGet (void) const
 Check if it is safe to call Get method. More...
 
void Reset (void)
 Reset data member. More...
 
const TdataGet (void) const
 Get the member data. More...
 
TdataSet (void)
 Assign a value to data member. More...
 
 operator const Tdata & (void) const
 Conversion operator to 'const Tdata' type. More...
 
 operator Tdata & (void)
 Conversion operator to 'Tdata' type. 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 CPluginArgSet_Base Tparent
 

Private Member Functions

 CPluginArgSet (const CPluginArgSet &value)
 Prohibit copy constructor and assignment operator. More...
 
CPluginArgSetoperator= (const CPluginArgSet &value)
 

Additional Inherited Members

- Public Types inherited from CPluginArgSet_Base
typedef list< CRef< CPluginArg > > Tdata
 
- 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...
 
- 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

namespace ncbi::objects::

Definition at line 58 of file PluginArgSet.hpp.

Member Typedef Documentation

◆ Tparent

Definition at line 60 of file PluginArgSet.hpp.

Constructor & Destructor Documentation

◆ CPluginArgSet() [1/2]

CPluginArgSet::CPluginArgSet ( void  )
inline

constructor

Definition at line 157 of file PluginArgSet.hpp.

◆ ~CPluginArgSet()

CPluginArgSet::~CPluginArgSet ( void  )

destructor

Definition at line 53 of file PluginArgSet.cpp.

◆ CPluginArgSet() [2/2]

CPluginArgSet::CPluginArgSet ( const CPluginArgSet value)
private

Prohibit copy constructor and assignment operator.

Member Function Documentation

◆ AddArgument() [1/2]

CPluginArg & CPluginArgSet::AddArgument ( const string name,
const string desc,
const CTypeInfo info,
CPluginArg::TData::E_Choice  single_or_array = CPluginArg::TData::e_Single 
)

add a named argument.

This argument is required, and has no default value. Attempts to access the value without setting the value will result in an exception being thrown.

Definition at line 189 of file PluginArgSet.cpp.

References CPluginArg_Base::C_Data::e_Array, HasArgument(), NCBI_THROW, and CPluginArgSet_Base::Set().

◆ AddArgument() [2/2]

CPluginArg & CPluginArgSet::AddArgument ( const string name,
const string desc,
CPluginArg::EType  type,
CPluginArg::TData::E_Choice  single_or_array = CPluginArg::TData::e_Single 
)

add a named argument.

This argument is required, and has no default value. Attempts to access the value without setting the value will result in an exception being thrown.

Definition at line 126 of file PluginArgSet.cpp.

References CPluginArg_Base::C_Data::e_Array, CPluginArg::eAnySerialObject, CPluginArg::eBoolean, CPluginArg::eDouble, CPluginArg::eInputFile, CPluginArg::eInteger, CPluginArg::eNotSet, CPluginArg::eObject, CPluginArg::eOutputFile, CPluginArg::eProject, CPluginArg::eSecretString, CPluginArg::eString, HasArgument(), NCBI_THROW, and CPluginArgSet_Base::Set().

Referenced by CPluginCommand::AddArgument(), and AddFlag().

◆ AddConstraint()

void CPluginArgSet::AddConstraint ( const string name,
CPluginValueConstraint constraint 
)

Add a constraint to a named argument.

This will throw an exception if the argument is not found

Definition at line 388 of file PluginArgSet.cpp.

References CPluginArg_Base::SetConstraint().

Referenced by CPluginCommand::AddConstraint().

◆ AddDefaultArgument()

CPluginArg & CPluginArgSet::AddDefaultArgument ( const string name,
const string description,
CPluginArg::EType  type,
const string val 
)

◆ AddDefaultFlag()

CPluginArg & CPluginArgSet::AddDefaultFlag ( const string name,
const string desc,
bool  val 
)

Add a flag argument with a default value.

This is a helper API; the request is reformatted and passed on to AddDefaultArgument

Definition at line 276 of file PluginArgSet.cpp.

References AddDefaultArgument(), NStr::BoolToString(), CPluginArg::eBoolean, and val.

Referenced by CPluginCommand::AddDefaultFlag().

◆ AddFlag()

CPluginArg & CPluginArgSet::AddFlag ( const string name,
const string desc 
)

Add a flag value.

This is a helper API; the request is reformatted and passed on to AddArgument()

Definition at line 269 of file PluginArgSet.cpp.

References AddArgument(), and CPluginArg::eBoolean.

Referenced by CPluginCommand::AddFlag().

◆ AddOptionalArgument() [1/2]

CPluginArg & CPluginArgSet::AddOptionalArgument ( const string name,
const string description,
const CTypeInfo info,
CPluginArg::TData::E_Choice  single_or_array = CPluginArg::TData::e_Single 
)

◆ AddOptionalArgument() [2/2]

CPluginArg & CPluginArgSet::AddOptionalArgument ( const string name,
const string description,
CPluginArg::EType  type,
CPluginArg::TData::E_Choice  single_or_array = CPluginArg::TData::e_Single 
)

◆ ClearObjects()

void CPluginArgSet::ClearObjects ( )

Clear all objects from object-based arguments.

Definition at line 58 of file PluginArgSet.cpp.

References NON_CONST_ITERATE, and CPluginArgSet_Base::Set().

Referenced by CPluginCommand::ClearObjects().

◆ HasArgument()

bool CPluginArgSet::HasArgument ( const string name) const

HasArgument() verifies that an argument exists.

Definition at line 98 of file PluginArgSet.cpp.

References CPluginArgSet_Base::Get(), and ITERATE.

Referenced by AddArgument(), AddDefaultArgument(), AddOptionalArgument(), and CPluginCommand::HasArgument().

◆ operator=()

CPluginArgSet& CPluginArgSet::operator= ( const CPluginArgSet value)
private

◆ operator[]() [1/2]

CPluginArg & CPluginArgSet::operator[] ( const string name)

operator[] for indexing based on named argument (non-const) this will throw if the named argument isn't found

Definition at line 82 of file PluginArgSet.cpp.

References NCBI_THROW, NON_CONST_ITERATE, and CPluginArgSet_Base::Set().

◆ operator[]() [2/2]

const CPluginArg & CPluginArgSet::operator[] ( const string name) const

operator[] for indexing based on named argument this will throw if the named argument isn't found

Definition at line 68 of file PluginArgSet.cpp.

References CPluginArgSet_Base::Get(), ITERATE, and NCBI_THROW.

◆ RemoveArgument()

void CPluginArgSet::RemoveArgument ( const string arg_name)

Delete an existing argument.

Definition at line 110 of file PluginArgSet.cpp.

References NON_CONST_ITERATE, and CPluginArgSet_Base::Set().

Referenced by CPluginCommand::RemoveArgument().

◆ RemoveConstraint()

void CPluginArgSet::RemoveConstraint ( const string name)

Remove the constraint of a named argument.

This will throw an exception if the argument is not found.

Definition at line 395 of file PluginArgSet.cpp.

References CPluginArg_Base::ResetConstraint().

◆ SetConstraint()

void CPluginArgSet::SetConstraint ( const string name,
CPluginValueConstraint constraint 
)

Set the constraint of a named argument.

This will throw an exception if the argument is not found, and will replace all previous constraints if the argument is found

Definition at line 376 of file PluginArgSet.cpp.

References CPluginArg_Base::SetConstraint().

Referenced by CPluginCommand::SetConstraint().


The documentation for this class was generated from the following files:
Modified on Sat Apr 13 11:47:05 2024 by modify_doxy.py rev. 669887