AJA NTV2 SDK  17.6.0.1688
NTV2 SDK 17.6.0.1688
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
CNTV2MCSfile Class Reference

Instances of me can parse an MCS file. More...

#include <ntv2mcsfile.h>

Public Member Functions

 CNTV2MCSfile ()
 My constructor. More...
 
virtual ~CNTV2MCSfile ()
 My destructor. More...
 
virtual bool Open (const std::string &inMCSFilePath)
 Opens the bitfile at the given path, then parses its header. More...
 
virtual void Close (void)
 Closes mcs file (if open). More...
 
virtual bool InsertBitFile (const std::string &inBitFileName, const std::string &inMCSFileName, const std::string &inUserMessage)
 
virtual void IRecordOutput (const char *pIRecord)
 
virtual uint32_t GetFileByteStream (uint32_t numberOfLines=0)
 
virtual bool isReady (void) const
 
virtual bool FindExtendedLinearAddressRecord (uint16_t address=0x0000)
 
virtual bool GetCurrentParsedRecord (IntelRecordInfo &recordInfo)
 
virtual uint32_t GetPartition (UByteSequence &patitionBuffer, uint16_t baseELARaddress, uint16_t &partitionOffset, bool nextPartition=false)
 
virtual const std::string & GetBitfileDateString (void) const
 
virtual const std::string & GetBitfileDesignString (void) const
 
virtual const std::string & GetBitfilePartNameString (void) const
 
virtual const std::string & GetBitfileTimeString (void) const
 
virtual std::string GetMCSPackageVersionString (void) const
 
virtual std::string GetMCSPackageDateString (void) const
 
virtual bool GetMCSHeaderInfo (const std::string &inMCSFileName)
 

Protected Member Functions

virtual void SetLastError (const std::string &inStr, const bool inAppend=false)
 

Detailed Description

Instances of me can parse an MCS file.

Definition at line 51 of file ntv2mcsfile.h.

Constructor & Destructor Documentation

◆ CNTV2MCSfile()

CNTV2MCSfile::CNTV2MCSfile ( )

My constructor.

Definition at line 29 of file ntv2mcsfile.cpp.

◆ ~CNTV2MCSfile()

CNTV2MCSfile::~CNTV2MCSfile ( )
virtual

My destructor.

Definition at line 34 of file ntv2mcsfile.cpp.

Member Function Documentation

◆ Close()

void CNTV2MCSfile::Close ( void  )
virtual

Closes mcs file (if open).

Definition at line 40 of file ntv2mcsfile.cpp.

◆ FindExtendedLinearAddressRecord()

bool CNTV2MCSfile::FindExtendedLinearAddressRecord ( uint16_t  address = 0x0000)
virtual

Definition at line 384 of file ntv2mcsfile.cpp.

◆ GetBitfileDateString()

virtual const std::string& CNTV2MCSfile::GetBitfileDateString ( void  ) const
inlinevirtual

Definition at line 83 of file ntv2mcsfile.h.

◆ GetBitfileDesignString()

virtual const std::string& CNTV2MCSfile::GetBitfileDesignString ( void  ) const
inlinevirtual

Definition at line 84 of file ntv2mcsfile.h.

◆ GetBitfilePartNameString()

virtual const std::string& CNTV2MCSfile::GetBitfilePartNameString ( void  ) const
inlinevirtual

Definition at line 85 of file ntv2mcsfile.h.

◆ GetBitfileTimeString()

virtual const std::string& CNTV2MCSfile::GetBitfileTimeString ( void  ) const
inlinevirtual

Definition at line 86 of file ntv2mcsfile.h.

◆ GetCurrentParsedRecord()

bool CNTV2MCSfile::GetCurrentParsedRecord ( IntelRecordInfo recordInfo)
virtual

Definition at line 412 of file ntv2mcsfile.cpp.

◆ GetFileByteStream()

uint32_t CNTV2MCSfile::GetFileByteStream ( uint32_t  numberOfLines = 0)
virtual

Definition at line 353 of file ntv2mcsfile.cpp.

◆ GetMCSHeaderInfo()

bool CNTV2MCSfile::GetMCSHeaderInfo ( const std::string &  inMCSFileName)
virtual

Definition at line 103 of file ntv2mcsfile.cpp.

◆ GetMCSPackageDateString()

string CNTV2MCSfile::GetMCSPackageDateString ( void  ) const
virtual

Definition at line 146 of file ntv2mcsfile.cpp.

◆ GetMCSPackageVersionString()

string CNTV2MCSfile::GetMCSPackageVersionString ( void  ) const
virtual

Definition at line 135 of file ntv2mcsfile.cpp.

◆ GetPartition()

uint32_t CNTV2MCSfile::GetPartition ( UByteSequence patitionBuffer,
uint16_t  baseELARaddress,
uint16_t &  partitionOffset,
bool  nextPartition = false 
)
virtual

Definition at line 463 of file ntv2mcsfile.cpp.

◆ InsertBitFile()

bool CNTV2MCSfile::InsertBitFile ( const std::string &  inBitFileName,
const std::string &  inMCSFileName,
const std::string &  inUserMessage 
)
virtual

Definition at line 155 of file ntv2mcsfile.cpp.

◆ IRecordOutput()

void CNTV2MCSfile::IRecordOutput ( const char *  pIRecord)
virtual

Definition at line 341 of file ntv2mcsfile.cpp.

◆ isReady()

bool CNTV2MCSfile::isReady ( void  ) const
virtual

Definition at line 51 of file ntv2mcsfile.cpp.

◆ Open()

bool CNTV2MCSfile::Open ( const std::string &  inMCSFilePath)
virtual

Opens the bitfile at the given path, then parses its header.

Parameters
[in]inMCSFilePathSpecifies the path to the MCS bitfile to be parsed.
Returns
True if open & parse succeeds; otherwise false.

Definition at line 73 of file ntv2mcsfile.cpp.

◆ SetLastError()

void CNTV2MCSfile::SetLastError ( const std::string &  inStr,
const bool  inAppend = false 
)
protectedvirtual

Definition at line 60 of file ntv2mcsfile.cpp.


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