NCBI C++ ToolKit
Classes | Public Types | Public Member Functions | Private Types | Private Member Functions | Private Attributes

Search Toolkit Book for CApad_Base

CApad_Base --. More...

#include <Apad_.hpp>

+ Inheritance diagram for CApad_Base:

List of all members.

Classes

class  C_Attlist
 C_Attlist --. More...
class  C_E_Apad
 C_E_Apad --. More...

Public Types

typedef C_Attlist TAttlist
typedef C_E_Apad C_E
typedef NCBI_NS_STD::list
< NCBI_NS_NCBI::CRef< C_E_Apad > > 
TApad

Public Member Functions

 CApad_Base (void)
virtual ~CApad_Base (void)
 DECLARE_INTERNAL_TYPE_INFO ()
bool IsSetAttlist (void) const
 used to mark up strings that require padding to create fixed-length string attributes.
bool CanGetAttlist (void) const
 Check if it is safe to call GetAttlist method.
void ResetAttlist (void)
 Reset Attlist data member.
const TAttlistGetAttlist (void) const
 Get the Attlist member data.
void SetAttlist (TAttlist &value)
 Assign a value to Attlist data member.
TAttlistSetAttlist (void)
 Assign a value to Attlist data member.
bool IsSetApad (void) const
 Check if a value has been assigned to Apad data member.
bool CanGetApad (void) const
 Check if it is safe to call GetApad method.
void ResetApad (void)
 Reset Apad data member.
const TApadGetApad (void) const
 Get the Apad member data.
TApadSetApad (void)
 Assign a value to Apad data member.
virtual void Reset (void)
 Reset the whole object.

Private Types

typedef NCBI_NS_NCBI::CSerialObject Tparent

Private Member Functions

 CApad_Base (const CApad_Base &)
CApad_Baseoperator= (const CApad_Base &)

Private Attributes

Uint4 m_set_State [1]
NCBI_NS_NCBI::CRef< TAttlistm_Attlist
TApad m_Apad

Detailed Description

CApad_Base --.

Definition at line 81 of file Apad_.hpp.


Member Typedef Documentation

Definition at line 575 of file Apad_.hpp.

typedef NCBI_NS_STD::list< NCBI_NS_NCBI::CRef< C_E_Apad > > CApad_Base::TApad

Definition at line 576 of file Apad_.hpp.

Definition at line 574 of file Apad_.hpp.

typedef NCBI_NS_NCBI::CSerialObject CApad_Base::Tparent [private]

Reimplemented in CApad.

Definition at line 83 of file Apad_.hpp.


Constructor & Destructor Documentation

END_CLASS_INFO CApad_Base::CApad_Base ( void  )

Definition at line 415 of file Apad_.cpp.

References m_set_State, and ResetAttlist().

CApad_Base::~CApad_Base ( void  ) [virtual]

Definition at line 424 of file Apad_.cpp.

CApad_Base::CApad_Base ( const CApad_Base ) [private]

Member Function Documentation

bool CApad_Base::CanGetApad ( void  ) const [inline]

Check if it is safe to call GetApad method.

Returns:
  • true, if the data member is getatable.
  • false, otherwise.

Definition at line 927 of file Apad_.hpp.

bool CApad_Base::CanGetAttlist ( void  ) const [inline]

Check if it is safe to call GetAttlist method.

Returns:
  • true, if the data member is getatable.
  • false, otherwise.

Definition at line 897 of file Apad_.hpp.

CApad_Base::DECLARE_INTERNAL_TYPE_INFO ( )
const CApad_Base::TApad & CApad_Base::GetApad ( void  ) const [inline]

Get the Apad member data.

Returns:
Reference to the member data.

Definition at line 933 of file Apad_.hpp.

References m_Apad.

const CApad_Base::TAttlist & CApad_Base::GetAttlist ( void  ) const [inline]

Get the Attlist member data.

Returns:
Reference to the member data.

Definition at line 903 of file Apad_.hpp.

References m_Attlist, and ResetAttlist().

bool CApad_Base::IsSetApad ( void  ) const [inline]

Check if a value has been assigned to Apad data member.

Data member Apad is optional; its type is defined as 'typedef NCBI_NS_STD::list< NCBI_NS_NCBI::CRef< C_E_Apad > > TApad'

Returns:
  • true, if a value has been assigned.
  • false, otherwise.

Definition at line 921 of file Apad_.hpp.

References m_set_State.

bool CApad_Base::IsSetAttlist ( void  ) const [inline]

used to mark up strings that require padding to create fixed-length string attributes.

It skips all preceding alpha characters before padding Check if a value has been assigned to Attlist data member.

Data member Attlist is mandatory; its type is defined as 'typedef C_Attlist TAttlist'

Returns:
  • true, if a value has been assigned.
  • false, otherwise.

Definition at line 891 of file Apad_.hpp.

References m_Attlist.

CApad_Base& CApad_Base::operator= ( const CApad_Base ) [private]
void CApad_Base::Reset ( void  ) [virtual]

Reset the whole object.

Definition at line 399 of file Apad_.cpp.

References ResetApad(), and ResetAttlist().

Referenced by CApad_Base::C_E_Apad::~C_E_Apad().

void CApad_Base::ResetApad ( void  )

Reset Apad data member.

Definition at line 393 of file Apad_.cpp.

References m_Apad, and m_set_State.

Referenced by Reset().

void CApad_Base::ResetAttlist ( void  )

Reset Attlist data member.

Definition at line 379 of file Apad_.cpp.

References m_Attlist.

Referenced by CApad_Base(), GetAttlist(), Reset(), and SetAttlist().

CApad_Base::TApad & CApad_Base::SetApad ( void  ) [inline]

Assign a value to Apad data member.

Returns:
Reference to the data value.

Definition at line 939 of file Apad_.hpp.

References m_Apad, and m_set_State.

void CApad_Base::SetAttlist ( CApad_Base::TAttlist value)

Assign a value to Attlist data member.

Parameters:
valueReference to value.

Definition at line 388 of file Apad_.cpp.

References m_Attlist.

CApad_Base::TAttlist & CApad_Base::SetAttlist ( void  ) [inline]

Assign a value to Attlist data member.

Returns:
Reference to the data value.

Definition at line 912 of file Apad_.hpp.

References m_Attlist, and ResetAttlist().


Member Data Documentation

Definition at line 663 of file Apad_.hpp.

Referenced by BEGIN_NAMED_BASE_CLASS_INFO(), GetApad(), ResetApad(), and SetApad().

NCBI_NS_NCBI::CRef< TAttlist > CApad_Base::m_Attlist [private]

The documentation for this class was generated from the following files:
Modified on Wed Feb 08 09:07:18 2012 by modify_doxy.py rev. 337098