Custom type definition for service API in service description. Allows defining structs and enums. More...

#include <custom_type.hpp>

Public Types
using	Const_iterator = map< string, pair< string, string > >::const_iterator

enum	Type { Type::STRUCT, Type::ENUM }
	Defines the type of the custom type. More...

Public Member Functions
Const_iterator	beginDetails () const
	Begin iterator of details. More...

	CustomType (const tinyxml2::XMLElement *typeElement)
	Constructor. More...

Const_iterator	endDetails () const
	End iterator of details. More...

const string &	getName () const
	Get the name of the custom type. More...

Type	getType () const
	Get the type of the custom type. More...

	~CustomType ()=default
	dtor More...

Detailed Description

Custom type definition for service API in service description. Allows defining structs and enums.

Member Typedef Documentation

◆ Const_iterator

using kanzi::connect::CustomType::Const_iterator = map<string, pair<string, string> >::const_iterator

Member Enumeration Documentation

◆ Type

enum kanzi::connect::CustomType::Type

strong

Defines the type of the custom type.

Enumerator
STRUCT
ENUM

Constructor & Destructor Documentation

◆ CustomType()

kanzi::connect::CustomType::CustomType ( const tinyxml2::XMLElement * typeElement )

explicit

Constructor.

◆ ~CustomType()

kanzi::connect::CustomType::~CustomType ( )

default

dtor

Member Function Documentation

◆ beginDetails()

Const_iterator kanzi::connect::CustomType::beginDetails ( ) const

Begin iterator of details.

Returns: const iterator

◆ endDetails()

Const_iterator kanzi::connect::CustomType::endDetails ( ) const

End iterator of details.

Returns: const iterator

◆ getName()

const string& kanzi::connect::CustomType::getName ( ) const

Get the name of the custom type.

Returns: The name

◆ getType()

Type kanzi::connect::CustomType::getType ( ) const

Get the type of the custom type.

Returns: The type

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

connect/interface/custom_type.hpp

Public Types

Public Member Functions