![]() |
Datafox DFCom - API
04.03.18
Dokumentation zur Datafox Kommunikationsbibliothek (DFComDLL.dll / DFCom_x64.dll)
|
#include <document_studio.h>
Datenstrukturen | |
struct | Result |
Ö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] |
|
strong |
DocumentStudio | ( | const std::string & | studioVersion, |
const std::string & | libraryVersion | ||
) |
~DocumentStudio | ( | ) |
|
inline |
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 | ||
) |
|
inline |
|
inline |
std::string fileNameExtended | ( | int32_t | num | ) |
std::string fileNameList | ( | int32_t | num | ) |
std::string fileNameListAccessControl | ( | int32_t | num | ) |
|
inline |
|
inline |
void GetAccessControlListName | ( | uint8_t | ucNum, |
char * | szBuf | ||
) |
EntryTable* GetAccessControlTable | ( | uint8_t | num | ) |
uint8_t GetAccessControlTableCount | ( | ) |
EntryTableField* GetAccessControlTableField | ( | uint8_t | numTable, |
uint8_t | numField | ||
) |
uint32_t GetEntrance2EKFlashSize | ( | ) |
uint32_t GetEntranceEKFlashSize | ( | ) |
uint32_t GetExtendedFlashSize | ( | ) |
uint32_t GetFlashSetupSize | ( | ) |
uint32_t GetFlashSetupSize4_2 | ( | ) |
void GetListName | ( | uint8_t | ucNum, |
char * | szBuf | ||
) |
EntryTable* GetListTable | ( | uint8_t | num | ) |
uint8_t GetListTableCount | ( | ) |
EntryTableField* GetListTableField | ( | uint8_t | numTable, |
uint8_t | numField | ||
) |
uint32_t GetMDEEKFlashSize | ( | ) |
EntryTable* GetRecordTable | ( | uint8_t | num | ) |
uint8_t GetRecordTableCount | ( | ) |
EntryTableField* GetRecordTableField | ( | uint8_t | numTable, |
uint8_t | numField | ||
) |
int32_t GetTable | ( | uint8_t | num, |
StructTable & | table, | ||
uint8_t | typeTable | ||
) |
int32_t GetTableCount | ( | uint8_t | typeTable | ) |
int32_t GetTableField | ( | uint8_t | numTable, |
uint8_t | numField, | ||
StructTableField & | field, | ||
uint8_t | typeTable | ||
) |
uint8_t globalVariableCount | ( | ) |
int32_t globalVariableIndex | ( | uint8_t | ucDefNum | ) |
std::string globalVariableName | ( | uint8_t | num | ) |
std::list<std::string> globalVariablesName | ( | ) |
std::unordered_map<std::string, std::string> globalVariablesValueDefault | ( | ) |
bool isAccessControl | ( | ) |
bool isAccessControlExtension | ( | ) |
int32_t IsAnalogStatusAvailable | ( | ) |
int32_t IsAnalogValueAvailable | ( | ) |
int32_t IsCounterAvailable | ( | ) |
bool IsEmpty | ( | ) |
int32_t IsFunctionAvailable | ( | ) |
int32_t IsSystemMessageAvailable | ( | ) |
int32_t IsTimerInputChainAvailable | ( | ) |
std::string listName | ( | int32_t | num | ) |
std::string listNameAccessControl | ( | int32_t | num | ) |
std::string minFirmware1Version | ( | ) |
Mindestversion der zu verwendenden Firmware 04.01.xx.xx, um alle gewaehlten Einstellungen zu unterstuetzen.
std::string minFirmware2Version | ( | ) |
Mindestversion der zu verwendenden Firmware 04.02.xx.xx, um alle gewaehlten Einstellungen zu unterstuetzen.
std::string minFirmware3Version | ( | ) |
Mindestversion der zu verwendenden Firmware 04.03.xx.xx, um alle gewaehlten Einstellungen zu unterstuetzen.
std::string minLibraryVersion | ( | ) |
Mindestversion der zu verwendenden DFComDLL fuer die korrekte Uebertragung der Setupdaten.
std::string minStudioVersion | ( | ) |
Mindestversion des einzusetzenden Studios, um alle enthaltenen Daten zu unterstuetzen.
Result MkSetupImage | ( | EntryDevice & | root, |
uint32_t & | setupSize | ||
) |
EntryDevice& root | ( | ) |
EntryAccessControl2& rootAccessControl | ( | ) |
EntryEnergieSchemes& rootEnergieSchemes | ( | ) |
EntryEventChains& rootEventChains | ( | ) |
EntryHandling& rootHandling | ( | ) |
EntryIOModule& rootIOModule | ( | ) |
EntrySignalProcessing& rootSignalProcessing | ( | ) |
EntryTableList& rootTableList | ( | ) |
EntryTableRecord& rootTableRecord | ( | ) |
int32_t SaveCheck | ( | ) |
void SetDocumentDefault | ( | int32_t | flags = 0 | ) |
|
inline |
void setFileNameExtended | ( | int32_t | num, |
const std::string & | fileName | ||
) |
void setFileNameList | ( | int32_t | num, |
const std::string & | fileName | ||
) |
void setFileNameListAccessControl | ( | int32_t | num, |
const std::string & | fileName | ||
) |
|
inline |
|
inline |
const char* setupPassword | ( | ) |
|
inline |
void setVersions | ( | const std::string & | studioVersion, |
const std::string & | libraryVersion | ||
) |
void setVersions | ( | uint32_t | studioVersion, |
uint32_t | libraryVersion | ||
) |
|
inline |
std::string shouldFirmware1Version | ( | ) |
Sollteversion der zu verwendenden Firmware 04.01.xx.xx, um alle gewaehlten Einstellungen zu unterstuetzen.
std::string shouldFirmware2Version | ( | ) |
Sollteversion der zu verwendenden Firmware 04.02.xx.xx, um alle gewaehlten Einstellungen zu unterstuetzen.
std::string shouldFirmware3Version | ( | ) |
Sollteversion der zu verwendenden Firmware 04.03.xx.xx, um alle gewaehlten Einstellungen zu unterstuetzen.
std::string shouldLibraryVersion | ( | ) |
Sollteversion der zu verwendenden DFComDLL fuer die korrekte Uebertragung der Setupdaten.
std::string shouldStudioVersion | ( | ) |
Sollteversion des einzusetzenden Studios, um alle enthaltenen Daten zu unterstuetzen.
std::string studioVersion | ( | ) |
Studioversion mit der die Datei zuletzt abgespeichert wurde.
bool supportFirmware1Version | ( | ) |
Wird die Version 04.01.xx der Firmware unterstützt.
bool supportFirmware2Version | ( | ) |
Wird die Version 04.02.xx der Firmware unterstützt.
bool supportFirmware3Version | ( | ) |
Wird die Version 04.03.xx der Firmware unterstützt.
|
inline |
uint8_t m_flagsLoadSetup |
uint32_t m_flashSetupSize |
|
protected |