MHO_VectorContainer - basis for for axis data objects in HOPS4, it is an 1-dimensional array object, key:value data can be attached via the MHO_Taggable interface. More...

#include <MHO_VectorContainer.hh>

Inheritance diagram for hops::MHO_VectorContainer< XValueType >:

[legend]

Public Member Functions
	MHO_VectorContainer ()

	MHO_VectorContainer (const MHO_VectorContainer &obj)

	MHO_VectorContainer (std::size_t *dim)

	MHO_VectorContainer (std::size_t dim)

virtual	~MHO_VectorContainer ()

MHO_VectorContainer *	Clone ()
	Clones the current MHO_VectorContainer object. More...

uint64_t	ComputeSerializedSize () const
	Calculates and returns the serialized size as a uint64_t. More...

uint64_t	ComputeSerializedSize () const
	Function MHO_VectorContainer<std::string>::ComputeSerializedSize - specialization for string elements. More...

virtual void	Copy (const MHO_VectorContainer &rhs)
	Expensive copy for MHO_VectorContainer, pointers to exernally managed memory are not transferred, but data is. More...

virtual uint64_t	GetSerializedSize () const override
	Getter for serialized size. More...

virtual MHO_ClassVersion	GetVersion () const override
	Getter for version. More...

Public Member Functions inherited from hops::MHO_NDArrayWrapper< XValueType, 1 >
	MHO_NDArrayWrapper ()

	MHO_NDArrayWrapper (const MHO_NDArrayWrapper &obj)

	MHO_NDArrayWrapper (const std::size_t *dim)

	MHO_NDArrayWrapper (std::size_t dim)

	MHO_NDArrayWrapper (XValueType ptr, const std::size_t dim)

	MHO_NDArrayWrapper (XValueType *ptr, std::size_t dim)

virtual	~MHO_NDArrayWrapper ()

XValueType &	at (std::size_t idx)

const XValueType &	at (std::size_t idx) const

iterator	begin ()

const_iterator	cbegin () const

const_iterator	cend () const

const_iterator	citerator_at (std::size_t offset) const

virtual void	Copy (const MHO_NDArrayWrapper &rhs)

const_stride_iterator	cstride_begin (std::size_t stride) const

const_stride_iterator	cstride_end (std::size_t stride) const

const_stride_iterator	cstride_iterator_at (std::size_t offset, std::size_t stride) const

iterator	end ()

XValueType *	GetData ()
	Getter for data. More...

const XValueType *	GetData () const
	Getter for data. More...

std::size_t	GetDimension (std::size_t idx) const

index_type	GetDimensionArray () const
	Getter for dimension array. More...

const std::size_t *	GetDimensions () const
	Getter for dimensions. More...

void	GetDimensions (std::size_t *dim) const
	Getter for dimensions. More...

index_type	GetIndicesForOffset (std::size_t offset)

std::size_t	GetOffsetForIndices (const std::size_t *index)

std::size_t	GetRank () const
	Getter for rank. More...

std::size_t	GetSize () const
	Getter for size. More...

std::size_t	GetStride (std::size_t idx) const

index_type	GetStrideArray () const

const std::size_t *	GetStrides () const

void	GetStrides (std::size_t *strd) const

iterator	iterator_at (std::size_t offset)

XValueType &	operator() (std::size_t idx)

const XValueType &	operator() (std::size_t idx) const

MHO_NDArrayWrapper &	operator*= (const MHO_NDArrayWrapper &anArray)

template<typename T >
std::enable_if< std::is_same< XValueType, T >::value or std::is_integral< T >::value or std::is_floating_point< T >::value, MHO_NDArrayWrapper & >::type	operator*= (T aScalar)

MHO_NDArrayWrapper &	operator+= (const MHO_NDArrayWrapper &anArray)

template<typename T >
std::enable_if< std::is_same< XValueType, T >::value or std::is_integral< T >::value or std::is_floating_point< T >::value, MHO_NDArrayWrapper & >::type	operator+= (T aScalar)

MHO_NDArrayWrapper &	operator-= (const MHO_NDArrayWrapper &anArray)

template<typename T >
std::enable_if< std::is_same< XValueType, T >::value or std::is_integral< T >::value or std::is_floating_point< T >::value, MHO_NDArrayWrapper & >::type	operator-= (T aScalar)

MHO_NDArrayWrapper &	operator= (const MHO_NDArrayWrapper &rhs)

XValueType &	operator[] (std::size_t i)

const XValueType &	operator[] (std::size_t i) const

virtual void	Resize (const std::size_t *dim)
	Resize an externally managed array using provided dimensions. More...

void	Resize (std::size_t dim)
	Sets dimensions for externally managed array. More...

void	SetArray (const XValueType &obj)

void	SetExternalData (XValueType ptr, const std::size_t dim)
	Setter for external data. More...

void	SetExternalData (XValueType *ptr, std::size_t dim)
	Setter for external data. More...

MHO_NDArrayView< XValueType, 1 >	SliceView (const char *)

stride_iterator	stride_begin (std::size_t stride)

stride_iterator	stride_end (std::size_t stride)

stride_iterator	stride_iterator_at (std::size_t offset, std::size_t stride)

template<typename... XIndexTypeS>
std::enable_if<(sizeof...(XIndexTypeS)< 1), MHO_NDArrayWrapper< XValueType, 1 -(sizeof...(XIndexTypeS)) > >::type	SubView (XIndexTypeS... idx)

XValueType &	ValueAt (const index_type &idx)

const XValueType &	ValueAt (const index_type &idx) const

void	ZeroArray ()

Public Member Functions inherited from hops::MHO_ExtensibleElement
	MHO_ExtensibleElement ()

virtual	~MHO_ExtensibleElement ()

void	Accept (MHO_Visitor *aVisitor) override
	Visits all extensions of MHO_ExtensibleElement using given visitor. More...

template<class XExtensionType >
MHO_ExtendedElement< XExtensionType > *	AsExtension ()
	Returns an extension of type XExtensionType if found in the list of extensions. More...

template<class XExtensionType >
bool	HasExtension () const
	Checks if an extensible element has a specific extension type. More...

template<class XExtensionType >
MHO_ExtendedElement< XExtensionType > *	MakeExtension ()
	Creates and adds a new extension of type XExtensionType to the list of extensions. More...

Public Member Functions inherited from hops::MHO_Element
	MHO_Element ()

virtual	~MHO_Element ()

Public Member Functions inherited from hops::MHO_Taggable
	MHO_Taggable ()

	MHO_Taggable (const MHO_Taggable &copy)

virtual	~MHO_Taggable ()

void	ClearTags ()
	Clears all tags from the object. More...

void	CopyFrom (const MHO_Taggable &copy_from_obj)
	Copies the contents of another MHO_Taggable object into this object. More...

virtual void	CopyTags (const MHO_Taggable &rhs)
	Copies tags from rhs to this instance if rhs is not empty and has valid object. More...

void	CopyTo (MHO_Taggable &copy_to_obj) const
	Copies the contents of this object to another MHO_Taggable object if they are not the same. More...

mho_json	GetMetaDataAsJSON () const
	Getter for all meta data stored in this object as a json object. More...

MHO_Taggable &	operator= (const MHO_Taggable &rhs)

void	SetMetaDataAsJSON (mho_json obj)
	Setter for meta data as json. More...

Public Member Functions inherited from hops::MHO_JSONWrapper
virtual	~MHO_JSONWrapper ()

void	Clear ()
	Clears the internal object. More...

bool	ContainsKey (const std::string &key) const
	Checks if a map contains a specific key. More...

std::vector< std::string >	DumpKeys () const
	Dumps all keys from the internal object. More...

void	DumpMap () const
	Dumps the contents of the map fObject to standard output. More...

bool	HasKey (const char *char_key) const
	Checks if a key exists in the internal map. More...

bool	HasKey (const std::string &key) const
	Checks if a key exists in the internal map. More...

template<typename XValueType >
void	Insert (const std::string &key, const XValueType &value)
	Inserts or replaces an object in a map using a key and value. More...

MHO_JSONWrapper &	operator= (const MHO_JSONWrapper &rhs)

template<>
bool	Retrieve (const std::string &key, mho_json &value) const
	Retrieves a value from the JSON object by key and stores it in the provided reference. More...

template<typename XValueType >
bool	Retrieve (const std::string &key, XValueType &value) const
	Retrieves a value from an object by key and casts it to the specified type. More...

Public Member Functions inherited from hops::MHO_Serializable
	MHO_Serializable ()

	MHO_Serializable (const MHO_UUID &uuid)

	MHO_Serializable (std::size_t n)

virtual	~MHO_Serializable ()

MHO_UUID	GetObjectUUID () const
	Getter for object uuid. More...

virtual MHO_UUID	GetTypeUUID () const
	Getter for type uuid. More...

void	SetObjectUUID (const MHO_UUID &uuid)
	Setter for object uuid. More...

Friends
template<typename XStream >
XStream &	operator<< (XStream &s, const MHO_VectorContainer &aData)

template<typename XStream >
XStream &	operator>> (XStream &s, MHO_VectorContainer &aData)

Additional Inherited Members
Public Types inherited from hops::MHO_NDArrayWrapper< XValueType, 1 >
using	const_iterator = MHO_BidirectionalConstIterator< XValueType >

using	const_stride_iterator = MHO_BidirectionalConstStrideIterator< XValueType >

using	index_type = std::array< std::size_t, 1 >

using	iterator = MHO_BidirectionalIterator< XValueType >

typedef std::integral_constant< std::size_t, 1 >	rank

using	stride_iterator = MHO_BidirectionalStrideIterator< XValueType >

using	value_type = XValueType

Protected Member Functions inherited from hops::MHO_JSONWrapper
	MHO_JSONWrapper ()

	MHO_JSONWrapper (const MHO_JSONWrapper &copy)

void	SetObject (mho_json obj)
	Setter for object. More...

Protected Attributes inherited from hops::MHO_ExtensibleElement
std::vector< MHO_Element * >	fExtensions

Protected Attributes inherited from hops::MHO_JSONWrapper
mho_json	fObject

Detailed Description

template<typename XValueType>
class hops::MHO_VectorContainer< XValueType >

MHO_VectorContainer - basis for for axis data objects in HOPS4, it is an 1-dimensional array object, key:value data can be attached via the MHO_Taggable interface.

Author: J. Barrett - barre.nosp@m.ttj@.nosp@m.mit.e.nosp@m.du

Date: Fri Oct 16 11:17:19 2020 -0400

Constructor & Destructor Documentation

◆ MHO_VectorContainer() [1/4]

template<typename XValueType >

hops::MHO_VectorContainer< XValueType >::MHO_VectorContainer ( )

inline

◆ MHO_VectorContainer() [2/4]

template<typename XValueType >

hops::MHO_VectorContainer< XValueType >::MHO_VectorContainer ( std::size_t dim )

inline

◆ MHO_VectorContainer() [3/4]

template<typename XValueType >

hops::MHO_VectorContainer< XValueType >::MHO_VectorContainer ( std::size_t * dim )

inline

◆ MHO_VectorContainer() [4/4]

template<typename XValueType >

hops::MHO_VectorContainer< XValueType >::MHO_VectorContainer ( const MHO_VectorContainer< XValueType > & obj )

inline

◆ ~MHO_VectorContainer()

template<typename XValueType >

virtual hops::MHO_VectorContainer< XValueType >::~MHO_VectorContainer ( )

inlinevirtual

Member Function Documentation

◆ Clone()

template<typename XValueType >

MHO_VectorContainer* hops::MHO_VectorContainer< XValueType >::Clone ( )

inline

Clones the current MHO_VectorContainer object.

Returns: A new MHO_VectorContainer object that is a deep copy of the original.

◆ ComputeSerializedSize() [1/2]

template<typename XValueType >

uint64_t hops::MHO_VectorContainer< XValueType >::ComputeSerializedSize ( ) const

inline

Calculates and returns the serialized size as a uint64_t.

Returns: Serialized size in bytes.

◆ ComputeSerializedSize() [2/2]

uint64_t hops::MHO_VectorContainer< std::string >::ComputeSerializedSize ( ) const

inline

Function MHO_VectorContainer<std::string>::ComputeSerializedSize - specialization for string elements.

Note: we need to use 'inline' to satisfy one-definiton rule, otherwise we have to stash this in a .cc file)

Returns: Return value (uint64_t MHO_VectorContainer< std::string)

◆ Copy()

template<typename XValueType >

virtual void hops::MHO_VectorContainer< XValueType >::Copy ( const MHO_VectorContainer< XValueType > & rhs )

inlinevirtual

Expensive copy for MHO_VectorContainer, pointers to exernally managed memory are not transferred, but data is.

Parameters

rhs	Const reference to source container for copying

Note: This is a virtual function.

◆ GetSerializedSize()

template<typename XValueType >

virtual uint64_t hops::MHO_VectorContainer< XValueType >::GetSerializedSize ( ) const

inlineoverridevirtual

Getter for serialized size.

Returns: Serialized size as a uint64_t.

Note: This is a virtual function.

Reimplemented from hops::MHO_Taggable.

Reimplemented in hops::MHO_Axis< XValueType >, and hops::MHO_Axis< double >.

◆ GetVersion()

template<typename XValueType >

virtual MHO_ClassVersion hops::MHO_VectorContainer< XValueType >::GetVersion ( ) const

inlineoverridevirtual

Getter for version.

Returns: MHO_ClassVersion version number.

Note: This is a virtual function.

Reimplemented from hops::MHO_Taggable.

Friends And Related Function Documentation

◆ operator<<

template<typename XValueType >

template<typename XStream >

XStream& operator<<	(	XStream &	s,
		const MHO_VectorContainer< XValueType > &	aData
	)

friend

◆ operator>>

template<typename XValueType >

template<typename XStream >

XStream& operator>>	(	XStream &	s,
		MHO_VectorContainer< XValueType > &	aData
	)

friend

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

MHO_VectorContainer.hh

Public Member Functions

Friends

Additional Inherited Members

Detailed Description

template<typename XValueType> class hops::MHO_VectorContainer< XValueType >

Constructor & Destructor Documentation

◆ MHO_VectorContainer() [1/4]

◆ MHO_VectorContainer() [2/4]

◆ MHO_VectorContainer() [3/4]

◆ MHO_VectorContainer() [4/4]

◆ ~MHO_VectorContainer()

Member Function Documentation

◆ Clone()

◆ ComputeSerializedSize() [1/2]

◆ ComputeSerializedSize() [2/2]

◆ Copy()

◆ GetSerializedSize()

◆ GetVersion()

Friends And Related Function Documentation

◆ operator<<

◆ operator>>

template<typename XValueType>
class hops::MHO_VectorContainer< XValueType >