vrLogService

クラス vrLogService

(vrBaseService を継承)

ログ記録機能へのアクセスを提供するサービスです。

ログ記録の動作を一時的に変更するために setLogEnabled、setLogLevel、または setLogType 関数を使用する場合は、対応する復元呼び出しが実行されていることを確認してください。次の例のように try ステートメントを使用することをお勧めします。

logEnabled = vrLogService.isLogEnabled()
vrLogService.setLogEnabled(False)
try:
    findNode("Name")
finally:
    vrLogService.setLogEnabled(logEnabled)

概要

関数:

関数

vrLogService.error(message, context={})

新しいエラー ログメッセージを追加します。

エラー メッセージは通常、赤で出力されます。

パラメータ:
  • message (string): ログに追加する必要があるエラー。
  • context (string): オプションのコンテキスト文字列。メッセージの前に角括弧で囲んで表示されます(例: [シーングラフ]ノードがロックされています)。

vrLogService.getLogType()
戻り値:現在アクティブなログ タイプ。
戻り値の型:vrLogTypes.LogType

vrLogService.info(message, context={})

新しい情報ログ メッセージを追加します。

パラメータ:
  • message (string): ログに追加する必要がある情報。
  • context (string): オプションのコンテキスト文字列。メッセージの前に角括弧で囲んで表示されます(例: [シーングラフ]ノードがロックされています)。

vrLogService.isLogEnabled()
戻り値:ログ記録が有効な場合は true、それ以外の場合は false。
戻り値の型:bool

vrLogService.setLogEnabled(value)

ログ記録を有効または無効にします。

パラメータ:value (bool): true の場合は、ログ記録が有効になります。false の場合は、ログ記録が無効になります。

vrLogService.setLogLevel(level)

ログ レベルを設定します。

ログ レベルは、ターミナルおよびログ ファイルに表示されるログ メッセージのタイプを定義します。現在、ログ レベルにはエラー、警告、情報という 3 つの異なるタイプがあります。各レベルは、指定したタイプと、重要度がそれ以上のタイプのメッセージを出力します。たとえば、ログ レベルが警告の場合はエラーも出力されます。

パラメータ:level (vrLogTypes.Level): 出力に使用されるログ レベル。

vrLogService.setLogType(type)

ログ メッセージのタイプを設定します。

パラメータ:type (vrLogTypes.LogType): アクティブにする必要があるメッセージのタイプ。複数のタイプの組み合わせを指定することもできます。

vrLogService.warning(message, context={})

新しい警告ログ メッセージを追加します。

警告メッセージは通常、黄色で出力されます。

パラメータ:
  • message (string): ログに追加する必要がある警告。
  • context (string): オプションのコンテキスト文字列。メッセージの前に角括弧で囲んで表示されます(例: [シーングラフ]ノードがロックされています)。