dali/bacnet_stack
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fixed up EOL for subversion.

Browse Source
This commit is contained in:
skarg
2010-05-04 21:04:26 +00:00
parent 74be776295
commit b2368acc27
1 changed files with 90 additions and 90 deletions
Download Patch File Download Diff File Expand all files Collapse all files
bacnet-stack/demo/epics/bacepics.h
+90 -90
View File
@@ -1,90 +1,90 @@
/************************************************************************** /**************************************************************************
* *
* Copyright (C) 2006 Steve Karg <skarg@users.sourceforge.net> * Copyright (C) 2006 Steve Karg <skarg@users.sourceforge.net>
* *
* Permission is hereby granted, free of charge, to any person obtaining * Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the * a copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including * "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish, * without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to * distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to * permit persons to whom the Software is furnished to do so, subject to
* the following conditions: * the following conditions:
* *
* The above copyright notice and this permission notice shall be included * The above copyright notice and this permission notice shall be included
* in all copies or substantial portions of the Software. * in all copies or substantial portions of the Software.
* *
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
* *
*********************************************************************/ *********************************************************************/
#ifndef BACEPICS_H_ #ifndef BACEPICS_H_
#define BACEPICS_H_ #define BACEPICS_H_
/** @file epics/bacepics.h Header for tool to generate EPICS-usable output. */ /** @file epics/bacepics.h Header for tool to generate EPICS-usable output. */
/** @defgroup BACEPICS Tool to generate EPICS-usable output. /** @defgroup BACEPICS Tool to generate EPICS-usable output.
* @ingroup Demos * @ingroup Demos
* This tool will generate a list of Objects and their properties for use in * This tool will generate a list of Objects and their properties for use in
* an EPICS file. * an EPICS file.
* You will still need to provide the front part of the EPICS (see file * You will still need to provide the front part of the EPICS (see file
* demo/server/epics_vts3.tpi) which cannot be easily determined by observation, * demo/server/epics_vts3.tpi) which cannot be easily determined by observation,
* but this tool communicates with the test device and does the grunt work of * but this tool communicates with the test device and does the grunt work of
* creating the list of Objects and the supported properties for * creating the list of Objects and the supported properties for
* each of those Objects. * each of those Objects.
* *
* Usage: * Usage:
* ./bacepics [-v] 1234 * ./bacepics [-v] 1234
* *
* - where the device instance to be addressed is 1234, * - where the device instance to be addressed is 1234,
* - and the optional -v prints values out rather than the '?' that * - and the optional -v prints values out rather than the '?' that
* the EPICS format for VTS3 wants. * the EPICS format for VTS3 wants.
* *
* The tool follows an optimal approach which will use efficient communication * The tool follows an optimal approach which will use efficient communication
* means if available or else fall back to simple-minded methods. * means if available or else fall back to simple-minded methods.
* Starting with the Device Object, the tool will * Starting with the Device Object, the tool will
* - Try to fetch ALL the Properties with RPM * - Try to fetch ALL the Properties with RPM
* - If RPM is not supported, will use coded properties in demo/object folder * - If RPM is not supported, will use coded properties in demo/object folder
* - If response is too big to fit (without segmentation), then will fetch * - If response is too big to fit (without segmentation), then will fetch
* ALL again with array index of 0, which should result mostly in errors * ALL again with array index of 0, which should result mostly in errors
* but will provide the list of supported properties. * but will provide the list of supported properties.
* - If that succeeds, build the list of properties to be accessed. <br> * - If that succeeds, build the list of properties to be accessed. <br>
* - If no RPM or failed to get ALL properties from the target device, then * - If no RPM or failed to get ALL properties from the target device, then
* fetch the coded Required and Optional properties from the demo/object * fetch the coded Required and Optional properties from the demo/object
* folder for this object type, and use this to build the list of * folder for this object type, and use this to build the list of
* properties to be accessed. * properties to be accessed.
* - If the Fetch All succeeded, print the values for each property * - If the Fetch All succeeded, print the values for each property
* - Otherwise, for each property in the list for this object, * - Otherwise, for each property in the list for this object,
* - Request the single property value with ReadProperty (RP) * - Request the single property value with ReadProperty (RP)
* - From the response, print the property's value * - From the response, print the property's value
* The Device Object will have fetched the Object List property and built a list * The Device Object will have fetched the Object List property and built a list
* of objects from that; use it now to cycle through each other Object and * of objects from that; use it now to cycle through each other Object and
* repeat the above process to get and print out their property values. * repeat the above process to get and print out their property values.
*/ */
/** The allowed States of the bacepics State Machine. /** The allowed States of the bacepics State Machine.
* Important to distinguish the request from the response phases as well * Important to distinguish the request from the response phases as well
* as which approach will get all the properties for us. * as which approach will get all the properties for us.
* @ingroup BACEPICS * @ingroup BACEPICS
*/ */
typedef enum { typedef enum {
/** Initial state to establish a binding with the target device. */ /** Initial state to establish a binding with the target device. */
INITIAL_BINDING, INITIAL_BINDING,
/** Getting ALL properties and values at once with RPM. */ /** Getting ALL properties and values at once with RPM. */
GET_ALL_REQUEST, GET_ALL_RESPONSE, GET_ALL_REQUEST, GET_ALL_RESPONSE,
/** Getting ALL properties with array index = 0, just to get the list. */ /** Getting ALL properties with array index = 0, just to get the list. */
GET_LIST_OF_ALL_REQUEST, GET_LIST_OF_ALL_RESPONSE, GET_LIST_OF_ALL_REQUEST, GET_LIST_OF_ALL_RESPONSE,
/** Processing the properties individually with ReadProperty. */ /** Processing the properties individually with ReadProperty. */
GET_PROPERTY_REQUEST, GET_PROPERTY_RESPONSE, GET_PROPERTY_REQUEST, GET_PROPERTY_RESPONSE,
/** Done with this Object; move onto the next. */ /** Done with this Object; move onto the next. */
NEXT_OBJECT NEXT_OBJECT
} EPICS_STATES; } EPICS_STATES;
#endif /* BACEPICS_H_ */ #endif /* BACEPICS_H_ */