FireSync API
 All Classes Files Functions Variables Typedefs Friends Macros Modules Pages
kSensorIdentity Class Reference

Description

Manages Id.xml parsing and serialization.

Inheritance diagram for kSensorIdentity:
Inheritance graph

Public Member Functions

k32u kSensorIdentity_Class (kSensorIdentity identity)
 Returns the Class field as a k32u value. More...
 
kBool kSensorIdentity_ClassExists (kSensorIdentity identity)
 Reports whether the Class field exists. More...
 
kStatus kSensorIdentity_Clear (kSensorIdentity identity)
 Clears all fields in the SensorIdentity object. More...
 
const kCharkSensorIdentity_CompatibleFirmwareTag (kSensorIdentity identity)
 Returns the CompatibleFirmwareTag field as a character array. More...
 
kBool kSensorIdentity_CompatibleFirmwareTagExists (kSensorIdentity identity)
 Reports whether the CompatibleFirmwareTag field exists. More...
 
kStatus kSensorIdentity_Construct (kSensorIdentity *identity, kAlloc allocator)
 Constructs a kSensorIdentity object. More...
 
kBool kSensorIdentity_DefaultFieldsExist (kSensorIdentity identity)
 Reports whether the kSensorIdentity object contains the current set of default fields. More...
 
kBool kSensorIdentity_Equivalent (kSensorIdentity a, kSensorIdentity b)
 Reports whether two kSensorIdentity objects represent the same sensor model. More...
 
k32u kSensorIdentity_Field32u (kSensorIdentity identity, const kChar *name)
 Returns the specified field as a k32u value. More...
 
k64f kSensorIdentity_Field64f (kSensorIdentity identity, const kChar *name)
 Returns the specified field as a k64f value. More...
 
kSize kSensorIdentity_FieldCount (kSensorIdentity identity)
 Returns the number of fields defined in the identity object. More...
 
kBool kSensorIdentity_FieldExists (kSensorIdentity identity, const kChar *name)
 Reports whether a field exists with the specified name. More...
 
const kCharkSensorIdentity_FieldNameAt (kSensorIdentity identity, kSize index)
 Returns the field name at the specified index. More...
 
const kCharkSensorIdentity_FieldText (kSensorIdentity identity, const kChar *name)
 Returns the specified field as a character array. More...
 
const kCharkSensorIdentity_FieldValueAt (kSensorIdentity identity, kSize index)
 Returns the field value at the specified index. More...
 
const kCharkSensorIdentity_FirmwareVersion (kSensorIdentity identity)
 Returns the Version field as a kVersion object. More...
 
kBool kSensorIdentity_FirmwareVersionExists (kSensorIdentity identity)
 Reports whether the Version field exists. More...
 
kStatus kSensorIdentity_FromXml (kSensorIdentity *identity, kXml xml, kAlloc allocator)
 Constructs a SensorIdentity object from an XML object. More...
 
const kCharkSensorIdentity_HardwareRevision (kSensorIdentity identity)
 Returns the HardwareRevision field as a character array. More...
 
kBool kSensorIdentity_HardwareRevisionExists (kSensorIdentity identity)
 Reports whether the HardwareRevision field exists. More...
 
kStatus kSensorIdentity_InitFields (kSensorIdentity identity)
 Clears ALL fields, and initializes the kSensorIdentity object with the current set of default fields. More...
 
kStatus kSensorIdentity_InitOnlyDefaultFields (kSensorIdentity identity)
 Clears only the default fields, and initializes them back to the default values. More...
 
kBool kSensorIdentity_IsControl (kSensorIdentity identity)
 Returns the IsControl field as a kBool value. More...
 
kBool kSensorIdentity_IsControlExists (kSensorIdentity identity)
 Reports whether the IsControl field exists. More...
 
const kCharkSensorIdentity_LaserClass (kSensorIdentity identity)
 Returns the LaserClass field as a character array. More...
 
kBool kSensorIdentity_LaserClassExists (kSensorIdentity identity)
 Reports whether the LaserClass field exists. More...
 
kStatus kSensorIdentity_Load (kSensorIdentity *identity, const kChar *fileName, kAlloc allocator)
 Loads a SensorIdentity object from file. More...
 
const kCharkSensorIdentity_Model (kSensorIdentity identity)
 Returns the Model field as a character array. More...
 
kBool kSensorIdentity_ModelExists (kSensorIdentity identity)
 Reports whether the Model field exists. More...
 
k32u kSensorIdentity_ModelNumber (kSensorIdentity identity)
 Returns the ModelNumber field as a k32u value. More...
 
kBool kSensorIdentity_ModelNumberExists (kSensorIdentity identity)
 Reports whether the ModelNumber field exists. More...
 
k32u kSensorIdentity_OptionCode (kSensorIdentity identity)
 Returns the OptionCode field as a k32u value. More...
 
kBool kSensorIdentity_OptionCodeExists (kSensorIdentity identity)
 Reports whether the OptionCode field exists. More...
 
const kCharkSensorIdentity_Package (kSensorIdentity identity)
 Returns the Package field as a character array. More...
 
kBool kSensorIdentity_PackageExists (kSensorIdentity identity)
 Reports whether the Package field exists. More...
 
const kCharkSensorIdentity_PartNumber (kSensorIdentity identity)
 Returns the PartNumber field as a character array. More...
 
kBool kSensorIdentity_PartNumberExists (kSensorIdentity identity)
 Reports whether the PartNumber field exists. More...
 
kStatus kSensorIdentity_Save (kSensorIdentity identity, const kChar *fileName)
 Saves the SensorIdentity object to file. More...
 
k32u kSensorIdentity_SerialNumber (kSensorIdentity identity)
 Returns the SerialNumber field as a k32u value. More...
 
kBool kSensorIdentity_SerialNumberExists (kSensorIdentity identity)
 Reports whether the SerialNumber field exists. More...
 
kStatus kSensorIdentity_SetClass (kSensorIdentity identity, k32u value)
 Creates or modifies the Class field from a k32u value. More...
 
kStatus kSensorIdentity_SetCompatibleFirmwareTag (kSensorIdentity identity, const kChar *value)
 Creates or modifies the CompatibleFirmwareTag field from a character array. More...
 
kStatus kSensorIdentity_SetField32u (kSensorIdentity identity, const kChar *name, k32u value)
 Creates or modifies the specified field from a k32u value. More...
 
kStatus kSensorIdentity_SetField64f (kSensorIdentity identity, const kChar *name, k64f value)
 Creates or modifies the specified field from a k64f value. More...
 
kStatus kSensorIdentity_SetFieldText (kSensorIdentity identity, const kChar *name, const kChar *value)
 Creates or modifies the specified field from a character array. More...
 
kStatus kSensorIdentity_SetFirmwareVersion (kSensorIdentity identity, const kChar *value)
 Creates or modifies the Version field from a kVersion object. More...
 
kStatus kSensorIdentity_SetHardwareRevision (kSensorIdentity identity, const kChar *value)
 Creates or modifies the HardwareRevision field from a character array. More...
 
kStatus kSensorIdentity_SetIsControl (kSensorIdentity identity, kBool value)
 Creates or modifies the IsControl field from a kBool value. More...
 
kStatus kSensorIdentity_SetLaserClass (kSensorIdentity identity, const kChar *value)
 Creates or modifies the LaserClass field from a character array. More...
 
kStatus kSensorIdentity_SetModel (kSensorIdentity identity, const kChar *value)
 Creates or modifies the Model field from a character array. More...
 
kStatus kSensorIdentity_SetModelNumber (kSensorIdentity identity, k32u value)
 Creates or modifies the ModelNumber field from a k32u value. More...
 
kStatus kSensorIdentity_SetOptionCode (kSensorIdentity identity, k32u value)
 Creates or modifies the OptionCode field from a k32u value. More...
 
kStatus kSensorIdentity_SetPackage (kSensorIdentity identity, const kChar *value)
 Creates or modifies the Package field from a character array. More...
 
kStatus kSensorIdentity_SetPartNumber (kSensorIdentity identity, const kChar *value)
 Creates or modifies the PartNumber field from a character array. More...
 
kStatus kSensorIdentity_SetSerialNumber (kSensorIdentity identity, k32u value)
 Creates or modifies the SerialNumber field from a k32u value. More...
 
kStatus kSensorIdentity_SetSpectrum (kSensorIdentity identity, const kChar *value)
 Creates or modifies the Spectrum field from a character array. More...
 
const kCharkSensorIdentity_Spectrum (kSensorIdentity identity)
 Returns the Spectrum field as a character array. More...
 
kBool kSensorIdentity_SpectrumExists (kSensorIdentity identity)
 Reports whether the Spectrum field exists. More...
 
kStatus kSensorIdentity_ToXml (kSensorIdentity identity, kXml *xml, kAlloc allocator)
 Constructs an XML object from the SensorIdentity object. More...
 
k32u kSensorIdentity_Version (kSensorIdentity identity)
 Returns the SensorIdentity schema version (defined by kSENSOR_IDENTITY_VERSION). More...
 

Related

#define kSENSOR_IDENTITY_FILENAME
 Id.xml filename.
 

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