Datafox DFCom - API  04.03.18
Dokumentation zur Datafox Kommunikationsbibliothek (DFComDLL.dll / DFCom_x64.dll)
DocumentStudio Klassenreferenz

#include <document_studio.h>

Datenstrukturen

struct  Result
 

Öffentliche Typen

enum class  ResultCodes {
  Success , FileContentCorrupted , OpenUnsupportedFileType , OpenUnsupportedFileVersion ,
  SetupOpeningFailed , FileReadingError , FileLoadingError , BackupCreationFailed ,
  TooMuchDataError , FileAES_openFailed , FileAES_readFailed , FileAES_checksumError ,
  FileAES_contentChecksumError , FileAES_versionTooNew , FileAES_recommendedVersionError , FileAES_DFComDllToOld ,
  FileAES_wrongFormat , FileAES_internalError , FileXML_internalError , FileXML_structureError
}
 

Öffentliche Methoden

 DocumentStudio (const std::string &studioVersion, const std::string &libraryVersion)
 
 ~DocumentStudio ()
 
bool isAccessControl ()
 
bool isAccessControlExtension ()
 
const std::string & filePath ()
 
void setFilePath (const std::string &fileName)
 
FileAES & fileAES ()
 
FileXML & fileXML ()
 
FileType currentFileType ()
 
void setFileType (FileType type)
 
tinyxml2::XMLElement * xmlParentNode ()
 
tinyxml2::XMLElement * setXmlParentNode (tinyxml2::XMLElement *newParent)
 
void setVersions (const std::string &studioVersion, const std::string &libraryVersion)
 
void setVersions (uint32_t studioVersion, uint32_t libraryVersion)
 
std::string studioVersion ()
 Studioversion mit der die Datei zuletzt abgespeichert wurde. Mehr ...
 
std::string minStudioVersion ()
 Mindestversion des einzusetzenden Studios, um alle enthaltenen Daten zu unterstuetzen. Mehr ...
 
std::string shouldStudioVersion ()
 Sollteversion des einzusetzenden Studios, um alle enthaltenen Daten zu unterstuetzen. Mehr ...
 
std::string minLibraryVersion ()
 Mindestversion der zu verwendenden DFComDLL fuer die korrekte Uebertragung der Setupdaten. Mehr ...
 
std::string shouldLibraryVersion ()
 Sollteversion der zu verwendenden DFComDLL fuer die korrekte Uebertragung der Setupdaten. Mehr ...
 
std::string minFirmware1Version ()
 Mindestversion der zu verwendenden Firmware 04.01.xx.xx, um alle gewaehlten Einstellungen zu unterstuetzen. Mehr ...
 
std::string shouldFirmware1Version ()
 Sollteversion der zu verwendenden Firmware 04.01.xx.xx, um alle gewaehlten Einstellungen zu unterstuetzen. Mehr ...
 
bool supportFirmware1Version ()
 Wird die Version 04.01.xx der Firmware unterstützt. Mehr ...
 
std::string minFirmware2Version ()
 Mindestversion der zu verwendenden Firmware 04.02.xx.xx, um alle gewaehlten Einstellungen zu unterstuetzen. Mehr ...
 
std::string shouldFirmware2Version ()
 Sollteversion der zu verwendenden Firmware 04.02.xx.xx, um alle gewaehlten Einstellungen zu unterstuetzen. Mehr ...
 
bool supportFirmware2Version ()
 Wird die Version 04.02.xx der Firmware unterstützt. Mehr ...
 
std::string minFirmware3Version ()
 Mindestversion der zu verwendenden Firmware 04.03.xx.xx, um alle gewaehlten Einstellungen zu unterstuetzen. Mehr ...
 
std::string shouldFirmware3Version ()
 Sollteversion der zu verwendenden Firmware 04.03.xx.xx, um alle gewaehlten Einstellungen zu unterstuetzen. Mehr ...
 
bool supportFirmware3Version ()
 Wird die Version 04.03.xx der Firmware unterstützt. Mehr ...
 
void SetDocumentDefault (int32_t flags=0)
 
std::string fileNameList (int32_t num)
 
void setFileNameList (int32_t num, const std::string &fileName)
 
std::string fileNameListAccessControl (int32_t num)
 
void setFileNameListAccessControl (int32_t num, const std::string &fileName)
 
std::string fileNameExtended (int32_t num)
 
void setFileNameExtended (int32_t num, const std::string &fileName)
 
const std::string & errorText ()
 
void setErrorText (const std::string &errorText)
 
std::list< std::string > globalVariablesName ()
 
std::unordered_map< std::string, std::string > globalVariablesValueDefault ()
 
Result MkSetupImage (EntryDevice &root, uint32_t &setupSize)
 
Result BuildRootFromImage (SetupType setupType)
 
std::string setupTypeName (SetupType setupType)
 
Result documentNew (SetupType setupType)
 
Result documentOpen (const std::string &filePath, bool ignoreStudioVersion, std::function< bool(const std::string &filePath, const std::string &backupFilePath)> shouldCreateBackup=nullptr, std::function< bool(const std::string &filePath, const SoftwarebuildVersion &version, const std::string &component)> downgradeInfo=nullptr)
 
bool documentSave ()
 
bool documentSaveAs (FileType fileType, const std::string &filePath)
 
int32_t SaveCheck ()
 
EntryDevice & root ()
 
EntryTableRecord & rootTableRecord ()
 
EntryTableList & rootTableList ()
 
EntryHandling & rootHandling ()
 
EntrySignalProcessing & rootSignalProcessing ()
 
EntryEventChains & rootEventChains ()
 
EntryIOModule & rootIOModule ()
 
EntryAccessControl2 & rootAccessControl ()
 
EntryEnergieSchemes & rootEnergieSchemes ()
 
bool IsEmpty ()
 
uint32_t GetExtendedFlashSize ()
 
uint32_t GetMDEEKFlashSize ()
 
uint32_t GetEntranceEKFlashSize ()
 
uint32_t GetEntrance2EKFlashSize ()
 
uint32_t GetFlashSetupSize ()
 
uint32_t GetFlashSetupSize4_2 ()
 
int32_t IsFunctionAvailable ()
 
int32_t IsCounterAvailable ()
 
int32_t IsAnalogValueAvailable ()
 
int32_t IsAnalogStatusAvailable ()
 
int32_t IsTimerInputChainAvailable ()
 
int32_t IsSystemMessageAvailable ()
 
void GetListName (uint8_t ucNum, char *szBuf)
 
std::string listName (int32_t num)
 
void GetAccessControlListName (uint8_t ucNum, char *szBuf)
 
std::string listNameAccessControl (int32_t num)
 
int32_t globalVariableIndex (uint8_t ucDefNum)
 
uint8_t globalVariableCount ()
 
std::string globalVariableName (uint8_t num)
 
const char * setupPassword ()
 
uint8_t GetRecordTableCount ()
 
EntryTable * GetRecordTable (uint8_t num)
 
EntryTableField * GetRecordTableField (uint8_t numTable, uint8_t numField)
 
uint8_t GetListTableCount ()
 
EntryTable * GetListTable (uint8_t num)
 
EntryTableField * GetListTableField (uint8_t numTable, uint8_t numField)
 
uint8_t GetAccessControlTableCount ()
 
EntryTable * GetAccessControlTable (uint8_t num)
 
EntryTableField * GetAccessControlTableField (uint8_t numTable, uint8_t numField)
 
int32_t GetTableCount (uint8_t typeTable)
 
int32_t GetTable (uint8_t num, StructTable &table, uint8_t typeTable)
 
int32_t GetTableField (uint8_t numTable, uint8_t numField, StructTableField &field, uint8_t typeTable)
 

Datenfelder

uint32_t m_flashSetupSize
 
uint8_t m_flagsLoadSetup
 

Geschützte Attribute

char * m_setupPassword [17]
 

Dokumentation der Aufzählungstypen

◆ ResultCodes

enum ResultCodes
strong
Aufzählungswerte
Success 
FileContentCorrupted 
OpenUnsupportedFileType 
OpenUnsupportedFileVersion 
SetupOpeningFailed 
FileReadingError 
FileLoadingError 
BackupCreationFailed 
TooMuchDataError 
FileAES_openFailed 
FileAES_readFailed 
FileAES_checksumError 
FileAES_contentChecksumError 
FileAES_versionTooNew 
FileAES_recommendedVersionError 
FileAES_DFComDllToOld 
FileAES_wrongFormat 
FileAES_internalError 
FileXML_internalError 
FileXML_structureError 

Beschreibung der Konstruktoren und Destruktoren

◆ DocumentStudio()

DocumentStudio ( const std::string &  studioVersion,
const std::string &  libraryVersion 
)

◆ ~DocumentStudio()

Dokumentation der Elementfunktionen

◆ BuildRootFromImage()

Result BuildRootFromImage ( SetupType  setupType)

◆ currentFileType()

FileType currentFileType ( )
inline

◆ documentNew()

Result documentNew ( SetupType  setupType)

◆ documentOpen()

Result documentOpen ( const std::string &  filePath,
bool  ignoreStudioVersion,
std::function< bool(const std::string &filePath, const std::string &backupFilePath)>  shouldCreateBackup = nullptr,
std::function< bool(const std::string &filePath, const SoftwarebuildVersion &version, const std::string &component)>  downgradeInfo = nullptr 
)

◆ documentSave()

bool documentSave ( )

◆ documentSaveAs()

bool documentSaveAs ( FileType  fileType,
const std::string &  filePath 
)

◆ errorText()

const std::string& errorText ( )
inline

◆ fileAES()

FileAES& fileAES ( )
inline

◆ fileNameExtended()

std::string fileNameExtended ( int32_t  num)

◆ fileNameList()

std::string fileNameList ( int32_t  num)

◆ fileNameListAccessControl()

std::string fileNameListAccessControl ( int32_t  num)

◆ filePath()

const std::string& filePath ( )
inline

◆ fileXML()

FileXML& fileXML ( )
inline

◆ GetAccessControlListName()

void GetAccessControlListName ( uint8_t  ucNum,
char *  szBuf 
)

◆ GetAccessControlTable()

EntryTable* GetAccessControlTable ( uint8_t  num)

◆ GetAccessControlTableCount()

uint8_t GetAccessControlTableCount ( )

◆ GetAccessControlTableField()

EntryTableField* GetAccessControlTableField ( uint8_t  numTable,
uint8_t  numField 
)

◆ GetEntrance2EKFlashSize()

uint32_t GetEntrance2EKFlashSize ( )

◆ GetEntranceEKFlashSize()

uint32_t GetEntranceEKFlashSize ( )

◆ GetExtendedFlashSize()

uint32_t GetExtendedFlashSize ( )

◆ GetFlashSetupSize()

uint32_t GetFlashSetupSize ( )

◆ GetFlashSetupSize4_2()

uint32_t GetFlashSetupSize4_2 ( )

◆ GetListName()

void GetListName ( uint8_t  ucNum,
char *  szBuf 
)

◆ GetListTable()

EntryTable* GetListTable ( uint8_t  num)

◆ GetListTableCount()

uint8_t GetListTableCount ( )

◆ GetListTableField()

EntryTableField* GetListTableField ( uint8_t  numTable,
uint8_t  numField 
)

◆ GetMDEEKFlashSize()

uint32_t GetMDEEKFlashSize ( )

◆ GetRecordTable()

EntryTable* GetRecordTable ( uint8_t  num)

◆ GetRecordTableCount()

uint8_t GetRecordTableCount ( )

◆ GetRecordTableField()

EntryTableField* GetRecordTableField ( uint8_t  numTable,
uint8_t  numField 
)

◆ GetTable()

int32_t GetTable ( uint8_t  num,
StructTable table,
uint8_t  typeTable 
)

◆ GetTableCount()

int32_t GetTableCount ( uint8_t  typeTable)

◆ GetTableField()

int32_t GetTableField ( uint8_t  numTable,
uint8_t  numField,
StructTableField field,
uint8_t  typeTable 
)

◆ globalVariableCount()

uint8_t globalVariableCount ( )

◆ globalVariableIndex()

int32_t globalVariableIndex ( uint8_t  ucDefNum)

◆ globalVariableName()

std::string globalVariableName ( uint8_t  num)

◆ globalVariablesName()

std::list<std::string> globalVariablesName ( )

◆ globalVariablesValueDefault()

std::unordered_map<std::string, std::string> globalVariablesValueDefault ( )

◆ isAccessControl()

bool isAccessControl ( )

◆ isAccessControlExtension()

bool isAccessControlExtension ( )

◆ IsAnalogStatusAvailable()

int32_t IsAnalogStatusAvailable ( )

◆ IsAnalogValueAvailable()

int32_t IsAnalogValueAvailable ( )

◆ IsCounterAvailable()

int32_t IsCounterAvailable ( )

◆ IsEmpty()

bool IsEmpty ( )

◆ IsFunctionAvailable()

int32_t IsFunctionAvailable ( )

◆ IsSystemMessageAvailable()

int32_t IsSystemMessageAvailable ( )

◆ IsTimerInputChainAvailable()

int32_t IsTimerInputChainAvailable ( )

◆ listName()

std::string listName ( int32_t  num)

◆ listNameAccessControl()

std::string listNameAccessControl ( int32_t  num)

◆ minFirmware1Version()

std::string minFirmware1Version ( )

Mindestversion der zu verwendenden Firmware 04.01.xx.xx, um alle gewaehlten Einstellungen zu unterstuetzen.

◆ minFirmware2Version()

std::string minFirmware2Version ( )

Mindestversion der zu verwendenden Firmware 04.02.xx.xx, um alle gewaehlten Einstellungen zu unterstuetzen.

◆ minFirmware3Version()

std::string minFirmware3Version ( )

Mindestversion der zu verwendenden Firmware 04.03.xx.xx, um alle gewaehlten Einstellungen zu unterstuetzen.

◆ minLibraryVersion()

std::string minLibraryVersion ( )

Mindestversion der zu verwendenden DFComDLL fuer die korrekte Uebertragung der Setupdaten.

◆ minStudioVersion()

std::string minStudioVersion ( )

Mindestversion des einzusetzenden Studios, um alle enthaltenen Daten zu unterstuetzen.

◆ MkSetupImage()

Result MkSetupImage ( EntryDevice &  root,
uint32_t &  setupSize 
)

◆ root()

EntryDevice& root ( )

◆ rootAccessControl()

EntryAccessControl2& rootAccessControl ( )

◆ rootEnergieSchemes()

EntryEnergieSchemes& rootEnergieSchemes ( )

◆ rootEventChains()

EntryEventChains& rootEventChains ( )

◆ rootHandling()

EntryHandling& rootHandling ( )

◆ rootIOModule()

EntryIOModule& rootIOModule ( )

◆ rootSignalProcessing()

EntrySignalProcessing& rootSignalProcessing ( )

◆ rootTableList()

EntryTableList& rootTableList ( )

◆ rootTableRecord()

EntryTableRecord& rootTableRecord ( )

◆ SaveCheck()

int32_t SaveCheck ( )

◆ SetDocumentDefault()

void SetDocumentDefault ( int32_t  flags = 0)

◆ setErrorText()

void setErrorText ( const std::string &  errorText)
inline

◆ setFileNameExtended()

void setFileNameExtended ( int32_t  num,
const std::string &  fileName 
)

◆ setFileNameList()

void setFileNameList ( int32_t  num,
const std::string &  fileName 
)

◆ setFileNameListAccessControl()

void setFileNameListAccessControl ( int32_t  num,
const std::string &  fileName 
)

◆ setFilePath()

void setFilePath ( const std::string &  fileName)
inline

◆ setFileType()

void setFileType ( FileType  type)
inline

◆ setupPassword()

const char* setupPassword ( )

◆ setupTypeName()

std::string setupTypeName ( SetupType  setupType)
inline

◆ setVersions() [1/2]

void setVersions ( const std::string &  studioVersion,
const std::string &  libraryVersion 
)

◆ setVersions() [2/2]

void setVersions ( uint32_t  studioVersion,
uint32_t  libraryVersion 
)

◆ setXmlParentNode()

tinyxml2::XMLElement* setXmlParentNode ( tinyxml2::XMLElement *  newParent)
inline

◆ shouldFirmware1Version()

std::string shouldFirmware1Version ( )

Sollteversion der zu verwendenden Firmware 04.01.xx.xx, um alle gewaehlten Einstellungen zu unterstuetzen.

◆ shouldFirmware2Version()

std::string shouldFirmware2Version ( )

Sollteversion der zu verwendenden Firmware 04.02.xx.xx, um alle gewaehlten Einstellungen zu unterstuetzen.

◆ shouldFirmware3Version()

std::string shouldFirmware3Version ( )

Sollteversion der zu verwendenden Firmware 04.03.xx.xx, um alle gewaehlten Einstellungen zu unterstuetzen.

◆ shouldLibraryVersion()

std::string shouldLibraryVersion ( )

Sollteversion der zu verwendenden DFComDLL fuer die korrekte Uebertragung der Setupdaten.

◆ shouldStudioVersion()

std::string shouldStudioVersion ( )

Sollteversion des einzusetzenden Studios, um alle enthaltenen Daten zu unterstuetzen.

◆ studioVersion()

std::string studioVersion ( )

Studioversion mit der die Datei zuletzt abgespeichert wurde.

◆ supportFirmware1Version()

bool supportFirmware1Version ( )

Wird die Version 04.01.xx der Firmware unterstützt.

◆ supportFirmware2Version()

bool supportFirmware2Version ( )

Wird die Version 04.02.xx der Firmware unterstützt.

◆ supportFirmware3Version()

bool supportFirmware3Version ( )

Wird die Version 04.03.xx der Firmware unterstützt.

◆ xmlParentNode()

tinyxml2::XMLElement* xmlParentNode ( )
inline

Dokumentation der Felder

◆ m_flagsLoadSetup

uint8_t m_flagsLoadSetup

◆ m_flashSetupSize

uint32_t m_flashSetupSize

◆ m_setupPassword

char* m_setupPassword[17]
protected

Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Datei:

© 2003-2021 Datafox GmbH