Instances of me can parse a bitfile.
More...
#include <ntv2bitfile.h>
Instances of me can parse a bitfile.
Definition at line 86 of file ntv2bitfile.h.
◆ CNTV2Bitfile()
CNTV2Bitfile::CNTV2Bitfile |
( |
| ) |
|
◆ ~CNTV2Bitfile()
CNTV2Bitfile::~CNTV2Bitfile |
( |
| ) |
|
|
virtual |
◆ CanFlashDevice()
bool CNTV2Bitfile::CanFlashDevice |
( |
const NTV2DeviceID |
inDeviceID | ) |
const |
|
virtual |
- Returns
- True if the bitfile can be flashed onto the device; otherwise false.
Definition at line 544 of file ntv2bitfile.cpp.
◆ Close()
void CNTV2Bitfile::Close |
( |
void |
| ) |
|
|
virtual |
◆ ConvertToBitfileID()
◆ ConvertToDesignID()
◆ ConvertToDeviceID()
◆ GetBitfileID()
virtual ULWord CNTV2Bitfile::GetBitfileID |
( |
void |
| ) |
const |
|
inlinevirtual |
- Returns
- A ULWord containing the design ID as extracted from the bitfile.
Definition at line 184 of file ntv2bitfile.h.
◆ GetBitfileVersion()
virtual ULWord CNTV2Bitfile::GetBitfileVersion |
( |
void |
| ) |
const |
|
inlinevirtual |
- Returns
- A ULWord containing the design version as extracted from the bitfile.
Definition at line 189 of file ntv2bitfile.h.
◆ GetDate()
virtual const std::string& CNTV2Bitfile::GetDate |
( |
void |
| ) |
const |
|
inlinevirtual |
- Returns
- A string containing the extracted bitfile build date.
Definition at line 129 of file ntv2bitfile.h.
◆ GetDesignID()
virtual ULWord CNTV2Bitfile::GetDesignID |
( |
void |
| ) |
const |
|
inlinevirtual |
- Returns
- A ULWord containing the design design ID as extracted from the bitfile.
Definition at line 174 of file ntv2bitfile.h.
◆ GetDesignName()
virtual std::string CNTV2Bitfile::GetDesignName |
( |
void |
| ) |
const |
|
inlinevirtual |
- Returns
- A string containing the extracted bitfile design name.
Definition at line 139 of file ntv2bitfile.h.
◆ GetDesignVersion()
virtual ULWord CNTV2Bitfile::GetDesignVersion |
( |
void |
| ) |
const |
|
inlinevirtual |
- Returns
- A ULWord containing the design version as extracted from the bitfile.
Definition at line 179 of file ntv2bitfile.h.
◆ GetDeviceID()
◆ GetDeviceIDFromHardwareDesignName()
NTV2DeviceID CNTV2Bitfile::GetDeviceIDFromHardwareDesignName |
( |
const std::string & |
inDesignName | ) |
|
|
static |
◆ GetFileByteStream()
size_t CNTV2Bitfile::GetFileByteStream |
( |
NTV2Buffer & |
outBuffer | ) |
|
|
virtual |
Retrieves the file bitstream.
- Parameters
-
[out] | outBuffer | Specifies the buffer that will receive the data. This method will Allocate storage if IsNULL or IsAllocatedBySDK. |
- Returns
- Number of bytes copied to the outBuffer, or zero upon failure.
Definition at line 421 of file ntv2bitfile.cpp.
◆ GetFileStreamLength()
virtual size_t CNTV2Bitfile::GetFileStreamLength |
( |
void |
| ) |
const |
|
inlinevirtual |
- Returns
- File stream length in bytes, or zero if error/invalid.
Definition at line 215 of file ntv2bitfile.h.
◆ GetLastError()
virtual const std::string& CNTV2Bitfile::GetLastError |
( |
void |
| ) |
const |
|
inlinevirtual |
- Returns
- A string containing the error message, if any, from the last function that could fail.
Definition at line 149 of file ntv2bitfile.h.
◆ GetPartName()
virtual const std::string& CNTV2Bitfile::GetPartName |
( |
void |
| ) |
const |
|
inlinevirtual |
- Returns
- A string containing the extracted bitfile part name.
Definition at line 144 of file ntv2bitfile.h.
◆ GetPrimaryHardwareDesignName()
string CNTV2Bitfile::GetPrimaryHardwareDesignName |
( |
const NTV2DeviceID |
inDeviceID | ) |
|
|
static |
◆ GetProgramByteStream()
size_t CNTV2Bitfile::GetProgramByteStream |
( |
NTV2Buffer & |
outBuffer | ) |
|
|
virtual |
Retrieves the program bitstream.
- Parameters
-
[out] | outBuffer | Specifies the buffer that will receive the data. This method will Allocate storage if IsNULL or IsAllocatedBySDK. |
- Returns
- Number of bytes copied to the outBuffer, or zero upon failure.
Definition at line 377 of file ntv2bitfile.cpp.
◆ GetProgramStreamLength()
virtual size_t CNTV2Bitfile::GetProgramStreamLength |
( |
void |
| ) |
const |
|
inlinevirtual |
- Returns
- Program stream length in bytes, or zero if error/invalid.
Definition at line 210 of file ntv2bitfile.h.
◆ GetTime()
virtual const std::string& CNTV2Bitfile::GetTime |
( |
void |
| ) |
const |
|
inlinevirtual |
- Returns
- A string containing the extracted bitfile build time.
Definition at line 134 of file ntv2bitfile.h.
◆ GetUserID()
virtual ULWord CNTV2Bitfile::GetUserID |
( |
void |
| ) |
const |
|
inlinevirtual |
Answers with the design user ID, as extracted from the bitfile.
- Returns
- A ULWord containing the design user ID.
Definition at line 195 of file ntv2bitfile.h.
◆ IsClear()
virtual bool CNTV2Bitfile::IsClear |
( |
void |
| ) |
const |
|
inlinevirtual |
- Returns
- True if the bitfile header includes clear flag; otherwise false.
Definition at line 164 of file ntv2bitfile.h.
◆ IsCompress()
virtual bool CNTV2Bitfile::IsCompress |
( |
void |
| ) |
const |
|
inlinevirtual |
- Returns
- True if the bitfile header includes compress flag; otherwise false.
Definition at line 169 of file ntv2bitfile.h.
◆ IsPartial()
virtual bool CNTV2Bitfile::IsPartial |
( |
void |
| ) |
const |
|
inlinevirtual |
- Returns
- True if the bitfile header includes partial flag; otherwise false.
Definition at line 159 of file ntv2bitfile.h.
◆ IsTandem()
virtual bool CNTV2Bitfile::IsTandem |
( |
void |
| ) |
const |
|
inlinevirtual |
- Returns
- True if the bitfile header includes tandem flag; otherwise false.
Definition at line 154 of file ntv2bitfile.h.
◆ Open()
bool CNTV2Bitfile::Open |
( |
const std::string & |
inBitfilePath | ) |
|
|
virtual |
Opens the bitfile at the given path, then parses its header.
- Parameters
-
[in] | inBitfilePath | Specifies the path name of the bitfile to be parsed. |
- Returns
- True if open & parse succeeds; otherwise false.
Definition at line 322 of file ntv2bitfile.cpp.
◆ ParseHeaderFromBuffer() [1/2]
string CNTV2Bitfile::ParseHeaderFromBuffer |
( |
const NTV2Buffer & |
inBitfileBuffer | ) |
|
|
virtual |
Parse a bitfile header that's stored in a buffer.
- Parameters
-
[in] | inBitfileBuffer | Specifies the buffer of the bitfile to be parsed. |
- Returns
- A std::string containing parsing errors. It will be empty if successful.
Definition at line 367 of file ntv2bitfile.cpp.
◆ ParseHeaderFromBuffer() [2/2]
string CNTV2Bitfile::ParseHeaderFromBuffer |
( |
const uint8_t * |
inBitfileBuffer, |
|
|
const size_t |
inBufferSize |
|
) |
| |
|
virtual |
Parse a bitfile header that's stored in a buffer.
- Parameters
-
[in] | inBitfileBuffer | Specifies the buffer of the bitfile to be parsed. |
[in] | inBufferSize | Specifies the size of the buffer to be parsed. |
- Returns
- A std::string containing parsing errors. It will be empty if successful.
Definition at line 361 of file ntv2bitfile.cpp.
◆ SetLastError()
void CNTV2Bitfile::SetLastError |
( |
const std::string & |
inStr, |
|
|
const bool |
inAppend = false |
|
) |
| |
|
protectedvirtual |
The documentation for this class was generated from the following files:
- /home/tcbuilder/buildAgent/work/df8e8cce5bebfd58/libajantv2/ajantv2/includes/ntv2bitfile.h
- /home/tcbuilder/buildAgent/work/df8e8cce5bebfd58/libajantv2/ajantv2/src/ntv2bitfile.cpp