CNTV2BitfileManager Class Reference

I manage and cache any number of bitfiles for any number of NTV2 devices/designs. More...

#include <ntv2bitfilemanager.h>

Public Member Functions
	CNTV2BitfileManager ()
	My constructor. More...
virtual	~CNTV2BitfileManager ()
	My destructor. More...
virtual bool	AddFile (const std::string &inBitfilePath)
	Add the bitfile at the given path to the list of bitfiles. More...
virtual bool	AddDirectory (const std::string &inDirectory)
	Add the bitfile(s) at the given path to the list of bitfiles. More...
virtual void	Clear (void)
	Clear the list of bitfiles. More...
virtual size_t	GetNumBitfiles (void)
	Returns the number of bitfiles. More...
virtual const NTV2BitfileInfoList &	GetBitfileInfoList (void) const
	Returns an NTV2BitfileInfoList standard C++ vector. More...
virtual bool	GetBitStream (NTV2Buffer &outBitstream, const ULWord inDesignID, const ULWord inDesignVersion, const ULWord inBitfileID, const ULWord inBitfileVersion, const ULWord inBitfileFlags)
	Retrieves the bitstream specified by design ID & version, and bitfile ID & version. It loads it into host memory, and updates/reallocates the given NTV2Buffer to access it. More...

Detailed Description

I manage and cache any number of bitfiles for any number of NTV2 devices/designs.

Note

This class is not thread-safe.

Definition at line 52 of file ntv2bitfilemanager.h.

Constructor & Destructor Documentation

CNTV2BitfileManager()

CNTV2BitfileManager::CNTV2BitfileManager

(

)

My constructor.

Definition at line 29 of file ntv2bitfilemanager.cpp.

~CNTV2BitfileManager()

CNTV2BitfileManager::~CNTV2BitfileManager ( )

virtual

My destructor.

Definition at line 33 of file ntv2bitfilemanager.cpp.

Member Function Documentation

AddDirectory()

bool CNTV2BitfileManager::AddDirectory ( const std::string &  inDirectory )

virtual

Add the bitfile(s) at the given path to the list of bitfiles.

Parameters

[in]

inDirectory

Specifies the path name to the directory.

Returns

True if successful; otherwise false.

Definition at line 87 of file ntv2bitfilemanager.cpp.

AddFile()

bool CNTV2BitfileManager::AddFile ( const std::string &  inBitfilePath )

virtual

Add the bitfile at the given path to the list of bitfiles.

Parameters

[in]

inBitfilePath

Specifies the path name to the bitfile.

Returns

True if successful; otherwise false.

Definition at line 38 of file ntv2bitfilemanager.cpp.

Clear()

void CNTV2BitfileManager::Clear ( void  )

virtual

Clear the list of bitfiles.

Definition at line 109 of file ntv2bitfilemanager.cpp.

GetBitfileInfoList()

virtual const NTV2BitfileInfoList& CNTV2BitfileManager::GetBitfileInfoList ( void  ) const

inlinevirtual

Returns an NTV2BitfileInfoList standard C++ vector.

Returns

A reference to my NTV2BitfileInfoList.

Definition at line 94 of file ntv2bitfilemanager.h.

GetBitStream()

bool CNTV2BitfileManager::GetBitStream ( NTV2Buffer &  outBitstream, const ULWord  inDesignID, const ULWord  inDesignVersion, const ULWord  inBitfileID, const ULWord  inBitfileVersion, const ULWord  inBitfileFlags  )

virtual

Retrieves the bitstream specified by design ID & version, and bitfile ID & version. It loads it into host memory, and updates/reallocates the given NTV2Buffer to access it.

Parameters

[out]	outBitstream	Receives the bitstream in this NTV2Buffer.
[in]	inDesignID	Specifies the design ID.
[in]	inDesignVersion	Specifies the design version.
[in]	inBitfileID	Specifies the bitfile ID.
[in]	inBitfileVersion	Specifies the bitfile version (0xff for latest).
[in]	inBitfileFlags	Specifies the bitfile flags.

Returns

True if the bitfile is present and loads successfully; otherwise false.

Definition at line 123 of file ntv2bitfilemanager.cpp.

GetNumBitfiles()

size_t CNTV2BitfileManager::GetNumBitfiles ( void  )

virtual

Returns the number of bitfiles.

Returns

Number of bitfiles.

Definition at line 117 of file ntv2bitfilemanager.cpp.

---

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

• /home/tcbuilder/buildAgent/work/df8e8cce5bebfd58/libajantv2/ajantv2/includes/ntv2bitfilemanager.h
• /home/tcbuilder/buildAgent/work/df8e8cce5bebfd58/libajantv2/ajantv2/src/ntv2bitfilemanager.cpp