cipelectronickey.h

Go to the documentation of this file.

/*******************************************************************************
 * Copyright (c) 2016, Rockwell Automation, Inc.
 * All rights reserved.
 *
 ******************************************************************************/

#ifndef SRC_CIP_CIPELECTRONICKEY_H_
#define SRC_CIP_CIPELECTRONICKEY_H_

#include <stdbool.h>

#include "typedefs.h"

typedef struct {
  CipUsint key_format; 
  void *key_data; 
} CipElectronicKey;

void ElectronicKeySetSegmentType(CipElectronicKey *const electronic_key,
                                 const CipUsint segment_type);

CipUsint ElectronicKeyGetSegmentType(
  const CipElectronicKey *const electronic_key);

void ElectronicKeySetKeyFormat(CipElectronicKey *const electronic_key,
                               const CipUsint key_format);

CipUint ElectronicKeyGetKeyFormat(const CipElectronicKey *const electronic_key);

void ElectronicKeySetKeyData(CipElectronicKey *const electronic_key,
                             void *key_data);

void *ElectronicKeyGetKeyData(const CipElectronicKey *const electronic_key);

typedef struct electronic_key_format_4 ElectronicKeyFormat4;

extern const size_t kElectronicKeyFormat4Size;

ElectronicKeyFormat4 *ElectronicKeyFormat4New(
  );

void ElectronicKeyFormat4Delete(ElectronicKeyFormat4 **electronic_key);

void ElectronicKeyFormat4SetVendorId(ElectronicKeyFormat4 *const electronic_key,
                                     const CipUint vendor_id);

CipUint ElectronicKeyFormat4GetVendorId(
  const ElectronicKeyFormat4 *const electronic_key);

void ElectronicKeyFormat4SetDeviceType(
  ElectronicKeyFormat4 *const electronic_key,
  const CipUint device_type);

CipUint ElectronicKeyFormat4GetDeviceType(
  const ElectronicKeyFormat4 *const electronic_key);

void ElectronicKeyFormat4SetProductCode(
  ElectronicKeyFormat4 *const electronic_key,
  const CipUint product_code);

CipUint ElectronicKeyFormat4GetProductCode(
  const ElectronicKeyFormat4 *const electronic_key);

void ElectronicKeyFormat4SetMajorRevisionCompatibility(
  ElectronicKeyFormat4 *const electronic_key,
  const CipByte major_revision_compatibility);

CipByte ElectronicKeyFormat4GetMajorRevision(
  const ElectronicKeyFormat4 *const electronic_key);

bool ElectronicKeyFormat4GetMajorRevisionCompatibility(
  const ElectronicKeyFormat4 *const electronic_key);

void ElectronicKeyFormat4SetMinorRevision(
  ElectronicKeyFormat4 *const electronic_key,
  const CipUsint minor_revision);

CipUsint ElectronicKeyFormat4GetMinorRevision(
  const ElectronicKeyFormat4 *const electronic_key);

#endif /* SRC_CIP_CIPELECTRONICKEY_H_ */