ts::BIOPNameComponent Struct Reference

One component of a BIOP Name (typically a path element). More...

#include <tsDSMCCBIOPMessage.h>

Collaboration diagram for ts::BIOPNameComponent:

Public Member Functions
bool	fromXML (DuckContext &duck, const xml::Element *element)
	This method decodes an XML BIOPNameComponent.
UString	idString () const
	Return the id as a UString, stripping any trailing NUL.
std::string	kindTag () const
	Return the kind as a std::string, stripping any trailing NUL.
void	toXML (DuckContext &duck, xml::Element *parent) const
	This method converts a BIOPNameComponent to XML.

Public Attributes
ByteBlock	id {}
	Raw id bytes (usually a NUL-terminated ASCII/UTF-8 string).
ByteBlock	kind {}
	Raw kind bytes (usually "fil\0", "dir\0", "srg\0" ...).

Detailed Description

One component of a BIOP Name (typically a path element).

Member Function Documentation

idString()

UString ts::BIOPNameComponent::idString

(

)

const

Return the id as a UString, stripping any trailing NUL.

Returns

The id as a UString.

kindTag()

std::string ts::BIOPNameComponent::kindTag

(

)

const

Return the kind as a std::string, stripping any trailing NUL.

Returns

The kind tag as a std::string.

toXML()

void ts::BIOPNameComponent::toXML	(	DuckContext &	duck,
		xml::Element *	parent
	)		const

This method converts a BIOPNameComponent to XML.

Parameters

[in,out]	duck	TSDuck execution context.
[in,out]	parent	The parent node for the XML element.

fromXML()

bool ts::BIOPNameComponent::fromXML	(	DuckContext &	duck,
		const xml::Element *	element
	)

This method decodes an XML BIOPNameComponent.

Parameters

[in,out]	duck	TSDuck execution context.
[in]	element	The XML element containing the name component.

Returns

True on success, false on error.

---

The documentation for this struct was generated from the following file:

• tsDSMCCBIOPMessage.h