"""
tkatomsiteモジュール
概要: 結晶中の原子サイトを表現するためのクラスtkAtomSiteを提供します。
詳細説明: このモジュールは、結晶構造における個々の原子サイトの属性（位置、占有率、名前など）を管理するためのクラスを定義します。
関連リンク: :doc:tkatomsite_usage
"""
import numpy as np
from numpy import sin, cos, tan, pi
import csv
import sys
from pprint import pprint
from tklib.tkobject import tkObject
from tklib.tkcrystal.tkatomsiteobject import tkAtomSiteObject
from tklib.tksci.tksci import a0, torad, todeg, Round
import tklib.tkre
#=====================================
# Space group class
#=====================================
[ドキュメント]
class tkAtomSite(tkAtomSiteObject):
"""
tkAtomSiteクラス
概要: 結晶構造における単一の原子サイトを表現するクラスです。
詳細説明: `tkAtomSiteObject` を継承し、原子のラベル、名前、電荷、位置、占有率、磁気モーメント、ワイス指数、水素情報などを管理します。
このクラスは、結晶学的な解析や視覚化のための原子サイトデータを効率的に扱うことを目的としています。
:param label: (str or None) 原子サイトの識別子。例: 'C1', 'O2'。デフォルトはNone。
:param name: (str) 原子サイトの名前（元素記号など）。例: 'C', 'O'。デフォルトは空文字列。
:param charge: (float or None) 原子サイトの電荷。デフォルトはNone。
:param pos: (list) 原子サイトの座標（デカルト座標または分数座標）のリスト。例: [0.1, 0.2, 0.3]。デフォルトは空リスト。
:param occ: (float) 原子サイトの占有率。0.0から1.0の範囲。デフォルトは1.0。
:param m: (float) 磁気モーメント。デフォルトは1。
:param ws: (int or None) ワイス指数。デフォルトはNone。
:param hydrogen: (bool or None) 原子が水素原子であるかどうかのフラグ。デフォルトはNone。
:**args: (dict) `tkAtomSiteObject` のコンストラクタに渡される追加のキーワード引数。
"""
def __init__(self, label = None, name = '', charge = None, pos = [], occ = 1.0,
m = 1, ws = None, hydrogen = None, **args):
"""
__init__メソッド
概要: `tkAtomSite` オブジェクトを初期化します。
詳細説明: 与えられたパラメータを使用して、新しい原子サイトオブジェクトを作成します。
基底クラス `tkAtomSiteObject` のコンストラクタを呼び出し、属性を設定します。
その後、`update` メソッドにより追加の引数が処理されます。
:param label: (str or None) 原子サイトの識別子。
:param name: (str) 原子サイトの名前（元素記号など）。
:param charge: (float or None) 原子サイトの電荷。
:param pos: (list) 原子サイトの座標のリスト。
:param occ: (float) 原子サイトの占有率。
:param m: (float) 磁気モーメント。
:param ws: (int or None) ワイス指数。
:param hydrogen: (bool or None) 原子が水素原子であるかどうかのフラグ。
:**args: (dict) `tkAtomSiteObject` のコンストラクタおよび `self.update` メソッドに渡される追加のキーワード引数。
:returns: (None) このメソッドは値を返しません。
"""
super(tkAtomSite, self).__init__(label, name, pos, occ, m, ws, hydrogen, **args)
self.update(**args)
def __del__(self):
"""
__del__メソッド
概要: `tkAtomSite` オブジェクトのデストラクタです。
詳細説明: オブジェクトが破棄される際に呼び出され、基底クラス `tkAtomSiteObject` のデストラクタを呼び出します。
これにより、オブジェクトに関連付けられたリソースが適切に解放されます。
:returns: (None) このメソッドは値を返しません。
"""
super(tkAtomSite, self).__del__()
def __str__(self):
"""
__str__メソッド
概要: オブジェクトの文字列表現を返します。
詳細説明: このオブジェクトのクラスパスを文字列として返します。
主にデバッグやログ出力に使用され、オブジェクトの型を識別するのに役立ちます。
:returns: (str) オブジェクトのクラスパスを示す文字列。例: 'tklib.tkcrystal.tkatomsite.tkAtomSite'。
"""
return self.ClassPath()