Class ISubBlockMetadataMetadataView

Class ISubBlockMetadataMetadataView#

Inheritance Relationships#

Derived Type#

Class Documentation#

class ISubBlockMetadataMetadataView#

This interface provides typed access to the metadata of a sub-block.

Subclassed by libCZI::ISubBlockMetadata

Public Functions

ISubBlockMetadataMetadataView() = default#
virtual ~ISubBlockMetadataMetadataView() = default#
virtual bool TryGetAttachmentDataFormat(std::wstring *data_format) = 0#

Attempts to get “attachment data format” - the format of data in the attachment of the sub-block. This information is retrieved from the node “METADATA/AttachmentSchema/DataFormat”.

Parameters:

data_format – [out] If non-null, the data format is output here.

Returns:

True if it succeeds; false otherwise.

virtual bool TryGetTagAsDouble(const std::wstring &tag_name, double *value) = 0#

Attempts to get the specified tag, parsed as a double, from the sub-block metadata. The data is retrieved from the node “METADATA/Tags/<tag-name>”.

Parameters:

  • tag_name – The tag name.

  • value – [inout] If non-null, the value is put here

Returns:

True if it succeeds; false otherwise.

virtual bool TryGetTagAsString(const std::wstring &tag_name, std::wstring *value) = 0#

Attempts to get the content of the specified tag from the sub-block metadata. The data is retrieved from the node “METADATA/Tags/<tag-name>”.

Parameters:

  • tag_name – The tag name.

  • value – [inout] If non-null, the content is put here

Returns:

True if it succeeds; false otherwise.

virtual bool TryGetStagePositionFromTags(std::tuple<double, double> *stage_position) = 0#

Attempts to get “stage position” from the sub-block metadata. This information is retrieved from the node “METADATA/Tags/StageXPosition” and “METADATA/Tags/StageYPosition”. Note that X and Y need to be present in order to have this function return true.

Parameters:

stage_position – [inout] If non-null, the stage position is put here.

Returns:

True if it succeeds; false otherwise.

ISubBlockMetadataMetadataView(const ISubBlockMetadataMetadataView&) = delete#
ISubBlockMetadataMetadataView &operator=(const ISubBlockMetadataMetadataView&) = delete#
ISubBlockMetadataMetadataView(ISubBlockMetadataMetadataView&&) = delete#
ISubBlockMetadataMetadataView &operator=(ISubBlockMetadataMetadataView&&) = delete#
Contents