trek::NamedItem Class Reference

This class is the provied the common set of names and descriptions allowed for different items in the Data API. More...

#include <named_item.h>

Inherited by trek::Calibrator, trek::ExpectedStateAlarm, trek::LimitAlarm, trek::PacketItem, trek::Parameter, and trek::SwitchSet.

Public Member Functions
void	SetName (const char *input_ptr)
	Sets the name of the item. More...
void	SetAlias (const char *input)
	Sets the alias of the item. More...
void	SetShortDescription (const char *input_ptr)
	Sets the short description of the item. More...
void	SetLongDescription (const char *input_ptr)
	Sets the long description of the item. More...
void	SetUserDescription (const char *input_ptr)
	Sets the user description of the item. More...
void	SetOwner (const char *input_ptr)
	Sets the owner of the item. More...
const char *	GetName ()
	Returns the name of the item.
const char *	GetAlias ()
	Returns the alias of the item.
const char *	GetShortDescription ()
	Returns the short description of the item.
const char *	GetLongDescription ()
	Returns the long description of the item.
const char *	GetUserDescription ()
	Returns the user description of the item.
const char *	GetOwner ()
	Returns the owner of the item.
Constructors, Destructor, and Other Basic Methods
	NamedItem ()
	Default constructor of the class.
	NamedItem (NamedItem &input)
	Copy constructor of the class.
virtual	~NamedItem ()
	Class destructor. More...
virtual void	Init ()
	Initializes the object.
void	operator= (NamedItem &right_side)
	Provides the equal operator.
bool	operator== (NamedItem &right_side)
	Provides the == operator.

Detailed Description

This class is the provied the common set of names and descriptions allowed for different items in the Data API.

Constructor & Destructor Documentation

~NamedItem()

trek::NamedItem::~NamedItem ( )

virtual

Class destructor.

Removes all resources created with this instance of the class.

Member Function Documentation

SetAlias()

void trek::NamedItem::SetAlias

(

const char *

input_ptr

)

Sets the alias of the item.

There is no restriction on the length of the alias. However, individual projects may impose length restrictions.

Parameters

[in]

input_ptr

The new alias for the item.

SetLongDescription()

void trek::NamedItem::SetLongDescription

(

const char *

input_ptr

)

Sets the long description of the item.

There is no restriction on the length of the long description. However, individual projects may impose length restrictions.

Parameters

[in]

input_ptr

The new long description for the item.

SetName()

void trek::NamedItem::SetName

(

const char *

input_ptr

)

Sets the name of the item.

There is no restriction on the length of the name. However, individual projects may impose length restrictions.

Parameters

[in]

input_ptr

The new name for the item.

Examples:

define_packet/define_packet.cpp, and integrate_user_calibrator/integrate_user_calibrator.cpp.

SetOwner()

void trek::NamedItem::SetOwner

(

const char *

input_ptr

)

Sets the owner of the item.

There is no restriction on the length of the owner. However, individual projects may impose length restrictions.

Parameters

[in]

input_ptr

The new owner for the item.

SetShortDescription()

void trek::NamedItem::SetShortDescription

(

const char *

input_ptr

)

Sets the short description of the item.

There is no restriction on the length of the short description. However, individual projects may impose length restrictions.

Parameters

[in]

input_ptr

The new short description for the item.

SetUserDescription()

void trek::NamedItem::SetUserDescription

(

const char *

input_ptr

)

Sets the user description of the item.

There is no restriction on the length of the user description. However, individual projects may impose length restrictions.

Parameters

[in]

input_ptr

The new user description for the item.