CXmlComment クラス

XML Comment 管理クラス [詳解]

#include <TnbXml.h>

CXmlComment の継承関係図

公開メンバ関数
CXmlComment	Clone (void) const
	[作成] クローン作成. [詳解]
	CXmlComment (CXmlNode n)
	コンストラクタ [詳解]
	CXmlComment (void)
	コンストラクタ [詳解]
CStr	GetComment (void) const
	[取得] Comment 取得. [詳解]
CStr	GetElementFullPath (void) const
	[作成] ルートからの Element名. [詳解]
CXmlNodePtr	GetNextSibling (void) const
	[取得] 隣のノード取得. [詳解]
CStr	GetNodeName (void) const
	[取得] 名前取得. [詳解]
CStr	GetNodeValue (void) const
	[取得] 値取得. [詳解]
CXmlNodePtr	GetParentNode (void) const
	[取得] 親のノード取得. [詳解]
void	Invalid (void)
	[設定] 無効化. [詳解]
bool	IsValid (void) const
	[確認] 有効確認. [詳解]
CXmlNodePtr	operator-> (void)
	[取得] ポインタハンドル取得. [詳解]
CXmlComment &	operator= (CXmlNode n)
	[代入] 代入 [詳解]
void	Remove (void)
	[削除] 自分自身を削除. [詳解]
void	Rename (LPCTSTR newName)
	[変更] 名前変更. [詳解]

限定公開変数類
CXmlNodePtr	m_pNode
	ノードクラスのポインタハンドル [詳解]

詳解

XML Comment 管理クラス

XML の管理クラスの一つ。XMLパーサのクラスをラップしていています。

本クラスのインスタンスでは Comment ノードを一つを管理します。

覚え書き

インスタンスは基本的に CXmlElement::AppendChildComment() の戻り値や CXmlNodeList から作成したり、 CXmlNode を代入宣言します。

例外

_com_error

失敗するとスローされます。

必要ファイル

TnbXml.h

日付

07/05/21 新規

TnbXml.h の 704 行目に定義があります。

構築子と解体子

CXmlComment() [1/2]

CXmlComment

(

void

)

コンストラクタ

覚え書き

無効なインスタンスに成ります。

TnbXml.h の 713 行目に定義があります。

CXmlComment() [2/2]

CXmlComment

(

CXmlNode

n

)

コンストラクタ

覚え書き

指定のノードが Text ではない時、無効なインスタンスに成ります。

引数

n

ノード管理クラス

TnbXml.h の 722 行目に定義があります。

関数詳解

Clone()

CXmlComment Clone

(

void

)

const

[作成] クローン作成.

本インスタンスで保持しているノードを複製します。

覚え書き

通常、複製したノードは、他のElementノードに AppendChildNode() します。

戻り値

ノード(追加された実態のノードの参照)。

TnbXml.h の 781 行目に定義があります。

GetComment()

CStr GetComment

(

void

)

const

[取得] Comment 取得.

本インスタンスで保持しているコメント内容を取得します。

覚え書き

GetNodeValue() と同じ動きです。

戻り値

値。

TnbXml.h の 754 行目に定義があります。

GetElementFullPath()

CStr GetElementFullPath ( void  ) const

inherited

[作成] ルートからの Element名.

自分自身がある階層を、Element 名の連結で表します。

ex)

/root/sub1/sub2

戻り値

Element階層名

TnbXml.h の 498 行目に定義があります。

GetNextSibling()

CXmlNodePtr GetNextSibling ( void  ) const

inherited

[取得] 隣のノード取得.

覚え書き

隣のノードがない場合、無効な CXmlNode が返ります。

戻り値

ノード。

TnbXml.h の 486 行目に定義があります。

GetNodeName()

CStr GetNodeName ( void  ) const

inherited

[取得] 名前取得.

本インスタンスで保持しているノードの名前を取得します。

覚え書き

ノードのタイプによって名前の意味は異なります。

戻り値

名前。

TnbXml.h の 440 行目に定義があります。

GetNodeValue()

CStr GetNodeValue ( void  ) const

inherited

[取得] 値取得.

本インスタンスで保持しているノードの値を取得します。

覚え書き

ノードのタイプによって値の意味は異なります。

戻り値

値。

TnbXml.h の 453 行目に定義があります。

GetParentNode()

CXmlNodePtr GetParentNode ( void  ) const

inherited

[取得] 親のノード取得.

覚え書き

親のノードがない場合、無効な CXmlNode が返ります。

戻り値

ノード。

TnbXml.h の 476 行目に定義があります。

Invalid()

void Invalid ( void  )

inherited

[設定] 無効化.

TnbXml.h の 429 行目に定義があります。

IsValid()

bool IsValid ( void  ) const

inherited

[確認] 有効確認.

本インスタンスが有効な情報を保持しているか、確認できます。

戻り値

true	有効。
false	無効。

TnbXml.h の 421 行目に定義があります。

operator->()

CXmlNodePtr operator-> ( void  )

inherited

[取得] ポインタハンドル取得.

本インスタンスで保持している CXmlNodePtr を得ることが出来ます。

覚え書き

直接 XMLパーサのメソッドを使用できます。

戻り値

ノードポインタハンドル

TnbXml.h の 410 行目に定義があります。

operator=()

CXmlComment & operator=

(

CXmlNode

n

)

[代入] 代入

引数

n

ノード管理

戻り値

自分の参照

TnbXml.h の 735 行目に定義があります。

Remove()

void Remove ( void  )

inherited

[削除] 自分自身を削除.

以下にぶら下がるノードがあれば、それも消えます。

覚え書き

本インスタンスは無効状態になります。以降の操作が出来ません。

TnbXml.h の 465 行目に定義があります。

Rename()

void Rename

(

LPCTSTR

newName

)

[変更] 名前変更.

本インスタンスで保持するコメントを変更します。

引数

newName

新しい名前

TnbXml.h の 764 行目に定義があります。

メンバ詳解

m_pNode

CXmlNodePtr m_pNode

protectedinherited

ノードクラスのポインタハンドル

TnbXml.h の 381 行目に定義があります。