dds::core::xtypes::MemberType Class Reference

#include "MemberType.hpp"

Inheritance diagram for dds::core::xtypes::MemberType:

Public Member Functions
	MemberType (const std::string &name, const dds::core::xtypes::DynamicType &type)
	MemberType (const std::string &name, const dds::core::xtypes::DynamicType &type, const Annotation &annotation)
template<typename AnnotationIter >
	MemberType (const std::string &name, const dds::core::xtypes::DynamicType &type, const AnnotationIter &begin, const AnnotationIter &end)
	MemberType (const std::string &name, const dds::core::xtypes::DynamicType &type, const std::vector< Annotation > &annotations)
MemberType	add_annotation (const Annotation &annotation)
bool	is_nil () const
const std::string &	name () const
template<typename R >
bool	operator!= (const R &ref) const
bool	operator!= (const null_type nil) const
DELEGATE *	operator-> ()
const DELEGATE *	operator-> () const
template<typename R >
bool	operator== (const R &ref) const
bool	operator== (const null_type) const
MemberType	remove_annotation (const Annotation &annotation)
const dds::core::xtypes::DynamicType &	type () const

Detailed Description

This class represents a dynamic type member.

Definition at line 64 of file MemberType.hpp.

Constructor & Destructor Documentation

MemberType() [1/4]

dds::core::xtypes::MemberType::MemberType	(	const std::string &	name,
		const dds::core::xtypes::DynamicType &	type
	)

MemberType() [2/4]

dds::core::xtypes::MemberType::MemberType	(	const std::string &	name,
		const dds::core::xtypes::DynamicType &	type,
		const Annotation &	annotation
	)

MemberType() [3/4]

template<typename AnnotationIter >

dds::core::xtypes::MemberType::MemberType	(	const std::string &	name,
		const dds::core::xtypes::DynamicType &	type,
		const AnnotationIter &	begin,
		const AnnotationIter &	end
	)

MemberType() [4/4]

dds::core::xtypes::MemberType::MemberType	(	const std::string &	name,
		const dds::core::xtypes::DynamicType &	type,
		const std::vector< Annotation > &	annotations
	)

Member Function Documentation

add_annotation()

MemberType dds::core::xtypes::MemberType::add_annotation

(

const Annotation &

annotation

)

is_nil()

template<typename DELEGATE >

bool dds::core::Reference< DELEGATE >::is_nil ( ) const

inherited

Check if the referenced object is nil.

In other words, check if the reference is pointing to a null object.

Returns

true if the referenced object is null.

Definition at line 143 of file ReferenceImpl.hpp.

name()

const std::string& dds::core::xtypes::MemberType::name

(

)

const

operator!=() [1/2]

template<typename DELEGATE >

template<typename R >

bool dds::core::Reference< DELEGATE >::operator!= ( const R &  ref ) const

inherited

Compares two Reference objects and returns true if they are not equal.

Inequality is based on the referential inequality of the object being pointed to.

Parameters

ref	the other Reference object

Returns

true when not equal

Definition at line 100 of file ReferenceImpl.hpp.

operator!=() [2/2]

template<typename DELEGATE >

bool dds::core::Reference< DELEGATE >::operator!= ( const null_type  nil ) const

inherited

Special operator!= used to check if this reference object does not equal the dds::core::null reference.

The non-null-check can be done like this:

if (r != dds::core::null) {
   // Use the dds reference object r
}

Returns

true if this reference is not null.

Definition at line 157 of file ReferenceImpl.hpp.

operator->() [1/2]

template<typename DELEGATE >

DELEGATE * dds::core::Reference< DELEGATE >::operator-> ( )

inherited

The operator->() is provided to be able to directly invoke functions on the delegate.

The decision to provide direct access to the delegate was motivated by the need for providing a way that was not invasive with respect to the CXXDDS API and yet would allow for vendor-specific extension. Thus vendor-specific extensions can be invoked on the Reference and on all its subclasses as follows:

my_dds_entity.standard_function();
my_dds_entity->vendor_specific_extension();

Returns

a reference to delegate.

Definition at line 180 of file ReferenceImpl.hpp.

operator->() [2/2]

template<typename DELEGATE >

const DELEGATE * dds::core::Reference< DELEGATE >::operator-> ( ) const

inherited

The operator->() is provided to be able to directly invoke functions on the delegate.

The decision to provide direct access to the delegate was motivated by the need for providing a way that was not invasive with respect to the CXXDDS API and yet would allow for vendor-specific extension. Thus vendor-specific extensions can be invoked on the Reference and on all its subclasses as follows:

my_dds_entity.standard_function();
my_dds_entity->vendor_specific_extension();

Returns

a reference to delegate.

Definition at line 188 of file ReferenceImpl.hpp.

operator==() [1/2]

template<typename DELEGATE >

template<typename R >

bool dds::core::Reference< DELEGATE >::operator== ( const R &  ref ) const

inherited

Compares two Reference objects and returns true if they are equal.

Equality is based on the referential equality of the object being pointed.

Parameters

ref	the other Reference object

Returns

true when equal

Definition at line 83 of file ReferenceImpl.hpp.

operator==() [2/2]

template<typename DELEGATE >

bool dds::core::Reference< DELEGATE >::operator== ( const null_type  ) const

inherited

Special operator== used to check if this reference object equals the dds::core::null reference.

The null-check can be done like this:

if (r == dds::core::null) {
   // Do not use the dds reference object r in its current state
}

Returns

true if this reference is null.

Definition at line 150 of file ReferenceImpl.hpp.

remove_annotation()

MemberType dds::core::xtypes::MemberType::remove_annotation

(

const Annotation &

annotation

)

type()

const dds::core::xtypes::DynamicType& dds::core::xtypes::MemberType::type

(

)

const

---

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

• include/dcps/C++/isocpp2/dds/core/xtypes/MemberType.hpp