ADTF  3.18.2
recording_file_intf.h
Go to the documentation of this file.
1 
8 #pragma once
9 
10 #include <adtfucom3/adtf_ucom3.h>
12 #include <adtfbase/string_intf.h>
13 
14 namespace adtf
15 {
16 namespace services
17 {
18 namespace ant
19 {
20 
25 {
26  public:
28  ADTF_IID(IRecordingFile, "recording_file.ant.system.adtf.iid");
29 
30  public:
31 
37  virtual tResult SetDescription(const char* strDescription) = 0;
38 
44  virtual tResult SetTargetFileName(const char* strFileName) = 0;
45 
55  virtual tResult AddExtension(const char* strName,
56  const adtf::base::ant::IRawMemory& oData,
57  uint32_t ui32UserId = 0,
58  uint32_t ui32TypeId = 0,
59  uint32_t ui32VersionId = 0) = 0;
60 
71  virtual tResult GetExtensionStream(const char* strName,
72  uint32_t ui32UserId,
73  uint32_t ui32TypeId,
74  uint32_t ui32VersionId,
76 };
77 
78 }
79 namespace bat
80 {
81 
86 {
87  public:
89  ADTF_IID(IRecordingFile, "recording_file.bat.system.adtf.iid");
90 
91  public:
92 
99  virtual tResult GetTimeRange(tTimeStamp& tmFirstItem, tTimeStamp& tmLastItem) = 0;
100 };
101 
102 }
103 
104 namespace quiet
105 {
106 
111 {
112  public:
114  ADTF_IID(IRecordingFile, "recording_file.quiet.system.adtf.iid");
115 
116  public:
117 
123  virtual tResult GetTargetFilename(adtf::base::ant::IString&& strTargetFilename) const = 0;
124 
130  virtual tResult GetDescription(adtf::base::ant::IString&& strDescription) const = 0;
131 
135  virtual void Discard() = 0;
136 };
137 
138 
139 }
140 
142 
143 }
144 }
Copyright © Audi Electronics Venture GmbH.
The IRawMemory interface provides methods for getting and setting memory values through abstract inte...
The IString interface provides methods for getting and setting strings through abstract interfaces.
Definition: string_intf.h:28
Interface for manipulating recording files.
virtual tResult SetDescription(const char *strDescription)=0
Set the description in the file header.
virtual tResult AddExtension(const char *strName, const adtf::base::ant::IRawMemory &oData, uint32_t ui32UserId=0, uint32_t ui32TypeId=0, uint32_t ui32VersionId=0)=0
Add a new extension.
virtual tResult GetExtensionStream(const char *strName, uint32_t ui32UserId, uint32_t ui32TypeId, uint32_t ui32VersionId, adtf::ucom::ant::iobject_ptr< adtf::ucom::ant::IOutputStream > &pStream)=0
Get a handle to a stream interface to directly write extensiond data to the file without an intermedi...
ADTF_IID(IRecordingFile, "recording_file.ant.system.adtf.iid")
definiton of interface id
virtual tResult SetTargetFileName(const char *strFileName)=0
Set the filename that the file should be moved to after it has been closed.
Interface for manipulating recording files.
virtual tResult GetTimeRange(tTimeStamp &tmFirstItem, tTimeStamp &tmLastItem)=0
Returns the time range of the recording.
ADTF_IID(IRecordingFile, "recording_file.bat.system.adtf.iid")
definiton of interface id
Interface for manipulating recording files.
virtual void Discard()=0
Delete this file after it has been closed.
virtual tResult GetTargetFilename(adtf::base::ant::IString &&strTargetFilename) const =0
Retrieve the current target filename.
ADTF_IID(IRecordingFile, "recording_file.quiet.system.adtf.iid")
definiton of interface id
virtual tResult GetDescription(adtf::base::ant::IString &&strDescription) const =0
Retrieve the current description.
Base class for every interface type within the uCOM.
Definition: object_intf.h:31
Base object pointer to realize binary compatible reference counting in interface methods.
Namespace for entire ADTF SDK.
Copyright © Audi Electronics Venture GmbH.
Copyright © Audi Electronics Venture GmbH.