ECS_AnnoData

- The user data which is sent/received as a part of an annotation request/response

SYNOPSIS

#include <ECS/AnnoData.hh>

class ECS_AnnoData : public ECS_AttrValueList
{
  public:
	_ECSAIO_PRIVAPI ECS_AnnoData();
	_ECSAIO_PRIVAPI ECS_AnnoData(const EV_AttrValue& data);
	_ECSAIO_PRIVAPI ECS_AnnoData(ECS_AnnoData const& other);
	ECS_AnnoData const& operator=(ECS_AnnoData const& other);
	ECS_AnnoData const& operator=(ECS_AttrValueList const& other); 	_ECSAIO_PRIVAPI virtual ~ECS_AnnoData();
	virtual ostream& print(ostream& os) const;
	_ECSAIO_PRIVAPI char* getValueAsCharString() const;
	_ECSAIO_PRIVAPI int32 setData(const char* newValue);
	_ECSAIO_PRIVAPI void setData(const ECS_AttrValueList& newValue);
};

CLASS TYPE

Concrete

AUDIENCE

ECS Application Developers

DESCRIPTION

This is essentially an attribute value list with the added ability to convert to and from an ECDL-like ECS formatted value string.

Constructors and Destructors

_ECSAIO_PRIVAPI ECS_AnnoData();

The default constructor.

_ECSAIO_PRIVAPI ECS_AnnoData(const EV_AttrValue& data);

The other constructor.

_ECSAIO_PRIVAPI ECS_AnnoData(ECS_AnnoData const& other);

The copy constructor.

ECS_AnnoData const& operator=(ECS_AnnoData const& other);

The assignment operator.

ECS_AnnoData const& operator=(ECS_AttrValueList const& other);

The assignment operator sets value from an instance of ECS_AttrValueList.

_ECSAIO_PRIVAPI virtual ~ECS_AnnoData();

The destructor.

Utility

virtual ostream& print(ostream& os) const;

Prints a textual representation of the class to the output stream specified via os.

Access

_ECSAIO_PRIVAPI char* getValueAsCharString() const;

Gets the value of the annotation data as an ECDL-like string

The storage for the string is allocated by the call, and must be deleted by the caller using the operator delete.

Modification

_ECSAIO_PRIVAPI int32 setData(const char* newValue);

Sets the value of the annotation data as specified by the ECDL-like string passed in the parameter newValue.

Returns true if newValue could be successfully parsed and false otherwise

_ECSAIO_PRIVAPI void setData(const ECS_AttrValueList& newValue);

Sets the value of the annotation data as specified by the to that specified by the ECS_AttrValueList

NOTES

None.

SEE ALSO

ECS_AttrValueList

LIBRARY

ECS

VERSION

1.4

DATE RELEASED

1998/02/25

AUTHOR(S)

Hewlett-Packard Company

COPYRIGHT

Copyright (c) 1997 Hewlett-Packard Company. All Rights Reserved.