Common

Common

Erlaubte Operation IDs: keine

Um das Interface kompatibel zu halten werden Änderungen am Interface NACH dem 09.07.2008
nur noch über, in allen Methoden hinterlegte, optionale Parameter oder neue Methoden
abgebildet. Neue Methoden die den Funktionsumfang einer bereits existierenden Methode
ändern werden mit dem Suffix Ex gekennzeichnet, ebenso die benötigen Datentypen Argument
Result Error.

Bei der Verwendung der optionale Parameter ist darauf zu achten das diese eindeutig dokumentiert
werden. Für die optionalen Parameter werden die EDataStructures und EDataConverter aus dieser
Bibliothek verwendet um unterschiedliches ein und auspacken auf Client bzw. Serverseite
zu verhindern. Jeder optionale Parameter besteht aus einer UUID zur eindeutigen Kennzeichnung
sowie einer Choice aus UTF8String, OCTET STRING oder INTEGER. (Siehe weiter unten)
Die einzelnen verwendeten UUIDs werden im Header OptionalParamUUIDs.h beschrieben (Siehe Info dort)

Änderungen an dieser Datei werden zukünftig sowohl hier im Header als auch bei den entsprechenden
Methoden, Datentypen beschrieben. Die folgende Nomenklatur sollte dabei eingehalten werden

ChangeLog

    • 01.07.2008 JR - AsnCtiNewCallParams, optionaler Parameter für Rufnummernunterdrückung hinzugefügt
    • 01.07.2008 JR - komponente, modifiziert
  • 01.07.2008 JR - komponente, entfernt
    • 09.07.2008 JR - asnCtiSetupConference, hinzugefügt für Erstellen einer Konferenz
    • 23.07.2008 JR - AsnConversationContactStatus enum um zwei weitere Werte erweitert (Versionkompatibel da nur Vergleichsliste für Konverter )
  • 12.08.2011 AS Anmerkung diese Versionhistorie wird nicht gepflegt siehe Subversion Log
  • ste 21.10.2014
  • twu 29.05.2017 AsnStringIntegerPairList, AsnStringIntegerPair added

Das ENetRoseInterface wird jetzt auf mehrere ASN Files verteilt.
Datentypen, die gemeinsam verwendet werden, stehen hier im common
in dieser Datei sollen keine IMPORT Statements stehen

Modulbeschreibung

In diesem Modul werden Datentypen definiert, die von den anderen Modulen
gemeinsam verwendet werden.
Es sollen so wenig wie möglich Datentype hier aufgenommen werden
Die generierten c++ header werden beim Compilieren von den anderen Modulen included

NAME CONVENTION
Namenskonvention 15.11.2005 JR
updated 25.10.2006 JR
updated 14.08.2007 JR

Variablennamen beginnen mit Kleinbuchstaben die den Typ der
Variable beschreiben gefolgt von einem Großbuchstaben und dem
Namen der Variable. Zusammengesetzte Datentypen beginnen mit
Großbuchstaben die den Typ der Struktur angeben gefolgt vom Namen.

Singuläre Datentypen

C++ Äquivalent

  • iDummy = INTEGER -32768 bis +32767 short int
  • rDummy = REAL 2,9E-39 bis 3,4E34 float (3,4E-38 3,4E+38)
  • bDummy = BOOLEAN TRUE oder FALSE bool / BOOL
  • binDummy = OCTET STRING byteblock - json encoded as base64
  • u8sDummy = OCTET STRING ( CONTAINING UTF8String ) std::string - json encoded as string
  • u8sDummy = UTF8String std::wstring

Optionale Parameter tragen im Namen das p für Pointer

Zusammengesetzte Datentypen:

  • seqDummy = SEQUENCE
  • choDummy = CHOICE
  • EnumDummy = ENUMERATED

objective systems
AUSNAHME:
Result und Argument beginnen NICHT mit SEQ sondern direkt mit dem Namen der Struktur
Sie beinhalten als letzten Teil des Namens "Argument" bzw. "Result"

Argumentnamen beginnen mit einem Großbuchstaben

Resultnamen beginnen mit einem Großbuchstaben

Operationen beginnen mit einem Kleinbuchstaben

Types:

Name Description
AsnSystemTime

EnumProjectType

AsnContactPhoneLineType

AsnContactPhoneLineState

AsnOptionalParamChoice

AsnStringPair

AsnIntegerPair

AsnStringIntegerPair

AsnOptionalParam

AsnStringPairList

AsnOptionalParameters

AsnProjectPinRule

AsnNetDatabaseContact

AsnNetDatabaseContactID

AsnIntegerPairList

AsnStringIntegerPairList

AsnDummyArgument

AsnRequestError

SEQInteger

AsnProjectPinRuleList

UTF8StringList

AsnCtiNewCallParams

AsnNetDatabaseContactList

AsnNetDatabaseContactIDList

AsnUserPropertyBag

Version 6.1