CpgNetworkSerializer

CpgNetworkSerializer — Network to XML serializer

Synopsis

#define             CPG_NETWORK_SERIALIZER_CONST        (obj)
struct              CpgNetworkSerializer;
struct              CpgNetworkSerializerClass;
CpgNetworkSerializer * cpg_network_serializer_new       (CpgNetwork *network,
                                                         CpgGroup *root);
gboolean            cpg_network_serializer_serialize    (CpgNetworkSerializer *serializer,
                                                         GOutputStream *stream,
                                                         GError **error);
gboolean            cpg_network_serializer_serialize_file
                                                        (CpgNetworkSerializer *serializer,
                                                         GFile *file,
                                                         GError **error);
gboolean            cpg_network_serializer_serialize_path
                                                        (CpgNetworkSerializer *serializer,
                                                         const gchar *path,
                                                         GError **error);
gchar *             cpg_network_serializer_serialize_memory
                                                        (CpgNetworkSerializer *serializer,
                                                         GError **error);
                    CpgNetworkSerializerPrivate;

Object Hierarchy

  GObject
   +----CpgNetworkSerializer

Properties

  "network"                  CpgNetwork*           : Read / Write / Construct Only
  "root"                     CpgGroup*             : Read / Write / Construct Only

Description

This can be used to serialize a CpgNetwork to XML.

Details

CPG_NETWORK_SERIALIZER_CONST()

#define CPG_NETWORK_SERIALIZER_CONST(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), CPG_TYPE_NETWORK_SERIALIZER, CpgNetworkSerializer const))


struct CpgNetworkSerializer

struct CpgNetworkSerializer;


struct CpgNetworkSerializerClass

struct CpgNetworkSerializerClass {
};


cpg_network_serializer_new ()

CpgNetworkSerializer * cpg_network_serializer_new       (CpgNetwork *network,
                                                         CpgGroup *root);

Create a new serializer for network. When serialized, only objects contained in root will be serialized. This can be useful to serialize only parts of the network. If root is NULL, all objects will be serialized.

network :

A CpgNetwork

root :

A CpgGroup

Returns :

A CpgNetworkSerializer

cpg_network_serializer_serialize ()

gboolean            cpg_network_serializer_serialize    (CpgNetworkSerializer *serializer,
                                                         GOutputStream *stream,
                                                         GError **error);

Serialize a network to an output stream.

serializer :

A CpgNetworkSerializer

stream :

A GOutputStream

error :

A GError

Returns :

TRUE if the serialization was successful, FALSE otherwise

cpg_network_serializer_serialize_file ()

gboolean            cpg_network_serializer_serialize_file
                                                        (CpgNetworkSerializer *serializer,
                                                         GFile *file,
                                                         GError **error);

Convenience function to serialize to a file.

serializer :

A CpgNetworkSerializer

file :

A GFile

error :

A GError

Returns :

TRUE if the serialization was successful, FALSE otherwise

cpg_network_serializer_serialize_path ()

gboolean            cpg_network_serializer_serialize_path
                                                        (CpgNetworkSerializer *serializer,
                                                         const gchar *path,
                                                         GError **error);

Convenience function to serialize to a file path.

serializer :

A CpgNetworkSerializer

path :

The file path

error :

A GError

Returns :

TRUE if the serialization was successful, FALSE otherwise

cpg_network_serializer_serialize_memory ()

gchar *             cpg_network_serializer_serialize_memory
                                                        (CpgNetworkSerializer *serializer,
                                                         GError **error);

Convenience function to serialize a network to a string.

serializer :

A CpgNetworkSerializer

error :

A GError

Returns :

The serialized network or NULL if an error occurred.

CpgNetworkSerializerPrivate

typedef struct _CpgNetworkSerializerPrivate CpgNetworkSerializerPrivate;

Property Details

The "network" property

  "network"                  CpgNetwork*           : Read / Write / Construct Only

Network.


The "root" property

  "root"                     CpgGroup*             : Read / Write / Construct Only

Root.