Detailed Description
Defines and optionally creates a shared memory section containing an SDS structure.
Shared memory sections are used by DRAMA in the handling of bulk data transfers.
If Type is set to ShareType::Create, then this class's constructor creates a temporary shared memory section of the size specified in some suitable form for the system it is running on. The caller has no control over the details of the shared memory section. In this case, the Name and Key arguments, and any preset value at the location specified by the Address argument are all ignored. A new section will be created and mapped.
VxWorks: The mapped section is just a section of memory, starting at a specified address. Type should be ShareType::Global. Name should be an empty string, and Key is ignored. If Create is specified, Address is ignored, and a suitably sized area of memory is allocated. If Create is passed as false, then Address should contain the address of the memory section in question. Under VxWorks, this is what is generated by ShareType::Default.
UNIX: The mapped section can be created as System V shared memory, in which case Type should be ShareType::SHMem , or as a file accessed through mmap(), in which case Type should be ShareType::MMap. If Type is ShareType::SHMem, Key specifies the identifier for the shared memory and Name should be an empty string. If Type is ShareType::MMap, Name should be the full name of the file, and Key is ignored. Address is ignored in both cases. On UNIX, one of these types will be what is provided by ShareType::Default.
#include "bulkdata.hh"
Inheritance diagram for drama::BulkDataSds:
Public Member Functions | |
| BulkDataSds () | |
| Default constructor. | |
| BulkDataSds (std::weak_ptr< Task > theTask, const sds::Id &SdsTemplate, ShareType type=ShareType::Create, bool Create=true, bool DeleteOnDestruct=true, void *Address=nullptr, const std::string &Name="", int Key=0) | |
| Define a bulk data shared memory segment of the specified type for use with DRAMA 2 methods which can send bulk data, for transfer of an SDS structure. | |
| template<typename ContainerType > | |
| void | AddToArgCmdStruct (const ContainerType &values, const unsigned firstArg=1) |
| Insert a set of values from a container into an SDS structure in in the DRAMA Command style. | |
| template<typename T > | |
| void | ArrayAccess (ArrayAccessHelper< T > *const data) const |
| Access the data of a single dimensional SDS primitive array item of a specified number of elements. | |
| template<typename T , class ContainerType > | |
| void | ArrayAccess (ArrayAccessHelper< T > *const data, ContainerType *dims) const |
| Access the data of an SDS primitive item array. | |
| template<typename T , class ContainerType > | |
| void | ArrayAccess (ArrayAccessHelper< T > *const data, long ndims, ContainerType *dims) const |
| Access the data of an SDS primitive item array. | |
| template<typename T > | |
| void | ArrayAccess (const unsigned long nitems, sds::ArrayAccessHelper< T > *const data) const |
| Access the data of a single dimensional SDS primitive item array of a specified number of elements. | |
| template<class ContainerType > | |
| Id | Cell (const ContainerType &indicies, bool throwOnNotFound=true) const |
| Factory constructor method Constructor that returns a cell of an existing id which must refer to an SDS array. | |
| template<class ContainerType > | |
| void | CheckItem (SdsCodeType code, const ContainerType &dims) const |
| Check an item has a required structure. | |
| virtual void | ClearDelete () |
| Indicate the underlying SDS structure should NOT be deleted when the sds::Id object is destroyed. | |
| virtual Id | Copy () const |
| Factory constructor method Id Copy constructor. | |
| virtual SdsIdType | COut (const bool outlives, bool *const free=0, bool *const del=0, bool *const readfree=0) |
| Return this item as an SdsIdType for return to C code. | |
| template<class ContainerType > | |
| Id | CreateChildArray (const std::string &name, const SdsCodeType code, const ContainerType &dims, const std::string &extra="") const |
| Factory constructor method Constructor which creates a new child item which is an multi-dimensional array. | |
| Id | CreateChildArray (const std::string &name, const SdsCodeType code, const unsigned nElem, const std::string &extra="") const |
| Factory constructor method Constructor which creates a new child item which is a one-dimensional array. | |
| virtual Id | CreateChildItem (const std::string &name, const SdsCodeType code, const std::string &extra="") const |
| Factory constructor method which creates a new (non-array) child item. | |
| template<typename T > | |
| T * | Data (unsigned long *nitems=nullptr) |
| Return a pointer to the actual data. | |
| virtual void | Delete () |
| Delete the SDS item. | |
| virtual bool | Exists (const std::string &name) const |
| Determine if a named item exists in a structure. | |
| virtual bool | Exists (unsigned index) const |
| Determine if a item of a given index exists in a structure. | |
| template<class ContainerType > | |
| void | Export (ContainerType *container) const |
| Export the SDS structure into a buffer. | |
| template<class ContainerType > | |
| void | ExportDefined (ContainerType *container) const |
| Export the SDS structure into a buffer, defining any undefined data. | |
| virtual void | Extract () |
| Extract the SDS structure from its parent. | |
| virtual void | FillArray (const Id &elem) |
| Fill out the contents of this object, which is a structured array. | |
| virtual Id | Find (const std::string &name, bool throwOnNotFound=true) const |
| Factory constructor method Constructor which returns a reference to a named item. | |
| virtual void | Flush () |
| Flush data modified by pointer. | |
| template<typename T > | |
| void | Get (const std::string &name, T *value) const |
| Fetch primitive value from a named component of the structure. | |
| template<typename T > | |
| void | Get (const unsigned long length, T *const data, unsigned long *actlen=nullptr, const unsigned long offset=0) const |
| Get data from an SDS item. | |
| template<typename T > | |
| void | Get (T *value) const |
| Fetch primitive value from the component. | |
| virtual SdsCodeType | GetCode () const |
| Return the code of the SDS item. | |
| template<class ContainerType > | |
| void | GetDims (ContainerType *dims) const |
| Return the dimensions of the SDS item. | |
| DitsSharedMemInfoType & | GetDitsSharedMemInfo () |
| Return a reference to the DitsSharedMemInfoType object managed by this. | |
| virtual double | GetDouble () const |
| If the SDS item refers to a scalar value, convert it to a double item. | |
| virtual std::string | GetExtra () const |
| Get extra data from an SDS item. | |
| virtual int | GetInt () const |
| If the SDS item refers to a scalar value, convert it to an integer. | |
| virtual long | GetLong () const |
| If the SDS item refers to a scalar value, convert it to long integer. | |
| virtual std::string | GetName () const |
| Return the name of the SDS item. | |
| unsigned | GetNumItems () const |
| Return the number of components in an SDS structure. | |
| std::string | GetString () const |
| If the SDS item refers to a scalar value or a character string, convert it to a string item. | |
| virtual unsigned int | GetUInt () const |
| If the SDS item refers to a scalar value, convert it to an unsigned integer. | |
| virtual unsigned long | GetULong () const |
| If the SDS item refers to a scalar value, convert it to an unsigned long integer. | |
| virtual Id | Index (const long index, bool throwOnNotFound=true) const |
| Factory constructor method Constructor which returns an id to a structured item indexed by position. | |
| virtual void | Insert (Id &to_insert) |
| Insert an SDS object into this object. | |
| template<class ContainerType > | |
| void | Insert (Id &to_insert, const ContainerType &dims) |
| Insert an SDS object into this object, which is a structured array. | |
| virtual bool | IsExternal () const |
| Determine if the SDS structure is external. | |
| virtual void | List () const |
| List the contents of the structure to standard output. | |
| virtual void | List (const PrintObjectCR &printer, int lineMaxLen=100) const |
| List the contents of the structure via a PrintObjectCR. | |
| virtual void | List (FILE *to) const |
| List the contents of the structure to a C file. | |
| virtual void | List (PrintObjectPnt *printer, int lineMaxLen=100) const |
| List the contents of the structure via a PrintObjectPnt object. | |
| virtual void | List (std::ostream &strm, int lineMaxLen=100) const |
| List the contents of the structure to an output stream. | |
| operator bool () const | |
| Operator which tests if an item is valid. | |
| operator SdsIdType () const | |
| Operator which returns the underlying SDS id. | |
| virtual void | Outlive () |
| Force the actual SDS ID to outlive the sds::Id variable. | |
| template<typename T > | |
| void | Pointer (T **data, unsigned long *length=0) const |
| Obtain a pointer to the data area of a primitive SDS item. | |
| void | Put (const std::string &name, const std::string &value, const std::string &extraData="") |
| Insert a string value into a named component of the structure. | |
| template<typename T > | |
| void | Put (const std::string &name, T value, const std::string &extraData="") |
| Insert a primitive value into a named component of the structure. | |
| void | Put (const std::string &value) |
| Insert a string value into the component. | |
| template<typename T > | |
| void | Put (const unsigned long length, const T *const data, const unsigned long offset=0) |
| Put data into an SDS item. | |
| template<typename T > | |
| void | Put (T value) |
| Insert a primitive value into the item. | |
| virtual void | PutExtra (const std::string &extra) |
| Put extra data into an SDS item. | |
| virtual void | Rename (const std::string &name) |
| Rename the SDS item. | |
| template<class ContainerType > | |
| void | Resize (const ContainerType &dims) |
| Change the dimensions of an SDS array. | |
| virtual void | SetDelete () |
| Indicate the underlying SDS structure should be deleted when the sds::Id object is destroyed. | |
| virtual void | SetFree () |
| Indicate the underlying SDS item should be free-ed when the sds::Id object is destroyed. | |
| virtual void | ShallowCopy (const Id &source) |
| Shallow copy from a const sds::Id which will outlive this object. | |
| virtual void | ShallowCopy (const SdsIdType source, const bool free=false, const bool del=false, const bool readfree=false) |
| Shallow copy from SdsIdType. | |
| virtual void | ShallowCopy (Id *source, const bool outlives) |
| Shallow copy from sds::Id. | |
| virtual unsigned long | Size () const |
| Return the size of an SDS structure, as required for exporting. | |
| virtual unsigned long | SizeDefined () const |
| Return the size of an SDS structure, as required for exporting when fully defined. | |
| virtual void | ToSdsId (::SdsId *target, const bool outlives=false) |
| Shallow copy to an SdsId type. | |
| virtual std::string | toString (int maxlen=200) |
| Convert the structure to a string. | |
| virtual void | ValidateCode (SdsCodeType requiredCode) const |
| Validate the code of the SDS item. | |
| virtual void | Write (const std::string &filename) const |
| Write the contents of the structure to a file. | |
Static Public Member Functions | |
| template<typename ContainerType > | |
| static Id | CreateArgCmdStruct (const ContainerType &values, const std::string &name="ArgStructure") |
| Factory constructor which creates a new "Arg" style SDS structure in the DRAMA Command style. | |
| template<typename T > | |
| static Id | CreateArgCmdStruct (const std::initializer_list< T > &values, const std::string &name="ArgStructure") |
| Factory constructor which creates a new "Arg" style SDS structure in the DRAMA Command style. | |
| template<typename T > | |
| static Id | CreateArgCmdStructSingle (const T value, const std::string &name="ArgStructure") |
| Factory constructor which creates a new "Arg" style SDS structure in the DRAMA Command style. | |
| static Id | CreateArgStruct (const std::string &name="ArgStructure") |
| Factory constructor which creates a new "Arg" style SDS structure. | |
| template<class ContainerType > | |
| static Id | CreateByAccess (ContainerType *container) |
| Factory constructor method that accesses an exported SDS structure found in a byte stream. | |
| template<class ContainerType > | |
| static Id | CreateByImport (const ContainerType &container) |
| Factory constructor method that imports an exported SDS structure found in a byte stream. | |
| static Id | CreateFromSdsId (const SdsId &item) |
| Factory constructor method that constructs an sds::Id item from an existing old C++ interface SdsId item. | |
| static Id | CreateFromSdsId (SdsId *item) |
| Factory constructor method that constructs an sds::Id item from an existing old C++ interface SdsId item. | |
| static Id | CreateFromSdsIdType (const SdsIdType item, const bool free=false, const bool del=false, const bool readfree=false) |
| Factory constructor method that constructs an sds::Id item from an existing C language SDS id. | |
| static Id | CreateFromSdsIdTypeCopy (const SdsIdType item) |
| Factory constructor method that constructs an sds::Id item by coping an existing C language SDS id. | |
| static Id | CreateNullItem () |
| Factory constructor method that constructs an null sds::Id item . | |
| static Id | CreateTopLevel (const std::string &name, const SdsCodeType code, const std::string &extra="") |
| Constructor which creates a new (non-array) top-level item. | |
| template<class ContainerType > | |
| static Id | CreateTopLevelArray (const std::string &name, const SdsCodeType code, const ContainerType &dims, const std::string &extra="") |
| Factory constructor method Constructor which creates a new array top-level item. | |
| static Id | CreateTopLevelArray (const std::string &name, const SdsCodeType code, const unsigned nElem, const std::string &extra="") |
| Factory constructor method Constructor which creates a new one-dimensional array top-level item. | |
| static Id | FromFile (const std::string &filename) |
| Factory constructor method that reads an SDS structure from a file. | |
Protected Member Functions | |
| void * | RawDataAddr () const |
| Returns the raw address of the data. | |
| unsigned long | SizeBytes () const |
| Return the size of the data in bytes. | |
The documentation for this class was generated from the following file:
