Trait orthanc::entity::Entity[][src]

pub trait Entity: DeserializeOwned {
    fn kind() -> EntityKind;
fn id(&self) -> &str;
fn main_dicom_tag(&self, tag: &str) -> Option<&str>; fn parent_id(&self) -> Option<&str> { ... }
fn children(&self) -> &[String] { ... }
fn children_len(&self) -> usize { ... }
fn index(&self) -> Option<u32> { ... }
fn size(&self) -> u64 { ... }
fn parent_kind(&self) -> Option<EntityKind> { ... }
fn parent_kind_name(&self) -> Option<String> { ... }
fn children_kind_name(&self) -> Option<&str> { ... } }

A trait, that implements common methods for all entity kinds

Required methods

fn kind() -> EntityKind[src]

Entity kind

fn id(&self) -> &str[src]

The ID of the entity

fn main_dicom_tag(&self, tag: &str) -> Option<&str>[src]

Get the value of a DICOM tag from main_dicom_tags

Loading content...

Provided methods

fn parent_id(&self) -> Option<&str>[src]

The ID of the entity’s parent (Patient for Study, Study for Series, Series for Instance. None if the Entity does not have a parent (e.g. is a Patient)

fn children(&self) -> &[String][src]

The list of ID of the entity’s children (studies for Patient, series for Study, instances for Series)

fn children_len(&self) -> usize[src]

Number of children that the entity has

fn index(&self) -> Option<u32>[src]

Index of the instance in the series in case the entity is an Instance, None otherwise

fn size(&self) -> u64[src]

Size of the instance file in case the entity is an Instance, None otherwise

fn parent_kind(&self) -> Option<EntityKind>[src]

The kind of the entity’s parent entity. None if the entity does not have a parent (e.g. is a Patient)

fn parent_kind_name(&self) -> Option<String>[src]

The name of the entity’s parent entity. None if the entity does not have a parent (e.g. is a Patient)

fn children_kind_name(&self) -> Option<&str>[src]

Then name of the entity’s child entity, pluralized (e.g. “Studies”, “Series”, “Instances”). None if the entity does not have children (e.g. is an Instance)

Loading content...

Implementors

impl Entity for Instance[src]

fn kind() -> EntityKind[src]

Returns the EntityKind::Instance variant

fn id(&self) -> &str[src]

The ID of the instance

fn parent_id(&self) -> Option<&str>[src]

The ID of the series, that is the parent of this instance

fn main_dicom_tag(&self, tag: &str) -> Option<&str>[src]

Get the value of a DICOM tag from main_dicom_tags

fn parent_kind(&self) -> Option<EntityKind>[src]

fn index(&self) -> Option<u32>[src]

Index of the instance in the series

fn size(&self) -> u64[src]

Size of the instance file

impl Entity for Patient[src]

fn kind() -> EntityKind[src]

Returns the EntityKind::Patient variant

fn id(&self) -> &str[src]

The ID of the patient

fn children_kind_name(&self) -> Option<&str>[src]

Returns “studies”

fn main_dicom_tag(&self, tag: &str) -> Option<&str>[src]

Get the value of a DICOM tag from main_dicom_tags

fn children(&self) -> &[String][src]

Returns the list of IDs of all studies that belong to this patient

fn children_len(&self) -> usize[src]

Number of studies that belong to this patient

impl Entity for Series[src]

fn id(&self) -> &str[src]

The ID of the series

fn parent_id(&self) -> Option<&str>[src]

The ID of the study, that is the parent of this series

fn children_kind_name(&self) -> Option<&str>[src]

Returns “instances”

fn main_dicom_tag(&self, tag: &str) -> Option<&str>[src]

Get the value of a DICOM tag from main_dicom_tags

fn children(&self) -> &[String][src]

Returns the list of IDs of all instances that belong to this series

fn children_len(&self) -> usize[src]

Number of instances that belong to this series

fn parent_kind(&self) -> Option<EntityKind>[src]

impl Entity for Study[src]

fn kind() -> EntityKind[src]

Returns the EntityKind::Study variant

fn id(&self) -> &str[src]

The ID of the study

fn parent_id(&self) -> Option<&str>[src]

The ID of the patient, that is the parent of this study

fn children_kind_name(&self) -> Option<&str>[src]

Returns “series”

fn main_dicom_tag(&self, tag: &str) -> Option<&str>[src]

Get the value of a DICOM tag from main_dicom_tags, or if the tag is absent there, from patient_main_dicom_tags.

fn children(&self) -> &[String][src]

Returns the list of IDs of all series that belong to this study

fn children_len(&self) -> usize[src]

Number of series that belong to this study

fn parent_kind(&self) -> Option<EntityKind>[src]

Loading content...