CoreDX DDS Modern C++ API
Public Member Functions | List of all members
dds::core::xtypes::StringType Class Reference

StringType holds a series of characters. More...

Inheritance diagram for dds::core::xtypes::StringType:
Inheritance graph
[legend]
Collaboration diagram for dds::core::xtypes::StringType:
Collaboration graph
[legend]

Public Member Functions

 StringType (uint32_t bounds=0)
 Construct a StringType with the indicated bound (maximum string length). More...
 
virtual void accept (DynamicTypeVisitor &v) const
 Accept a DynamicTypeVisitor. More...
 
- Public Member Functions inherited from dds::core::xtypes::CollectionType
const DynamicTypeelement_type () const
 Accesses the type of the element held in this collection.
 
const std::vector< uint32_t > & bounds () const
 Accesses the bound (limit) on the maximum number of elements that can be held in the CollectionType.
 
- Public Member Functions inherited from dds::core::xtypes::DynamicType
 DynamicType (const std::string &name, TypeKind kind)
 Constructor. More...
 
 DynamicType (const std::string &name, TypeKind kind, const Annotation &annotation)
 Constructor. More...
 
 DynamicType (const std::string &name, TypeKind kind, const std::vector< Annotation > &annotations)
 Constructor. More...
 
template<typename FWI >
 DynamicType (const std::string &name, TypeKind kind, const FWI &annotation_begin, const FWI &annotation_end)
 Constructor. More...
 
TypeKind kind () const
 Get the type kind.
 
const std::string & name () const
 Get the type name.
 
const std::vector< Annotation > & annotations () const
 Access the applied annotations.
 
bool operator== (const DynamicType< DELEGATE > &that) const
 Test for equality with another DynamicType.
 
- Public Member Functions inherited from dds::core::Reference< DELEGATE >
 Reference (dds::core::null_type &)
 Creates a "null" reference.
 
 Reference (const Reference &ref)
 Creates a reference from another. More...
 
template<typename D >
 Reference (const Reference< D > &ref)
 Enables safe assignment from other reference types. More...
 
 Reference (DELEGATE_T *p)
 The following two constructors create a dds Reference from a vendor specific delegate. More...
 
 ~Reference ()
 Destroys a reference.
 
template<typename R >
bool operator== (const R &ref) const
 Compares two reference objects and returns true if they are equal. More...
 
template<typename R >
bool operator!= (const R &ref) const
 Compares two reference objects and returns true if they are not-equal. More...
 
Referenceoperator= (const null_type)
 Special assignment operators that takes care of assigning null to this reference. More...
 
bool is_nil () const
 Returns true if this reference object is nil, meaning pointing to null.
 
bool operator== (const null_type) const
 Special operator== used to check if this reference object equals the null reference. More...
 
bool operator!= (const null_type nil) const
 Special operator!= used to check if this reference object does not equals the null reference. More...
 
const DELEGATE_REF_T & delegate () const
 Returns a reference to the underlying delegate. More...
 
DELEGATE_REF_T & delegate ()
 Returns a reference to the underlying delegate. More...
 
DELEGATE * operator-> ()
 The operator->() is provided to be able to directly invoke methods on the delegate. More...
 
const DELEGATE * operator-> () const
 The operator->() is provided to be able to directly invoke methods on the delegate. More...
 

Additional Inherited Members

- Public Attributes inherited from dds::core::xtypes::CollectionType
const uint32_t UNBOUNDED = 0
 The UNBOUNDED constant can be used to indicate that the collection has a no limit on the number of elements.
 
- Protected Member Functions inherited from dds::core::xtypes::CollectionType
 CollectionType (const std::string &name, TypeKind kind)
 Constructs a CollectionType with the provided name and kind.
 

Detailed Description

StringType holds a series of characters.

The string length can be bounded, or unbounded.

Constructor & Destructor Documentation

◆ StringType()

dds::core::xtypes::StringType::StringType ( uint32_t  bounds = 0)

Construct a StringType with the indicated bound (maximum string length).

Member Function Documentation

◆ accept()

virtual void dds::core::xtypes::StringType::accept ( DynamicTypeVisitor v) const
virtual

Accept a DynamicTypeVisitor.

Useful for traversing the type hierarchy.

Reimplemented from dds::core::xtypes::DynamicType.


© 2009-2020 Twin Oaks Computing, Inc
Castle Rock, CO 80104
All rights reserved.