Class DicomDatasetLogger

DICOM dataset walker for logging.

Inheritance
System.Object
DicomDatasetLogger
Implements
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: FellowOakDicom.Log
Assembly: fo-dicom.core.dll
Syntax
public class DicomDatasetLogger : IDicomDatasetWalker

Constructors

DicomDatasetLogger(ILogger, LogLevel, Int32, Int32)

Initializes an instance of DicomDatasetLogger.

Declaration
public DicomDatasetLogger(ILogger logger, LogLevel level, int width = 128, int valueLength = 64)
Parameters
Type Name Description
Microsoft.Extensions.Logging.ILogger logger

Logger.
Microsoft.Extensions.Logging.LogLevel level

Log level.
System.Int32 width

Maximum write width.
System.Int32 valueLength

Maximum value length.

Methods

OnBeginFragment(DicomFragmentSequence)

Handler for traversing beginning of fragment.

Declaration
public bool OnBeginFragment(DicomFragmentSequence fragment)
Parameters
Type Name Description
DicomFragmentSequence fragment

Fragment sequence.
Returns
Type Description
System.Boolean

true if traversing completed without issues, false otherwise.

OnBeginSequence(DicomSequence)

Handler for traversing beginning of sequence.

Declaration
public bool OnBeginSequence(DicomSequence sequence)
Parameters
Type Name Description
DicomSequence sequence

Sequence to traverse.
Returns
Type Description
System.Boolean

true if traversing completed without issues, false otherwise.

OnBeginSequenceItem(DicomDataset)

Handler for traversing beginning of sequence item.

Declaration
public bool OnBeginSequenceItem(DicomDataset dataset)
Parameters
Type Name Description
DicomDataset dataset

Item dataset.
Returns
Type Description
System.Boolean

true if traversing completed without issues, false otherwise.

OnBeginWalk()

Handler for beginning the traversal.

Declaration
public void OnBeginWalk()

OnElement(DicomElement)

Handler for traversing a DICOM element.

Declaration
public bool OnElement(DicomElement element)
Parameters
Type Name Description
DicomElement element

Element to traverse.
Returns
Type Description
System.Boolean

true if traversing completed without issues, false otherwise.

OnElementAsync(DicomElement)

Asynchronous handler for traversing a DICOM element.

Declaration
public Task<bool> OnElementAsync(DicomElement element)
Parameters
Type Name Description
DicomElement element

Element to traverse.
Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>

true if traversing completed without issues, false otherwise.

OnEndFragment()

Handler for traversing end of fragment.

Declaration
public bool OnEndFragment()
Returns
Type Description
System.Boolean

true if traversing completed without issues, false otherwise.

OnEndSequence()

Handler for traversing end of sequence.

Declaration
public bool OnEndSequence()
Returns
Type Description
System.Boolean

true if traversing completed without issues, false otherwise.

OnEndSequenceItem()

Handler for traversing end of sequence item.

Declaration
public bool OnEndSequenceItem()
Returns
Type Description
System.Boolean

true if traversing completed without issues, false otherwise.

OnEndWalk()

Handler for end of traversal.

Declaration
public void OnEndWalk()

OnFragmentItem(IByteBuffer)

Handler for traversing fragment item.

Declaration
public bool OnFragmentItem(IByteBuffer item)
Parameters
Type Name Description
IByteBuffer item

Buffer containing the fragment item.
Returns
Type Description
System.Boolean

true if traversing completed without issues, false otherwise.

OnFragmentItemAsync(IByteBuffer)

Asynchronous handler for traversing fragment item.

Declaration
public Task<bool> OnFragmentItemAsync(IByteBuffer item)
Parameters
Type Name Description
IByteBuffer item

Buffer containing the fragment item.
Returns
Type Description
System.Threading.Tasks.Task<System.Boolean>

true if traversing completed without issues, false otherwise.

Implements

Extension Methods