Cyclone ISO C++ API Reference Guide
SampleInfo.hpp
Go to the documentation of this file.
1 /* Copyright 2010, Object Management Group, Inc.
2 * Copyright 2010, PrismTech, Corp.
3 * Copyright 2010, Real-Time Innovations, Inc.
4 * All rights reserved.
5 *
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
17 */
18 #ifndef OMG_DDS_SUB_TSAMPLE_INFO_HPP_
19 #define OMG_DDS_SUB_TSAMPLE_INFO_HPP_
20 
21 #include <dds/core/Time.hpp>
22 #include <dds/core/Value.hpp>
25 #include <dds/sub/Rank.hpp>
27 
28 namespace dds
29 {
30 namespace sub
31 {
32 
33 class SampleInfo;
34 }
35 }
36 
62 {
63 
64 public:
71  SampleInfo();
74 public:
82  const dds::core::Time timestamp() const;
83 
94  const dds::sub::status::DataState state() const;
95 
107 
118  dds::sub::Rank rank() const;
119 
129  bool valid() const;
130 
137 
144 };
145 
146 #endif /* OMG_DDS_SUB_TSAMPLE_INFO_HPP_ */
dds::sub::status::DataState
Class to hold sample DataState information.
Definition: DataState.hpp:371
dds::sub::SampleInfo::timestamp
const dds::core::Time timestamp() const
DataState.hpp
dds::core::InstanceHandle
Class to hold the handle associated with in sample instance.
Definition: InstanceHandle.hpp:40
dds::sub::SampleInfo::valid
bool valid() const
dds::sub::Rank
Class to hold sample Rank information and is part of dds::sub::SampleInfo.
Definition: Rank.hpp:67
dds::sub::GenerationCount
Class to hold sample GenerationCount information and is part of dds::sub::SampleInfo.
Definition: GenerationCount.hpp:63
dds
Definition: array.hpp:30
dds::sub::SampleInfo
The SampleInfo contains information pertaining to the associated Data value.
Definition: SampleInfo.hpp:61
dds::sub::SampleInfo::rank
dds::sub::Rank rank() const
dds::sub::SampleInfo::publication_handle
dds::core::InstanceHandle publication_handle() const
Rank.hpp
GenerationCount.hpp
dds::sub::SampleInfo::state
const dds::sub::status::DataState state() const
InstanceHandle.hpp
Value.hpp
dds::core::Value
This class is the base for various value-type dds objects.
Definition: Value.hpp:28
dds::sub::SampleInfo::generation_count
dds::sub::GenerationCount generation_count() const
dds::sub::SampleInfo::instance_handle
dds::core::InstanceHandle instance_handle() const
dds::core::Time
Definition: Time.hpp:42
Time.hpp