OpenSplice ISO C++ 2 DCPS  v6.x
ISO C++ 2 OpenSplice Data Distribution Service Data-Centric Publish-Subscribe API
dds::core::xtypes::StructType Class Reference

#include "StructType.hpp"

Inheritance diagram for dds::core::xtypes::StructType:
Inheritance graph

Public Member Functions

 StructType (const std::string &name)
 
 StructType (const std::string &name, const StructType &parent, const std::vector< MemberType > &members)
 
template<typename MemberIter >
 StructType (const std::string &name, const StructType &parent, const MemberIter &begin, const MemberIter &end)
 
 StructType (const std::string &name, const StructType &parent, const std::vector< MemberType > &members, const Annotation &annotation)
 
 StructType (const std::string &name, const StructType &parent, const std::vector< MemberType > &members, const std::vector< Annotation > &annotations)
 
template<typename AnnotationIter , typename MemberIter >
 StructType (const std::string &name, const StructType &parent, const MemberIter &begin, const MemberIter &end, const AnnotationIter &begin, const AnnotationIter &end)
 
StructType add_annotation (const Annotation &annotation) const
 
StructType add_member (const MemberType &member) const
 
const std::vector< Annotation > & annotations () const
 
const MemberTypemember (uint32_t id) const
 
const MemberTypemember (const std::string &name) const
 
const std::vector< MemberType > & members () const
 
StructType parent () const
 
StructType remove_annotation (const Annotation &annotation) const
 
StructType remove_member (const MemberType &member) const
 

Detailed Description

Create a dynamic structure type. If the members don't have Id associated explicitly, then their ID will be the same as the ordinal position on the members vector.

Definition at line 68 of file StructType.hpp.

Constructor & Destructor Documentation

◆ StructType() [1/6]

dds::core::xtypes::StructType::StructType ( const std::string &  name)

◆ StructType() [2/6]

dds::core::xtypes::StructType::StructType ( const std::string &  name,
const StructType parent,
const std::vector< MemberType > &  members 
)

◆ StructType() [3/6]

template<typename MemberIter >
dds::core::xtypes::StructType::StructType ( const std::string &  name,
const StructType parent,
const MemberIter &  begin,
const MemberIter &  end 
)

◆ StructType() [4/6]

dds::core::xtypes::StructType::StructType ( const std::string &  name,
const StructType parent,
const std::vector< MemberType > &  members,
const Annotation annotation 
)

◆ StructType() [5/6]

dds::core::xtypes::StructType::StructType ( const std::string &  name,
const StructType parent,
const std::vector< MemberType > &  members,
const std::vector< Annotation > &  annotations 
)

◆ StructType() [6/6]

template<typename AnnotationIter , typename MemberIter >
dds::core::xtypes::StructType::StructType ( const std::string &  name,
const StructType parent,
const MemberIter &  begin,
const MemberIter &  end,
const AnnotationIter &  begin,
const AnnotationIter &  end 
)

Member Function Documentation

◆ add_annotation()

StructType dds::core::xtypes::StructType::add_annotation ( const Annotation annotation) const

◆ add_member()

StructType dds::core::xtypes::StructType::add_member ( const MemberType member) const

◆ annotations()

const std::vector<Annotation>& dds::core::xtypes::StructType::annotations ( ) const

◆ member() [1/2]

const MemberType& dds::core::xtypes::StructType::member ( uint32_t  id) const

◆ member() [2/2]

const MemberType& dds::core::xtypes::StructType::member ( const std::string &  name) const

◆ members()

const std::vector<MemberType>& dds::core::xtypes::StructType::members ( ) const

◆ parent()

StructType dds::core::xtypes::StructType::parent ( ) const

◆ remove_annotation()

StructType dds::core::xtypes::StructType::remove_annotation ( const Annotation annotation) const

◆ remove_member()

StructType dds::core::xtypes::StructType::remove_member ( const MemberType member) const

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