< Home

< Table of Contents

REFERENCE MANUAL

HPS.UnsignedIntegerMetadata Class Reference

The UnsignedIntegerMetadata class is a smart pointer. More...

Inheritance diagram for HPS.UnsignedIntegerMetadata:
HPS.Metadata HPS.Sprocket HPS.Object

Public Member Functions

override void Dispose ()
 
uint GetValue ()
 Gets the unsigned integer value for this UnsignedIntegerMetadata. More...
 
override HPS.Type ObjectType ()
 This function returns the type the object, as declared. More...
 
void SetValue (uint in_value)
 Sets the unsigned integer value for this UnsignedIntegerMetadata. More...
 
 UnsignedIntegerMetadata ()
 The default constructor creates an uninitialized UnsignedIntegerMetadata object. More...
 
 UnsignedIntegerMetadata (HPS.Metadata in_that)
 This constructor creates an UnsignedIntegerMetadata object that shares the underlying smart-pointer of the source Metadata. More...
 
 UnsignedIntegerMetadata (HPS.UnsignedIntegerMetadata in_that)
 This constructor creates an UnsignedIntegerMetadata object that shares the underlying smart-pointer of the source Metadata. More...
 
 UnsignedIntegerMetadata (string in_name, uint in_value)
 This constructor creates an UnsignedIntegerMetadata with a given name and value. More...
 
- Public Member Functions inherited from HPS.Sprocket
 Sprocket (HPS.Sprocket in_that)
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 Indicates whether this object has any values set on it. More...
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 Returns an identifier that can be used to identify which instance of a class an object is. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
 Object (HPS.Object in_that)
 The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More...
 
virtual void Reset ()
 Resets this object to its initial, uninitialized state. More...
 
HPS.Type Type ()
 This function returns the true type of the underlying object. More...
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Public Types inherited from HPS.Sprocket
enum  UpdateType { Synchronous = 0, Asynchronous = 1 }
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 
- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 
HandleRef scptr
 

Detailed Description

The UnsignedIntegerMetadata class is a smart pointer.

It represents a piece of unsigned integer Metadata.

Constructor & Destructor Documentation

HPS.UnsignedIntegerMetadata.UnsignedIntegerMetadata ( )

The default constructor creates an uninitialized UnsignedIntegerMetadata object.

The Type() function will return Type::None.

HPS.UnsignedIntegerMetadata.UnsignedIntegerMetadata ( HPS.Metadata  in_that)

This constructor creates an UnsignedIntegerMetadata object that shares the underlying smart-pointer of the source Metadata.

The copy will only be successful if the source component is really an upcast of an UnsignedIntegerMetadata object. Otherwise the copy will fail and the resulting UnsignedIntegerMetadata will be invalid.

Parameters
in_thatThe source <ref refid="class_h_p_s_1_1_metadata" kindref="compound">Metadata</ref> to copy.
HPS.UnsignedIntegerMetadata.UnsignedIntegerMetadata ( HPS.UnsignedIntegerMetadata  in_that)

This constructor creates an UnsignedIntegerMetadata object that shares the underlying smart-pointer of the source Metadata.

The copy will only be successful if the source component is really an upcast of an UnsignedIntegerMetadata object. Otherwise the copy will fail and the resulting UnsignedIntegerMetadata will be invalid.

Parameters
in_thatThe source <ref refid="class_h_p_s_1_1_metadata" kindref="compound">Metadata</ref> to copy.
HPS.UnsignedIntegerMetadata.UnsignedIntegerMetadata ( string  in_name,
uint  in_value 
)

This constructor creates an UnsignedIntegerMetadata with a given name and value.

Parameters
in_nameThe UTF8-encoded name for this <ref refid="class_h_p_s_1_1_unsigned_integer_metadata" kindref="compound">UnsignedIntegerMetadata</ref>.
in_valueThe unsigned integer value for this <ref refid="class_h_p_s_1_1_unsigned_integer_metadata" kindref="compound">UnsignedIntegerMetadata</ref>.

Member Function Documentation

uint HPS.UnsignedIntegerMetadata.GetValue ( )

Gets the unsigned integer value for this UnsignedIntegerMetadata.

Returns
The unsigned integer value for this UnsignedIntegerMetadata.
override HPS.Type HPS.UnsignedIntegerMetadata.ObjectType ( )
virtual

This function returns the type the object, as declared.

This does not necessarily give the true type of the underlying object.

Returns
The declared type of the object in question, which may differ from the true, underlying type.

Reimplemented from HPS.Metadata.

void HPS.UnsignedIntegerMetadata.SetValue ( uint  in_value)

Sets the unsigned integer value for this UnsignedIntegerMetadata.

Parameters
in_valueThe unsigned integer value for this <ref refid="class_h_p_s_1_1_unsigned_integer_metadata" kindref="compound">UnsignedIntegerMetadata</ref>.

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