NCBI C++ ToolKit
Public Types | Public Member Functions | Protected Attributes | Private Types | List of all members
CDataMemberContainerType Class Referenceabstract

Search Toolkit Book for CDataMemberContainerType

#include "blocktype.hpp"
(Private to src/serial/datatool.)

+ Inheritance diagram for CDataMemberContainerType:
+ Collaboration diagram for CDataMemberContainerType:

Public Types

typedef list< AutoPtr< CDataMember > > TMembers
 
- Public Types inherited from CDataType
enum  { eNoExplicitTag = -1 }
 
enum  EGlobalType { eElement = 0 , eType , eGroup }
 
typedef void * TObjectPtr
 
typedef list< const CReferenceDataType * > TReferences
 

Public Member Functions

virtual void PrintASN (CNcbiOstream &out, int indent) const override
 
virtual void PrintSpecDumpExtra (CNcbiOstream &out, int indent) const override
 
virtual void PrintJSONSchema (CNcbiOstream &out, int indent, list< string > &required, bool contents_only=false) const override
 
virtual void PrintXMLSchema (CNcbiOstream &out, int indent, bool contents_only=false) const override
 
virtual void PrintDTDElement (CNcbiOstream &out, bool contents_only=false) const override
 
virtual void PrintDTDExtra (CNcbiOstream &out) const override
 
virtual void FixTypeTree (void) const override
 
virtual bool CheckType (void) const override
 
void AddMember (const AutoPtr< CDataMember > &member)
 
virtual TObjectPtr CreateDefault (const CDataValue &value) const override
 
virtual const char * XmlMemberSeparator (void) const =0
 
const TMembers & GetMembers (void) const
 
CComments & LastComments (void)
 
bool UniElementNameExists (const string &name) const
 
- Public Member Functions inherited from CDataType
 CDataType (void)
 
virtual ~CDataType (void)
 
const CDataType * GetParentType (void) const
 
const CDataTypeModule * GetModule (void) const
 
bool HaveModuleName (void) const
 
const string & GetSourceFileName (void) const
 
int GetSourceLine (void) const
 
void SetSourceLine (int line)
 
string LocationString (void) const
 
string GetKeyPrefix (void) const
 
string IdName (void) const
 
string XmlTagName (void) const
 
const string & GlobalName (void) const
 
bool Skipped (void) const
 
string DefClassMemberName (void) const
 
string ClassName (void) const
 
string FileName (void) const
 
const CNamespace & Namespace (void) const
 
string InheritFromClass (void) const
 
const CDataType * InheritFromType (void) const
 
const string GetVar (const string &value, int collect=0) const
 
bool GetBoolVar (const string &value, bool default_value=false) const
 
void ForbidVar (const string &var, const string &value)
 
void AllowVar (const string &var, const string &value)
 
const string GetAndVerifyVar (const string &value) const
 
bool InChoice (void) const
 
void PrintASNTypeComments (CNcbiOstream &out, int indent, int flags=0) const
 
void PrintDTDTypeComments (CNcbiOstream &out, int indent) const
 
virtual void PrintSpecDump (CNcbiOstream &out, int indent) const
 
virtual const char * GetASNKeyword (void) const
 
virtual string GetSpecKeyword (void) const
 
virtual string GetSchemaTypeString (void) const
 
void PrintDTD (CNcbiOstream &out) const
 
void PrintDTD (CNcbiOstream &out, const CComments &extra) const
 
virtual CTypeRef GetTypeInfo (void)
 
virtual const CTypeInfo * GetAnyTypeInfo (void)
 
virtual bool NeedAutoPointer (const CTypeInfo *typeInfo) const
 
virtual const CTypeInfo * GetRealTypeInfo (void)
 
virtual CTypeInfo * CreateTypeInfo (void)
 
CTypeInfo * UpdateModuleName (CTypeInfo *typeInfo) const
 
void Warning (const string &mess, int err_subcode=0) const
 
virtual AutoPtr< CTypeStrings > GenerateCode (void) const
 
void SetParentClassTo (CClassTypeStrings &code) const
 
virtual AutoPtr< CTypeStrings > GetRefCType (void) const
 
virtual AutoPtr< CTypeStrings > GetFullCType (void) const
 
virtual string GetDefaultString (const CDataValue &value) const
 
virtual const CDataType * Resolve (void) const
 
virtual CDataType * Resolve (void)
 
CDataType * ResolveGlobal (const string &name) const
 
CDataType * ResolveLocal (const string &name) const
 
bool IsInSet (void) const
 
const CUniSequenceDataType * GetInSet (void) const
 
void SetInSet (const CUniSequenceDataType *sequence)
 
bool IsInChoice (void) const
 
const CChoiceDataType * GetInChoice (void) const
 
void SetInChoice (const CChoiceDataType *choice)
 
bool IsReferenced (void) const
 
void AddReference (const CReferenceDataType *reference)
 
const TReferences & GetReferences (void) const
 
bool IsInUniSeq (void) const
 
bool IsUniSeq (void) const
 
bool IsContainer (void) const
 
bool IsEnumType (void) const
 
void SetParent (const CDataType *parent, const string &memberName, string xmlName=kEmptyStr)
 
void SetParent (const CDataTypeModule *module, const string &typeName)
 
bool Check (void)
 
virtual bool CheckValue (const CDataValue &value) const =0
 
CComments & Comments (void)
 
const CComments & Comments (void) const
 
void SetDataMember (CDataMember *dm)
 
const CDataMember * GetDataMember (void) const
 
void SetTag (CAsnBinaryDefs::TLongTag tag)
 
CAsnBinaryDefs::TLongTag GetTag (void) const
 
bool HasTag (void) const
 
void SetTagClass (CAsnBinaryDefs::ETagClass tclass)
 
CAsnBinaryDefs::ETagClass GetTagClass (void) const
 
void SetTagType (CAsnBinaryDefs::ETagType ttype)
 
CAsnBinaryDefs::ETagType GetTagType (void) const
 
CNcbiOstream & PrintASNTag (CNcbiOstream &out) const
 
void SetTypeStr (CClassTypeStrings *TypeStr) const
 
CClassTypeStrings * GetTypeStr (void) const
 
bool IsPrimitive (void) const
 
bool IsStdType (void) const
 
bool IsReference (void) const
 
void SetIsAlias (bool value)
 
bool IsAlias (void) const
 
void SetIsTypeAlias (bool value) const
 
bool IsTypeAlias (void) const
 
virtual const char * GetDEFKeyword (void) const
 
const string & GetMemberName (void) const
 
void SetNamespaceName (const string &name)
 
const string & GetNamespaceName (void) const
 
void SetNsQualified (bool qualified)
 
ENsQualifiedMode IsNsQualified (void) const
 
void SetNillable (void)
 
bool IsNillable (void) const
 
void SetGlobalType (EGlobalType type)
 
EGlobalType GetGlobalType (void) const
 
void SetEmptyExternalName (bool set)
 
bool HasExternalName (void) const
 
string GetFullName (void) const
 
void SetRestrictions (const list< CMemberFacet > &c)
 
const list< CMemberFacet > & GetRestrictions (void) const
 

Protected Attributes

TMembers m_Members
 
CComments m_LastComments
 

Private Types

typedef CDataType CParent
 

Additional Inherited Members

- Static Public Member Functions inherited from CDataType
static string GetTagClassString (CAsnBinaryDefs::ETagClass tclass)
 
static string GetTagTypeString (CAsnBinaryDefs::ETagType ttype)
 
static void EnableDTDEntities (bool enable=true)
 
static bool DTDEntitiesEnabled (void)
 
static void SetEnforcedStdXml (bool set=true)
 
static bool GetEnforcedStdXml (void)
 
static void SetSourceDataSpec (EDataSpec spec)
 
static EDataSpec GetSourceDataSpec (void)
 
static string GetSourceDataSpecString (void)
 
static bool IsASNDataSpec (void)
 
static bool IsXMLDataSpec (void)
 
- Protected Member Functions inherited from CDataType
void x_SetMemberAndClassName (const string &memberName)
 
- Static Protected Member Functions inherited from CDataType
static bool x_IsSavedName (const string &name)
 
static void x_AddSavedName (const string &name)
 

Detailed Description

Definition at line 134 of file blocktype.hpp.

Member Typedef Documentation

◆ CParent

typedef CDataType CDataMemberContainerType::CParent
private

Definition at line 135 of file blocktype.hpp.

◆ TMembers

typedef list< AutoPtr<CDataMember> > CDataMemberContainerType::TMembers

Definition at line 137 of file blocktype.hpp.

Member Function Documentation

◆ AddMember()

void CDataMemberContainerType::AddMember ( const AutoPtr< CDataMember > &  member)

Definition at line 83 of file blocktype.cpp.

References m_Members.

◆ CheckType()

bool CDataMemberContainerType::CheckType ( void  ) const
overridevirtual

Reimplemented from CDataType.

Definition at line 663 of file blocktype.cpp.

◆ CreateDefault()

TObjectPtr CDataMemberContainerType::CreateDefault ( const CDataValue &  value) const
overridevirtual

Implements CDataType.

Reimplemented in CWsdlDataType.

Definition at line 723 of file blocktype.cpp.

◆ FixTypeTree()

void CDataMemberContainerType::FixTypeTree ( void  ) const
overridevirtual

Reimplemented from CDataType.

Reimplemented in CChoiceDataType.

Definition at line 655 of file blocktype.cpp.

Referenced by CChoiceDataType::FixTypeTree().

◆ GetMembers()

const TMembers& CDataMemberContainerType::GetMembers ( void  ) const
inline

Definition at line 155 of file blocktype.hpp.

References m_Members.

Referenced by CChoiceDataType::CheckValue(), CCodeGenerator::CollectTypes(), CChoiceDataType::CreateTypeInfo(), CChoiceDataType::FixTypeTree(), CClientPseudoTypeStrings::GenerateClassCode(), CChoiceDataType::GetFullCType(), CDataType::GetFullName(), CChoiceDataType::PrintASN(), PrintXMLSchema(), CUniSequenceDataType::PrintXMLSchema(), s_ChoiceType(), ASNParser::TypesBlock(), x_CollectMembers(), and CTraversalCodeGenerator::x_CreateNode().

◆ LastComments()

CComments& CDataMemberContainerType::LastComments ( void  )
inline

Definition at line 160 of file blocktype.hpp.

References m_LastComments.

◆ PrintASN()

void CDataMemberContainerType::PrintASN ( CNcbiOstream &  out,
int  indent 
) const
overridevirtual

Implements CDataType.

Reimplemented in CChoiceDataType, and CWsdlDataType.

Definition at line 88 of file blocktype.cpp.

References CComments::eMultiline, CDataType::GetASNKeyword(), i, indent(), ITERATE, last(), m_LastComments, m_Members, next(), out(), CDataMember::PrintASN(), CComments::PrintASN(), PrintASNNewLine(), and CDataType::PrintASNTag().

Referenced by CChoiceDataType::PrintASN().

◆ PrintDTDElement()

void CDataMemberContainerType::PrintDTDElement ( CNcbiOstream &  out,
bool  contents_only = false 
) const
overridevirtual

Implements CDataType.

Reimplemented in CWsdlDataType.

Definition at line 496 of file blocktype.cpp.

◆ PrintDTDExtra()

void CDataMemberContainerType::PrintDTDExtra ( CNcbiOstream &  out) const
overridevirtual

Reimplemented from CDataType.

Definition at line 642 of file blocktype.cpp.

◆ PrintJSONSchema()

void CDataMemberContainerType::PrintJSONSchema ( CNcbiOstream &  out,
int  indent,
list< string > &  required,
bool  contents_only = false 
) const
overridevirtual

Implements CDataType.

Reimplemented in CChoiceDataType, and CWsdlDataType.

Definition at line 118 of file blocktype.cpp.

References CDataMember::Attlist(), data, first(), CDataType::GetDataMember(), CDataType::GetMemberName(), CDataMember::GetName(), CDataMember::GetType(), i, indent(), CDataType::IsContainer(), ITERATE, m_Members, CDataMember::Notag(), out(), PrintASNNewLine(), CDataMember::PrintJSONSchema(), and transform().

◆ PrintSpecDumpExtra()

void CDataMemberContainerType::PrintSpecDumpExtra ( CNcbiOstream &  out,
int  indent 
) const
overridevirtual

Reimplemented from CDataType.

Definition at line 106 of file blocktype.cpp.

References CDataMember::Attlist(), CComments::eNoEOL, CDataType::GetDataMember(), CDataType::GetParentType(), i, indent(), ITERATE, m_LastComments, m_Members, out(), and CComments::PrintASN().

◆ PrintXMLSchema()

void CDataMemberContainerType::PrintXMLSchema ( CNcbiOstream &  out,
int  indent,
bool  contents_only = false 
) const
overridevirtual

Implements CDataType.

Reimplemented in CWsdlDataType.

Definition at line 249 of file blocktype.cpp.

References CDataMember::Attlist(), CDataType::Comments(), data, CDataType::eGroup, CDataType::eType, CDataType::GetASNKeyword(), CDataType::GetDataMember(), CUniSequenceDataType::GetElementType(), CDataType::GetEnforcedStdXml(), CDataType::GetGlobalType(), CDataType::GetMemberName(), GetMembers(), CDataType::GetParentType(), CDataType::GetReferences(), CDataMember::GetType(), i, indent(), CDataType::IsNillable(), CDataType::IsReferenced(), ITERATE, m_Members, CDataMember::Notag(), CDataMember::Optional(), out(), PrintASNNewLine(), ncbi::grid::netcache::search::fields::size, str(), tag, tmp, and CDataType::XmlTagName().

◆ UniElementNameExists()

bool CDataMemberContainerType::UniElementNameExists ( const string &  name) const

Definition at line 729 of file blocktype.cpp.

◆ XmlMemberSeparator()

virtual const char* CDataMemberContainerType::XmlMemberSeparator ( void  ) const
pure virtual

Implemented in CChoiceDataType, and CDataContainerType.

Member Data Documentation

◆ m_LastComments

CComments CDataMemberContainerType::m_LastComments
protected

Definition at line 168 of file blocktype.hpp.

Referenced by LastComments(), PrintASN(), CChoiceDataType::PrintASN(), and PrintSpecDumpExtra().

◆ m_Members

TMembers CDataMemberContainerType::m_Members
protected

Definition at line 167 of file blocktype.hpp.

Referenced by AddMember(), GetMembers(), PrintASN(), PrintJSONSchema(), CChoiceDataType::PrintJSONSchema(), PrintSpecDumpExtra(), and PrintXMLSchema().

The documentation for this class was generated from the following files:
Generated by doxygen 1.9.0
Modified on Mon Jun 10 04:52:53 2024 by modify_doxy.py rev. 669887